快速开始

Planu 是为你的 AI 工具设计的插件，帮助你规划、追踪和验证软件功能。你不需要在每次对话中重复自己——只需创建一个规格（spec，一个简短的计划加上"完成"清单），你的 AI 会自动遵循它。

支持任何编程语言、任何框架，以及大多数 AI 工具——包括不支持 MCP 的工具。

安装

npm install -g @planu/cli

然后用一条命令配置所有 AI 工具：

planu install --global

就这样。Planu 扫描你的机器，检测每个已安装的 AI 工具，并自动配置每个工具。

$ planu install --global

正在搜索 AI 工具...
  Claude Code   找到  → ~/.claude/claude.json 已更新
  Cursor        找到  → ~/.cursor/mcp.json 已更新
  Windsurf      找到  → ~/.windsurf/mcp.json 已更新
  OpenCode      找到  → ~/.config/opencode/config.json 已更新
  Codex         找到  → AGENTS.md 已更新

重启你的 AI 工具。Planu 已就绪。

无需编辑 JSON。无需了解 MCP。无需学习配置文件。

没有安装 npm？

使用 npx 无需全局安装：

npx @planu/cli@latest install --global

兼容的 AI 工具

兼容 MCP 的工具（即插即用）

Planu 作为 MCP 服务器连接——AI 插件的开放标准：

AI 工具	自动检测
Claude Code	✓
Cursor	✓
Windsurf	✓
OpenCode	✓
Zed	✓
Cline（VS Code）	✓
Continue（VS Code）	✓
Claude Desktop	手动配置
Gemini CLI	手动配置

不支持 MCP 的工具（CLI + HTTP）

对于不原生支持 MCP 的 AI 工具，Planu 提供两种工作方式：

Codex / AGENTS.md 方式 — planu install --codex 将 Planu CLI 指令注入 AGENTS.md。Codex 和任何读取代理指令文件的 LLM 将自动使用 Planu。

HTTP / OpenAI function calling — 启动 HTTP 服务器，任何支持 HTTP 工具调用的 LLM（GPT-4、Gemini、Kimi、Claude API）都可以直接调用 Planu 工具：

planu serve --http --port 7823
# 工具可用地址：POST http://localhost:7823/v1/tools/call
# 工具列表地址：GET  http://localhost:7823/v1/tools

跳过权限提示（推荐）

默认情况下，你的 AI 工具会在 Planu 每次使用工具时请求批准。要自动批准所有 Planu 工具（安全——Planu 只读写本地 spec 文件）：

Claude Code

claude settings add permissions.allow "mcp__planu__*"

或手动添加到 ~/.claude/settings.json：

{
  "permissions": {
    "allow": ["mcp__planu__*"]
  }
}

Cursor

在 Cursor 设置 → Features → MCP → 为 Planu 服务器开启 Auto-approve。

Windsurf / OpenCode

默认自动批准 MCP 工具——无需额外配置。

为什么是安全的？

Planu 只在项目的 planu/ 文件夹中读写文件。它从不执行代码、访问互联网或修改你的源文件。

手动安装（适用于不支持的工具或自定义设置）

{
  "mcpServers": {
    "planu": {
      "command": "npx",
      "args": ["--prefer-online", "-y", "@planu/cli@latest"]
    }
  }
}

Claude Code：

claude mcp add planu -- npx -y @planu/cli@latest

Cursor： 打开或创建 ~/.cursor/mcp.json 并粘贴配置块。

Windsurf： 打开或创建 ~/.windsurf/mcp.json 并粘贴配置块。

OpenCode： 打开或创建 ~/.config/opencode/config.json 并粘贴：

{
  "mcp": {
    "planu": { "type": "local", "command": ["planu", "serve"], "enabled": true }
  }
}

Gemini CLI： 打开或创建 ~/.gemini/settings.json 并粘贴配置块。

Codex / AGENTS.md：

planu install --codex     # 将指令注入 AGENTS.md

你的第一个项目

安装完成后，只需和你的 AI 助手开始对话。无需记忆任何命令。

示例："我想给我的 App 添加 Google 登录"

就这样。说出你想要的，Planu 会自动：

1. 分析你的项目 — 检测你的技术栈、现有代码和结构
2. 创建详细计划 — 一份包含验收标准、工作量估算和技术方案的规格
3. 请求你的确认 — 你审查计划后可以批准、要求修改或拒绝
4. 按计划实现 — 根据已批准的规格编写代码
5. 验证结果 — 检查实现是否符合计划

更多你可以说的例子

• "帮我用 Stripe 构建一个支付系统"
• "在设置页面添加深色模式切换"
• "修复用户无法上传大文件的 Bug"
• "将认证模块重构为使用 JWT"
• "我需要一个用户资料的 API 接口"

你始终掌握控制权

• 批准或拒绝 — 代码编写前会先呈现计划供你决定
• 要求修改 — "做得更简单一些"或"添加频率限制"
• 跳过工作流 — "只加一个 console.log"也完全没问题
• 追踪进度 — Planu 记录已完成的和待处理的工作

这就是全部教程。 安装、对话、构建。其余的交给 Planu。

你的 AI 生态系统 — 每个工具的自动配置

ai_ecosystem_status — 每个 AI 工具的健康检查

Prompt: "What is the health of my AI ecosystem?"

sync_ai_configs — 一次修复所有问题

Prompt: "Sync my AI configs"

一次安装，零配置工作

安装 Planu 后运行一次 sync_ai_configs。之后你使用的每个 AI 工具都将立即配置好规格驱动开发环境。

下一步

• 了解完整的 SDD 工作流 →
• 探索所有 Planu 工具 →
• 查看实际应用案例 →