Authoring Documentation

All project documentation lives in the docs/ directory. The docmap CLI lets both humans and AI agents discover and read documents without leaving the terminal.

Browsing with CLI

Run commands via the project's package manager (e.g. npm run docmap --, pnpm docmap, yarn docmap).

Targets are positional paths; the CLI classifies each by inspecting the filesystem (directory → list, file → read). Pass several at once. The root prefix shown in listings (docs/ by default) is optional on input.

docmap                                       # list root docs
docmap topic-a topic-b/sub-topic-c           # list subdirectories
docmap --recursive                           # list everything
docmap doc-1.md docs/topic-a/doc-2.md        # read documents (frontmatter stripped)
docmap topic-a docs/topic-a/doc-1.md         # mix listing and reading
docmap --check                               # validate all files