命令一览

全局选项

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]

npx @docmd/core build

在 site/ 目录下生成可用于生产的静态站点。

npx @docmd/core build [options]

npx @docmd/core live

启动浏览器版 Live Editor。

npx @docmd/core live [options]

npx @docmd/core stop

停止运行中的 dev 服务器。

npx @docmd/core stop [options]

npx @docmd/core deploy

生成部署配置文件。

npx @docmd/core deploy [options]

npx @docmd/core migrate

从其他工具迁移，或升级配置。

npx @docmd/core migrate

自动重新映射已废弃的键（例如 siteTitle → title），并重组配置对象。

npx @docmd/core validate

校验文档文件，并检查内部链接是否失效。

npx @docmd/core validate [options]

扫描每个 Markdown 文件，追踪相对链接与图片引用，并报告失效目标。若存在失效链接，进程会以非零状态退出，因此可以挂到 pre-merge hook 中。

npx @docmd/core doctor

预检命令，报告缺失的插件、损坏的配置以及不匹配的引擎。不写文件、没有构建副作用 —— 纯粹用于诊断。

npx @docmd/core doctor [选项]

默认情况下，doctor 会打印一份人类可读的摘要，涵盖：已安装的 @docmd/core 版本、每个已配置的插件（附带版本和 ✓ installed / ⚠ missing 状态）、当前激活的模板、请求的引擎（js 始终启用，rust 可选），以及一份自动安装候选清单。带上 --fix，它会调用项目所用的包管理器（pnpm add、npm install --save、yarn add 或 bun add）来安装这些候选，并在全部解决后以退出码 0 结束。带上 --json，同样的数据会作为一个 JSON 对象输出 —— 适合接入 pre-commit 钩子和 CI 闸门。退出码 0 表示项目处于健康状态；非 0 表示即使经过 --fix 仍有未解决的问题。

npx @docmd/core mcp

将 docmd 作为 Model Context Protocol（MCP）服务器通过 stdio 运行。使用它，可以让 AI Agent（Claude Desktop、Cursor 等）直接读取并校验您的文档。

npx @docmd/core mcp

服务器通过 JSON-RPC 在标准输入/输出上通信。请按如下方式配置 MCP 客户端：

{
  "mcpServers": {
    "docmd": {
      "command": "npx",
      "args": ["-y", "@docmd/core", "mcp"]
    }
  }
}

npx @docmd/core add <plugin>

安装并配置官方或社区插件。

npx @docmd/core add <plugin-name>

CLI 会自动识别您的包管理器（npm、pnpm、yarn 或 bun），并将推荐默认值注入 docmd.config.json。

npx @docmd/core remove <plugin>

安全地卸载一个插件并清理其配置。

npx @docmd/core remove <plugin-name>

将移除：

• 对应的 npm 包
• docmd.config.json 中的插件配置