CLI 参考

doctrine binary 提供两个命令。它把当前工作目录当作项目 root，从这里加载 doctrine.config.*，并解析相对内容目录。

Shell

doctrine dev [directory] [--host localhost] [--port 5173]
doctrine build [directory] [--site-url https://example.com/docs/] [--out-dir dist]

[directory] 默认是 docs，并且必须存在。

`doctrine dev`

启动包含 SSR、客户端 hydration、文件监听和内存开发搜索索引的自定义 Vite 服务器。

Shell

doctrine dev
doctrine dev website --host 0.0.0.0 --port 4173

命令会持续运行，直到服务器停止。MDX 和导航变化会更新网站；启用页面操作时，对应的 .md 源码路由也会随原始文件更新。下一次搜索请求才会惰性重建 Pagefind 开发数据。

构建客户端与 SSR bundle、预渲染全部导航路由、写入 404.html 和启用的 .md 源码路由，再生成 Pagefind 索引。

参数或选项	默认值	含义
`[directory]`	`docs`	相对项目 root 的 MDX 内容目录。
`--site-url`	配置或 `http://localhost/`	最终 HTTP(S) URL，包括可能存在的部署 pathname。
`--out-dir`	配置或 `dist`	从 root 解析的输出路径；已是绝对路径时保持不变。

Shell

doctrine build
doctrine build website \
  --site-url https://user.github.io/project/ \
  --out-dir build

CLI 值会为本次调用覆盖根配置中的 siteUrl 和 outDir。输出目录必须位于项目 root 内，不能等于 root，也不能位于 MDX 目录内。客户端构建会先清空该目录。

成功后，Doctrine 会打印文档路由数量与解析后的输出路径。路由数量不包含共享 404 页面。

Shell

doctrine --help

未知命令或选项、重复位置目录、缺少选项值、非法端口、内容目录不存在、配置或导航非法、输出不安全、编译失败或搜索索引失败都会让 CLI 以非零状态退出。错误只保证打印消息，不提供自定义错误码契约。