CLI 安装与使用

Loci CLI 适合终端、自动化脚本和服务器环境。CLI 与桌面应用使用同一份本地数据。

安装 CLI

CLI 需要 Node.js 22.13 或更高版本。

示例:

npm install --global @boses/cli
loci --help

如果要抓取依赖浏览器渲染的文档站,再安装 Chromium headless shell。普通 HTTP 文档站不需要这一步。

示例:

loci browser install

收录第一份文档

以下示例使用最短命令收录 Rspress 文档。只提供 URL 时,名称从域名生成,抓取方式为 auto,页面上限为 1,000,收录范围为整个站点。

示例:

loci source add https://rspress.rs/guide/introduction.html
loci source sync rspress

接口文档同样只需提供正在阅读的地址。输入 Swagger UI、Knife4j、ReDoc、FastAPI /docs 或常见 OpenAPI JSON 地址时,Loci 会自动发现同站的 OpenAPI/Swagger JSON,并直接整理接口、参数、响应、认证和数据模型;没有发现规范时继续按普通网页收录。

示例:

loci source add http://localhost:8000/docs

公开 GitHub 仓库也可以直接作为文档源。Loci 会读取默认分支当前提交的 ZIP,保留 Markdown 的仓库相对目录;不需要安装 Git 或浏览器。

示例:

loci source add https://github.com/vuejs/docs

同步完成后,使用关键词查找文档。命令会显示每篇文档的短 ID;可用短 ID 读取全文。

示例:

loci document search "Quick start"
loci document read < ID>

可以随时查看本地数据和文档源:

示例:

loci status
loci source list

需要在没有桌面端的服务器上执行定时更新时,先设置计划,再显式运行前台计划宿主:

loci schedule set rspress '0 2 * * *'
loci schedule run

下一步