命令行参考
Cdocs 采用 纯子命令 CLI（对标 Hugo / MkDocs），语法：
Cdocs [全局旗标] <子命令> [参数]
#全局旗标（放在子命令之前）
| 旗标 | 说明 |
-c, --config <目录> | 引擎目录（默认 .Cdocs） |
-s, --source <目录> | 内容目录（默认 docs） |
-d, --dest <目录> | 输出目录（默认 dist） |
-q, --quiet | 静默模式（只输出错误） |
-V, --verbose | 详细输出 |
-h, --help | 帮助 |
-v, --version | 版本号 |
#子命令
| 子命令 | 作用 | 常用旗标 |
init <目录> | 建站：生成完整骨架（配置/i18n/示例文档/引擎+exe），自动构建 | --no-engine 只出内容骨架 |
new <名>（别名 add/page） | 建页：用 archetype 生成文档并登记导航 | — |
build | 构建站点（位置参数可覆盖输入/输出目录） | -D/--drafts、--clean、-q/-V |
serve | 构建并启动内置 HTTP 预览（默认 8088，端口被占自动顺延） | -p/--port、-o/--open、-w/--watch、--no-build |
clean | 清空 dist | — |
version / help | 版本 / 帮助 | — |
#退出码
| 码 | 含义 |
0 | 成功 |
1 | 运行错误（输入目录不存在、无文档等） |
2 | 用法错误（未知命令 / 未知旗标） |
#行为约定
- 无参数运行打印帮助并退出（exit 0）；双击 exe 无参数打印帮助并等待 Ctrl+C（防窗口一闪而过）。
serve 是常驻进程：按 Ctrl+C 干净退出；-w/--watch 监听 docs/ 与 .Cdocs/config 变化自动重建。- 路径相对当前终端目录（CWD）解析：挂到 PATH 后，进到哪个项目目录跑
Cdocs，处理的就是哪个项目的 docs/ 与 .Cdocs/。 - 在非 Cdocs 项目目录跑
build 会报「找不到 .Cdocs/config」——与在非 Hugo 站点里跑 hugo 行为一致。
Cdocs -h # 帮助
Cdocs init mysite # 建站
Cdocs new faq # 建页
Cdocs build # 构建
Cdocs build -D --clean # 含草稿 + 先清空
Cdocs -d /tmp/out build # 输出到指定目录
Cdocs serve -o -w -p 3000 # 预览 + 开浏览器 + 热重载 + 3000 端口
Cdocs clean # 清空 dist
最后更新于 2026-08-02 18:29 · 约 2 分钟阅读（540 字）