BMAD-METHOD/docs/zh-cn/how-to/install-bmad.md

3.2 KiB
Raw Blame History

title description sidebar
如何安装 BMad 在项目中安装 BMad 的分步指南
order
1

使用 npx bmad-method install 命令在项目中设置 BMad并选择你需要的模块和 AI 工具。

如果你想使用非交互式安装程序并在命令行中提供所有安装选项,请参阅本指南

何时使用

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

:::note[前置条件]

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

步骤

1. 运行安装程序

npx bmad-method install

:::tip[最新版本] 要从主分支安装最新版本(可能不稳定):

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

:::

2. 选择安装位置

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

  • 当前目录(如果你自己创建了目录并从该目录运行,推荐用于新项目)
  • 自定义路径

3. 选择你的 AI 工具

选择你使用的 AI 工具:

  • Claude Code
  • Cursor
  • 其他

每个工具都有自己的命令集成方式。安装程序会创建微小的提示文件来激活工作流和智能体——它只是将它们放在工具期望找到的位置。

4. 选择模块

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

5. 按照提示操作

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

你将获得

your-project/
├── _bmad/
│   ├── bmm/            # 你选择的模块
│   │   └── config.yaml # 模块设置(如果你需要更改它们)
│   ├── core/           # 必需的核心模块
│   └── ...
├── _bmad-output/       # 生成的工件
├── .claude/            # Claude Code 命令(如果使用 Claude Code
└── .kiro/              # Kiro 引导文件(如果使用 Kiro

验证安装

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

BMad-Help 是你的智能向导,它会:

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

你也可以向它提问:

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

故障排除

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

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


术语说明

  • agent:智能体。在人工智能与编程文档中,指具备自主决策或执行能力的单元。
  • workflow:工作流。指一系列有序的任务或步骤,用于完成特定目标。
  • module:模块。指软件系统中可独立开发、测试和维护的功能单元。
  • artifact:工件。指在软件开发过程中生成的任何输出,如文档、代码、配置文件等。