Anydocs Documents
快速开始

安装

用最短路径完成环境检查、CLI 验证、项目初始化与预览。

Anydocs 的 CLI 和 MCP 已发布到 npm。对大多数用户来说,安装阶段的目标不是搭好完整开发环境,而是尽快确认 CLI 可用、创建项目并看到第一个 preview。

安装 CLI

  1. 确认环境
  2. 验证 CLI 可用
  3. 创建一个文档项目
  4. 启动本地预览

确认环境

准备 Node.js 18 或更高版本即可。pnpm 只在你要参与 Anydocs 本身的源码开发时才是高频需求,日常使用 CLI 不依赖它。

node --version

验证 CLI 可用

直接通过 `npx` 运行已发布 CLI,确认命令可以正常执行。

npx @anydocs/cli version

安装 MCP(AI 助手)

如果你要让 AI 助手参与文档写作,需要先安装 Anydocs MCP 服务。安装为全局配置后,在任何项目目录中都可以直接使用。想进一步了解 AI 集成细节或验证方法,可以查看 [与 Claude Code 配合使用](/claude-code-integration) 和 [与 Codex 配合使用](/codex-integration)。

codex mcp add anydocs -- npx -y @anydocs/mcp
claude mcp add -s user anydocs -- npx -y @anydocs/mcp

如果只想当前项目生效,把 Claude Code 命令中的 `-s user` 改为 `-s local`。

验证安装

安装完成后可以列出已注册的 MCP 服务确认状态。

codex mcp list
claude mcp list

创建一个文档项目

先生成一个本地文档项目。若你已安装 MCP,可以直接用 Claude Code 或 Codex 打开项目目录让助手初始化;也可以先用 CLI 初始化项目。

npx @anydocs/cli init ./my-docs-project
npx @anydocs/cli init ./my-docs-project --agent claude-code

启动本地预览

运行 preview 查看默认语言下的已发布页面。如果你还没有把页面设为 `published`,reader 中不会显示草稿内容。

npx @anydocs/cli preview ./my-docs-project
下一步怎么走: 如果你打算手动写作,继续看"第一个文档项目";如果你打算让助手参与写作,继续看 Claude Code 或 Codex 集成页。