llmdoc / docs / getting-started

Getting started

llmdoc requires Node.js 18 or newer and Git. The CLI is external tooling: do not add it to the repository you are working on.

Try the knowledge map

npx -y @tokenroll/llmdoc tree

-y lets npx resolve a missing package into the machine cache without editing the consumer repository's package.json or lockfile.

Always use the full scoped package name. A bare npx llmdoc resolves to an unrelated package.

Claude Code

Add the repository-verified marketplace, then install the plugin:

/plugin marketplace add https://github.com/TokenRollAI/llmdoc
/plugin install llmdoc@llmdoc-plugin

Codex

Add llmdoc as a plugin marketplace source, then install it from the Plugins Directory. Review the plugin hooks before trusting them.

codex plugin marketplace add TokenRollAI/llmdoc

Other coding agents

Use a thin AGENTS.md rule that routes discovery through the external CLI. Keep the durable knowledge in llmdoc/; never hand-edit llmdoc/meta.json.

Your first retrieval

# Unclear scope
npx -y @tokenroll/llmdoc tree

# A concept or contract
npx -y @tokenroll/llmdoc search "retry policy"

# Context for concrete files
npx -y @tokenroll/llmdoc context --files src/api/client.ts

These are alternatives, not a mandatory sequence. Read document bodies with show only after identifying what matters.

Browse locally

Launch the built-in local Viewer to inspect the current repository's document structure, relations, and status. The server binds only to 127.0.0.1.

npx -y @tokenroll/llmdoc serve