llmdoc / docs / getting-started

开始使用

llmdoc 需要 Node.js 18 或更高版本，以及 Git。CLI 是外部工具，不要把它加入正在工作的消费仓库。

先读取知识地图

npx -y @tokenroll/llmdoc tree

-y 允许 npx 把缺失的包解析到机器缓存，不会修改消费仓库的 package.json 或 lockfile。

始终使用完整的 scoped 包名。裸的 npx llmdoc 会解析到另一个无关包。

Claude Code

添加经仓库验证的 marketplace，然后安装插件：

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

Codex

把 llmdoc 添加为插件 marketplace 来源，再从 Plugins Directory 安装。信任插件前请先审查 hooks。

codex plugin marketplace add TokenRollAI/llmdoc

其他 Coding Agent

在 AGENTS.md 中加入一条简洁规则，把发现过程路由到外部 CLI。持久知识留在 llmdoc/；不要手工编辑 llmdoc/meta.json。

第一次检索

# 范围不明确
npx -y @tokenroll/llmdoc tree

# 概念或契约
npx -y @tokenroll/llmdoc search "重试策略"

# 具体文件所需的上下文
npx -y @tokenroll/llmdoc context --files src/api/client.ts

这些命令是不同入口，不是固定流水线。确认目标文档后，再用 show 读取正文。

在本地浏览

启动内置本地 Viewer，查看当前仓库的文档结构、关系与状态。服务器只绑定 127.0.0.1。

npx -y @tokenroll/llmdoc serve