CLI 命令
命令概览
| 命令 | 描述 |
|---|---|
npx @docmd/core init |
初始化一个新的文档项目 |
npx @docmd/core dev |
启动带有热重载的开发服务器 |
npx @docmd/core build |
生成生产环境静态网站 |
npx @docmd/core live |
启动基于浏览器的实时编辑器 |
npx @docmd/core stop |
停止正在运行的开发服务器 |
npx @docmd/core deploy |
生成部署配置 |
npx @docmd/core migrate |
升级旧版配置或从其他工具迁移 |
npx @docmd/core add <plugin> |
安装并配置插件 |
npx @docmd/core remove <plugin> |
移除插件及其配置 |
全局选项
| 选项 | 别名 | 描述 |
|---|---|---|
--config <path> |
-c |
配置文件路径（默认：docmd.config.json） |
--verbose |
-V |
显示详细的构建日志 |
--version |
-v |
输出安装的版本号 |
--help |
-h |
显示帮助菜单 |
--cwd <path> |
- | 覆盖当前工作目录（适用于 monorepos） |
npx @docmd/core init
在当前目录中初始化一个新的文档项目。
npx @docmd/core init
创建内容：
docs/index.md- 示例主页docmd.config.json- 推荐的默认配置- 更新
package.json并添加构建脚本
npx @docmd/core dev
启动一个带有即时热重载的开发服务器。
npx @docmd/core dev [options]
| 选项 | 别名 | 描述 |
|---|---|---|
--port <number> |
-p |
服务器端口（默认：3000） |
--config <path> |
-c |
配置文件路径 |
npx @docmd/core build
在 site/ 目录中生成生产就绪的静态网站。
npx @docmd/core build [options]
| 选项 | 别名 | 描述 |
|---|---|---|
--offline |
- | 将链接重写为 .html 以进行 file:// 浏览 |
--config <path> |
-c |
配置文件路径 |
npx @docmd/core live
启动基于浏览器的实时编辑器。
npx @docmd/core live [options]
| 选项 | 描述 |
|---|---|
--build-only |
仅生成编辑器捆绑包而不启动服务器 |
npx @docmd/core stop
停止正在运行的 docmd 开发服务器。
npx @docmd/core stop [options]
| 选项 | 别名 | 描述 |
|---|---|---|
--port <number> |
-p |
仅停止该端口上的服务器 |
--force |
-f |
同时强制停止端口 3000、3001、8080、8081 上的服务进程 |
npx @docmd/core deploy
生成部署配置文件。
npx @docmd/core deploy [options]
| 选项 | 描述 |
|---|---|
--docker |
生成 Dockerfile |
--nginx |
生成 nginx.conf |
--caddy |
生成 Caddyfile |
--force |
覆盖现有的部署文件 |
npx @docmd/core migrate
将旧版 docmd V1 配置升级到 V2 架构。
npx @docmd/core migrate
自动重新映射已弃用的键（例如，siteTitle → title）并重构配置对象。
npx @docmd/core add <plugin>
安装并配置官方或社区插件。
npx @docmd/core add <plugin-name>
| 示例 | 描述 |
|---|---|
npx @docmd/core add analytics |
安装 @docmd/plugin-analytics |
npx @docmd/core add search |
安装 @docmd/plugin-search |
CLI 会自动检测你的包管理器（npm、pnpm、yarn 或 bun），并将推荐的默认设置注入到 docmd.config.json 中。
npx @docmd/core remove <plugin>
安全地卸载插件并清理其配置。
npx @docmd/core remove <plugin-name>
移除：
- npm 软件包
docmd.config.json中的插件配置
代理兼容的日志记录 🤖
docmd 使用结构化的终端日志记录。AI 代理可以精确解析输出，以便进行错误检测和自动化维护。