CLI 安装与使用
Loci CLI 适合终端、自动化脚本和服务器环境。它将公开技术文档保存为本地 Markdown,供后续搜索、阅读和 Agent 查询。
安装 CLI
CLI 需要 Node.js 22.16 或更高版本。
示例:
如果要抓取依赖浏览器渲染的文档站,再安装 Chromium headless shell。普通 HTTP 文档站不需要这一步。
示例:
收录第一份文档
以下示例使用最短命令收录 Rspress 文档。首次使用或当前数据目录没有已保存的创建偏好时,只提供 URL 会从域名生成名称,以 auto 方式、1,000 页上限和整站范围开始。交互终端之后会复用最近的抓取方式、页面上限和收录路径层级;显式选项始终优先,非交互调用不读取这些人类交互偏好。
loci source add 默认会立即开始首次同步。只有需要先检查或调整配置时,才添加 --no-sync,再手动执行同步。
示例:
接口文档同样只需提供正在阅读的地址。输入 Swagger UI、Knife4j、ReDoc、FastAPI /docs 或常见 OpenAPI JSON 地址时,Loci 会自动发现同站的 OpenAPI/Swagger JSON,并按分组、接口标签和数据模型生成目录化 Markdown;没有发现规范时继续按普通网页收录。
示例:
公开 GitHub 仓库也可以直接作为文档源。Loci 会收录默认分支中的 Markdown 与 MDX;不需要安装 Git 或浏览器。
示例:
同步完成后,使用关键词查找文档。命令会显示每篇文档的短 ID;可用短 ID 读取全文。
示例:
可以随时查看本地数据和文档源:
示例:
打开浏览器控制台时,Loci 会先打印访问地址、尝试打开浏览器,并在当前终端保持仅用于 Web 会话的本机 HTTP;按 Ctrl+C 会结束本次会话:
需要让定时更新脱离 UI 终端持续运行时设置计划即可,保存时会确保用户级后台服务可用:
云端每日同步同样会自动准备无 HTTP 的常驻 worker。在 Web UI 中开启定时抓取或每日同步时会立即确保 worker 可用,无需等待或保持 Web 会话;普通后台同步则使用队列空闲后自动退出的按需 worker。该登录自启动保证适用于默认数据目录;设置 LOCI_DATA_DIR 的自定义目录需要由外部进程管理器长期托管,具体边界见后台服务与 Web UI。
下一步
- 查看基础命令与运行设置,了解浏览器、共享设置和脚本退出码。
- 查看后台服务与 Web UI,了解任务恢复、服务生命周期和本机安全边界。
- 查看本地文档库和云端文档库。
- 查看页面发现与抓取,了解 GitHub、
llms.txt、OpenAPI 和普通网页的识别顺序。 - 查看数据备份与清理。
- 需要让 Agent 使用本地文档时,查看 接入 Agent。
- 如果需要为其他人提供云端文档库,可选阅读 Admin:部署与管理 Server。
- 遇到环境或浏览器问题,运行
loci doctor;浏览器不可用时运行loci browser install。