BMAD-METHOD/install-bmad.md at ad2eb0e127efd48daa55f432c9d89133ea347b01

3.5 KiB

Raw Blame History

title

description

sidebar

如何安装 BMad

在项目中安装 BMad 的分步指南

order
1

使用 npx bmad-method install 在项目中安装 BMad，并按需选择模块和 AI 工具。

如果你需要在命令行里一次性传入全部安装参数（例如 CI/CD 场景），请阅读非交互式安装指南。

何时使用

使用 BMad 启动新项目
将 BMad 添加到现有代码库
更新现有的 BMad 安装

:::note[前置条件]

Node.js 20+（安装程序必需）
Git（推荐）
AI 工具（Claude Code、Cursor 或类似工具） :::

步骤

1. 运行安装程序

npx bmad-method install

:::tip[想要最新预发布版本？] 使用 next 发布标签：

npx bmad-method@next install

这会更早拿到新改动，但相比默认安装通道，出现变动的概率也更高。 :::

:::tip[前沿版本] 要从主分支安装最新版本（可能不稳定）：

npx github:bmad-code-org/BMAD-METHOD install

:::

2. 选择安装位置

安装程序会询问在哪里安装 BMad 文件：

当前目录（如果你自己创建了目录并从该目录运行，推荐用于新项目）
自定义路径

3. 选择你的 AI 工具

选择你使用的 AI 工具：

Claude Code
Cursor
其他

每种工具都有自己的 skills 集成方式。安装程序会生成用于激活工作流和智能体的轻量提示文件，并放到该工具约定的位置。

:::note[启用 Skills] 某些平台需要你在设置中手动启用 skills 才会显示。如果你已经安装 BMad 但看不到 skills，请检查平台设置，或直接询问你的 AI 助手如何启用 skills。 :::

4. 选择模块

安装程序会显示可用的模块。选择你需要的模块——大多数用户只需要 BMad Method（软件开发模块）。

5. 按照提示操作

安装程序会引导你完成剩余步骤——自定义内容、设置等。

你将获得

以下目录结构仅作示例。工具相关目录会随你选择的平台变化（例如可能是 .claude/skills、.cursor/skills 或 .kiro/skills），并不一定会同时出现。

your-project/
├── _bmad/
│   ├── bmm/            # 你选择的模块
│   │   └── config.yaml # 模块设置（后续如需可修改）
│   ├── core/           # 必需核心模块
│   └── ...
├── _bmad-output/       # 生成产物
├── .claude/            # Claude Code skills（如使用 Claude Code）
│   └── skills/
│       ├── bmad-help/
│       ├── bmad-persona/
│       └── ...
└── .cursor/            # Cursor skills（如使用 Cursor）
    └── skills/
        └── ...

验证安装

运行 bmad-help 来验证一切正常并查看下一步操作。

BMad-Help 是你的智能向导，它会：

确认你的安装正常工作
根据你安装的模块显示可用内容
推荐你的第一步

你也可以向它提问：

bmad-help 我刚安装完成，应该先做什么？
bmad-help 对于 SaaS 项目我有哪些选项？

故障排除

安装程序抛出错误——将输出复制粘贴到你的 AI 助手中，让它来解决问题。

安装程序工作正常但后续出现问题——你的 AI 需要 BMad 上下文才能提供帮助。请参阅如何获取关于 BMad 的答案了解如何将你的 AI 指向正确的来源。

3.5 KiB Raw Blame History Unescape Escape