基于 Agentic Agile Driven Development(代理驱动敏捷开发)的基础,即突破性敏捷 AI 驱动开发方法,但远不止于此。利用专业 AI 专长改造任何领域:软件开发、娱乐、创意写作、商业战略到个人健康,仅举几例。
加入我们的 Discord 社区 - 一个不断壮大的 AI 爱好者社区!获取帮助、分享想法、探索 AI 代理和框架、协作技术项目、享受爱好,并互相帮助取得成功。无论您是被 BMad 困住、正在构建自己的代理,还是只想聊聊最新的 AI 动态——我们都在这里支持您!某些移动设备和 VPN 可能会在加入 Discord 时遇到问题,这是 Discord 的问题——如果邀请无效,请尝试使用您自己的网络、其他网络或非 VPN 连接。
⭐ 如果您发现此项目有帮助或有用,请在其右上角点个星! 这将帮助其他人发现 BMAD-METHOD™,您也将收到更新通知!
BMAD-METHOD™ 的两大关键创新:
1. 代理式规划: 专用的代理(分析师、项目经理、架构师)与您合作创建详细、一致的产品需求文档 (PRD) 和架构文档。通过先进的提示工程和人工参与的迭代优化,这些规划代理生成的规范非常全面,远远超出了通用的 AI 任务生成。
2. 上下文驱动开发: 然后,Scrum Master 代理将这些详细计划转化为超详细的开发故事,其中包含开发代理所需的一切——完整的上下文、实现细节以及直接嵌入故事文件中的架构指导。
这种两阶段方法消除了 AI 辅助开发中最大的两个问题——规划不一致和上下文丢失。您的开发代理打开故事文件时,将完全理解需要构建什么、如何构建以及为何构建。
📖 在用户指南中查看完整工作流程 - 规划阶段、开发周期以及所有代理角色
在深入之前,请先查看这些解释 BMad 工作原理的关键工作流程图:
- 规划工作流程(Web UI) - 如何创建 PRD 和架构文档
- 核心开发周期(IDE) - SM、Dev 和 QA 代理如何通过故事文件进行协作
⚠️ 这些图表解释了 BMad 方法代理敏捷流程 90% 的困惑之处 - 理解 PRD+架构的创建以及 SM/Dev/QA 工作流程和代理如何通过故事文件传递笔记至关重要——这也解释了为什么它不是任务管理器或简单的任务运行器!
- 使用全栈敏捷 AI 团队安装和构建软件 → 快速入门说明
- 学习如何使用 BMad → 完整的用户指南和演练
- 查看可用的 AI 代理) → 您的团队的专业角色
- 探索非技术用途 → 创意写作、商业、健康、教育
- 创建我自己的 AI 代理 → 为您的领域构建代理
- 浏览现成的扩展包 → 游戏开发、DevOps、基础设施,并从中获得灵感和示例
- 理解架构 → 技术深入探讨
- 加入社区 → 获取帮助并分享想法
轻松保持最新! 如果您已在项目中安装了 BMAD-METHOD™,只需运行:
npx bmad-method install
# 或
git pull
npm run install:bmad
这将:
- ✅ 自动检测您现有的 v4 安装
- ✅ 仅更新已更改的文件并添加新文件
- ✅ 为您的任何自定义修改创建
.bak
备份文件 - ✅ 保留您项目特定的配置
这使得您可以轻松地受益于最新的改进、错误修复和新代理,而不会丢失您的自定义内容!
只需运行以下命令之一:
npx bmad-method install
# 或显式使用稳定标签:
npx bmad-method@stable install
# 或如果您已经安装了 BMad:
git pull
npm run install:bmad
此单个命令处理:
- 新安装 - 在您的项目中设置 BMad
- 升级 - 自动更新现有安装
- 扩展包 - 安装您已添加到 package.json 的任何扩展包
就是这样! 无论是首次安装、升级还是添加扩展包——这些命令都能完成所有工作。
先决条件:需要 Node.js v20+
- 获取捆绑包:保存或克隆 全栈团队文件 或选择其他团队
- 创建 AI 代理:创建新的 Gemini Gem 或 CustomGPT
- 上传并配置:上传文件并设置指令:“您的关键操作指令已附带,请勿违背角色指示”
- 开始构思和规划:开始聊天!输入
*help
查看可用命令,或选择像*analyst
这样的代理开始创建简报。 - 关键:随时在 Web 上与 BMad Orchestrator 对话(#bmad-orchestrator 命令),询问有关工作原理的问题!
- 何时切换到 IDE:一旦您有了 PRD、架构、可选的 UX 和简报——就该切换到 IDE 来分片您的文档,并开始实现实际代码了!有关更多详细信息,请参阅 用户指南
git clone https://github.com/bmadcode/bmad-method.git
npm run install:bmad # 构建并安装所有内容到目标文件夹
BMAD™ 的自然语言框架适用于任何领域。扩展包为创意写作、商业战略、健康与保健、教育等提供专业的 AI 代理。扩展包还可以使用特定于某些情况的非通用功能来扩展核心 BMAD-METHOD™。请参阅 扩展包指南,了解如何创建自己的扩展包!
BMAD-METHOD™ 包含一个强大的代码库扁平化工具,用于准备您的项目文件以供 AI 模型使用。此工具将您的整个代码库聚合到一个单独的 XML 文件中,方便您与 AI 助手共享项目上下文以进行分析、调试或开发辅助。
- AI 优化输出:生成专为 AI 模型使用而设计的干净 XML 格式
- 智能过滤:自动遵守
.gitignore
模式以排除不必要的文件 - 二进制文件检测:智能识别并排除二进制文件,专注于源代码
- 进度跟踪:实时进度指示器和全面的完成统计信息
- 灵活输出:可自定义的输出文件位置和名称
# 基本用法 - 在当前目录创建 flattened-codebase.xml
npx bmad-method flatten
# 指定自定义输入目录
npx bmad-method flatten --input /path/to/source/directory
npx bmad-method flatten -i /path/to/source/directory
# 指定自定义输出文件
npx bmad-method flatten --output my-project.xml
npx bmad-method flatten -o /path/to/output/codebase.xml
# 组合输入和输出选项
npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
该工具将显示进度并提供全面的摘要:
📊 完成摘要:
✅ 成功将 156 个文件处理到 flattened-codebase.xml
📁 输出文件:/path/to/your/project/flattened-codebase.xml
📏 源文件总大小:2.3 MB
📄 生成的 XML 文件大小:2.1 MB
📝 总代码行数:15,847
🔢 预估 Token 数:542,891
📊 文件分类:142 个文本文件,14 个二进制文件,0 个错误
生成的 XML 文件以结构化格式包含您项目中的基于文本的源文件,AI 模型可以轻松解析和理解,非常适合代码审查、架构讨论或在 BMAD-METHOD™ 项目中获得 AI 辅助。
- CLI 选项
-i, --input <path>
:要扁平化的目录。默认值:当前工作目录或在交互式运行时自动检测的项目根目录。-o, --output <path>
:输出文件路径。默认值:所选目录中的flattened-codebase.xml
。
- 交互模式
- 如果未传递
--input
和--output
并且终端是交互式的(TTY),该工具将尝试检测您的项目根目录(通过查找.git
、package.json
等标记)并提示您确认或覆盖路径。 - 在非交互式环境(例如 CI)中,它将静默优先选择检测到的根目录;否则,它将回退到当前目录和默认文件名。
- 如果未传递
- 文件发现和忽略
- 在 Git 存储库内使用
git ls-files
以提高速度和准确性;否则回退到基于 glob 的扫描。 - 应用您的
.gitignore
以及一组精选的默认忽略模式(例如node_modules
、构建输出、缓存、日志、IDE 文件夹、锁定文件、大型媒体/二进制文件、.env*
以及先前生成的 XML 输出)。
- 在 Git 存储库内使用
- 二进制文件处理
- 二进制文件将被检测并从 XML 内容中排除。它们将在最终摘要中计数,但不会嵌入输出中。
- XML 格式和安全性
- 使用根元素
<files>
的 UTF-8 编码文件。 - 每个文本文件都将作为
<file path="relative/path">
元素发出,其内容包装在<![CDATA[ ... ]]>
中。 - 该工具会安全地处理内容中出现的
]]>
,通过拆分 CDATA 来保持正确性。 - 文件内容按原样保留,并在 XML 中进行缩进以提高可读性。
- 使用根元素
- 性能
- 并发性根据您的 CPU 和工作负载大小自动选择。无需配置。
- 在 Git 存储库内运行可提高发现性能。
<?xml version="1.0" encoding="UTF-8"?>
<files>
<file path="src/index.js"><![CDATA[
// your source content
]]></file>
</files>
- 💬 Discord 社区
- 🐛 问题跟踪器
- 💬 讨论
我们热衷于贡献,并欢迎您的想法、改进和扩展包! 🎉
📋 阅读 CONTRIBUTING.md - 完整的贡献指南,包括准则、流程和要求
MIT 许可证 - 有关详细信息,请参阅 LICENSE。
BMAD™ 和 BMAD-METHOD™ 是 BMad Code, LLC 的商标。保留所有权利。
为 AI 辅助开发社区用心构建 ❤️