my-docs-cli

Browse your documents and images right from the terminal — no browser needed.

Install

npm install -g my-docs-cli

Usage

my-docs

Use arrow keys to navigate, Enter to open a doc, and follow on-screen prompts to go back or exit.

Adding Your Own Documents

Add a .json file inside the docs/ folder using this structure:

{
  "title": "My Document",
  "category": "Guide",
  "content": [
    { "type": "heading", "text": "My Heading" },
    { "type": "text", "text": "Paragraph text goes here." },
    {
      "type": "image",
      "alt": "My Diagram",
      "ascii": [
        "  ┌───────────┐",
        "  │  Diagram  │",
        "  └───────────┘"
      ]
    }
  ]
}

Content block types: | Type | Fields | |-----------|---------------------------------| | heading | text | | text | text | | image | alt, ascii (array of lines) |

Programmatic API

const myDocs = require('my-docs-cli');

// List all docs
const docs = myDocs.listDocs();
console.log(docs);

// Get a specific doc by title
const doc = myDocs.getDoc('Getting Started Guide');
console.log(doc);

Publishing Your Own Package

1. Edit package.json — set name, version, author
2. Run npm login
3. Run npm publish
4. Users install it: npm i -g your-package-name