CLI 安装与使用
Loci CLI 适合终端、自动化脚本和服务器环境。CLI 与桌面应用使用同一份本地数据。
安装 CLI
CLI 需要 Node.js 22.13 或更高版本。
示例:
如果要抓取依赖浏览器渲染的文档站,再安装 Chromium headless shell。普通 HTTP 文档站不需要这一步。
示例:
收录第一份文档
以下示例使用最短命令收录 Rspress 文档。只提供 URL 时,名称从域名生成,抓取方式为 auto,页面上限为 1,000,收录范围为整个站点。
示例:
接口文档同样只需提供正在阅读的地址。输入 Swagger UI、Knife4j、ReDoc、FastAPI /docs 或常见 OpenAPI JSON 地址时,Loci 会自动发现同站的 OpenAPI/Swagger JSON,并直接整理接口、参数、响应、认证和数据模型;没有发现规范时继续按普通网页收录。
示例:
公开 GitHub 仓库也可以直接作为文档源。Loci 会读取默认分支当前提交的 ZIP,保留 Markdown 的仓库相对目录;不需要安装 Git 或浏览器。
示例:
同步完成后,使用关键词查找文档。命令会显示每篇文档的短 ID;可用短 ID 读取全文。
示例:
可以随时查看本地数据和文档源:
示例:
需要在没有桌面端的服务器上执行定时更新时,先设置计划,再显式运行前台计划宿主:
下一步
- 查看基础、浏览器与设置。
- 查看本地文档库和云端文档库。
- 查看页面发现与抓取优先级。
- 查看数据备份与运行环境。
- 需要让 AI 使用本地文档时,查看 AI 接入概览。
- 如果需要为其他人提供云端文档库,可选阅读 Admin:部署与管理 Server。
- 遇到环境或浏览器问题,运行
loci doctor;浏览器不可用时运行loci browser install。