|
1 | | -# BMad Method & BMad Core |
| 1 | +# BMad Method |
2 | 2 |
|
3 | | -[](https://www.npmjs.com/package/bmad-method) |
4 | | -[](https://www.npmjs.com/package/bmad-method) |
| 3 | +[](https://www.npmjs.com/package/bmad-method) |
5 | 4 | [](LICENSE) |
6 | 5 | [](https://nodejs.org) |
7 | 6 | [](https://discord.gg/gk8jAdXWmj) |
8 | 7 |
|
9 | | ---- |
10 | | - |
11 | | -<div align="center"> |
12 | | - |
13 | | -## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content! |
14 | | - |
15 | | -The completely revamped **BMAD V6 installer** now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal! |
16 | | - |
17 | | -**✨ What's New:** |
18 | | - |
19 | | -- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules |
20 | | -- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows |
21 | | -- 🔄 **Unitary Module Support** - Install individual components without full modules |
22 | | -- ⚙️ **Dependency Management** - Automatic handling of module dependencies |
23 | | -- 🛡️ **Update-Safe Customization** - Your custom content persists through updates |
24 | | - |
25 | | -**📚 Learn More:** |
26 | | - |
27 | | -- [**Custom Content Overview**](http://docs.bmad-method.org/explanation/bmad-builder/custom-content-types/) - Discover all supported content types |
28 | | -- [**Installation Guide**](http://docs.bmad-method.org/how-to/installation/install-custom-modules/) - Learn to create and install custom content |
29 | | -- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules. |
30 | | - |
31 | | -</div> |
32 | | - |
33 | | ---- |
34 | | - |
35 | | -## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise |
36 | | - |
37 | | -**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before! |
38 | | - |
39 | | -Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits! |
| 8 | +**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. |
40 | 9 |
|
41 | | -> **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6) |
| 10 | +## Why BMad? |
42 | 11 |
|
43 | | -> **📌 v6 Alpha Status:** Near-beta quality with vastly improved stability. Documentation is being finalized. New videos coming soon to [BMadCode YouTube](https://www.youtube.com/@BMadCode). |
| 12 | +Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking. |
44 | 13 |
|
45 | | -## 🎯 Why BMad Method? |
| 14 | +- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4) |
| 15 | +- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation |
| 16 | +- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more) |
| 17 | +- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation |
46 | 18 |
|
47 | | -Unlike generic AI coding assistants, BMad Method provides **structured, battle-tested workflows** powered by specialized agents who understand agile development. Each agent has deep domain expertise—from product management to architecture to testing—working together seamlessly. |
| 19 | +## Quick Start |
48 | 20 |
|
49 | | -**✨ Key Benefits:** |
50 | | - |
51 | | -- **Scale-Adaptive Intelligence** - Automatically adjusts planning depth from bug fixes to enterprise systems |
52 | | -- **Complete Development Lifecycle** - Analysis → Planning → Architecture → Implementation |
53 | | -- **Specialized Expertise** - 19 agents with specific roles (PM, Architect, Developer, UX Designer, etc.) |
54 | | -- **Proven Methodologies** - Built on agile best practices with AI amplification |
55 | | -- **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code |
56 | | - |
57 | | -## 🏗️ The Power of BMad Core |
58 | | - |
59 | | -**BMad Method** is actually a sophisticated module built on top of **BMad Core** (**C**ollaboration **O**ptimized **R**eflection **E**ngine). This revolutionary architecture means: |
60 | | - |
61 | | -- **BMad Core** provides the universal framework for human-AI collaboration |
62 | | -- **BMad Method** leverages Core to deliver agile development workflows |
63 | | -- **BMad Builder** lets YOU create custom modules as powerful as BMad Method itself |
64 | | - |
65 | | -With **BMad Builder**, you can architect both simple agents and vastly complex domain-specific modules (legal, medical, finance, education, creative) that will soon be sharable in an **official community marketplace**. Imagine building and sharing your own specialized AI team! |
66 | | - |
67 | | -## 📊 See It In Action |
68 | | - |
69 | | -<p align="center"> |
70 | | - <img src="./docs/tutorials/getting-started/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%"> |
71 | | -</p> |
72 | | - |
73 | | -<p align="center"> |
74 | | - <em>Complete BMad Method workflow showing all phases, agents, and decision points</em> |
75 | | -</p> |
76 | | - |
77 | | -## 🚀 Get Started in 3 Steps |
78 | | - |
79 | | -### 1. Install BMad Method |
| 21 | +**Prerequisites**: [Node.js](https://nodejs.org) v20+ |
80 | 22 |
|
81 | 23 | ```bash |
82 | | -# Install v6 RECOMMENDED |
83 | 24 | npx bmad-method@alpha install |
84 | 25 | ``` |
85 | 26 |
|
86 | | -```bash |
87 | | -# Install v4 Legacy (not recommended if starting fresh) |
88 | | -npx bmad-method install |
89 | | -# OR |
90 | | -npx bmad-method@latest install |
91 | | -``` |
92 | | - |
93 | | - |
94 | | -### 2. Initialize Your Project |
| 27 | +Follow the installer prompts to configure your project. Then run: |
95 | 28 |
|
96 | | -Load any agent in your IDE and run: |
97 | | - |
98 | | -``` |
| 29 | +```bash |
99 | 30 | *workflow-init |
100 | 31 | ``` |
101 | 32 |
|
102 | | -This analyzes your project and recommends the right workflow track. |
103 | | - |
104 | | -### 3. Choose Your Track |
105 | | - |
106 | | -BMad Method adapts to your needs with three intelligent tracks: |
107 | | - |
108 | | -| Track | Use For | Planning | Time to Start | |
109 | | -| ----------------- | ------------------------- | ----------------------- | ------------- | |
110 | | -| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes | |
111 | | -| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes | |
112 | | -| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes | |
113 | | - |
114 | | -> **Not sure?** Run `*workflow-init` and let BMad analyze your project goal. |
115 | | -
|
116 | | -## 🔄 How It Works: 4-Phase Methodology |
117 | | - |
118 | | -BMad Method guides you through a proven development lifecycle: |
119 | | - |
120 | | -1. **📊 Analysis** (Optional) - Brainstorm, research, and explore solutions |
121 | | -2. **📝 Planning** - Create PRDs, tech specs, or game design documents |
122 | | -3. **🏗️ Solutioning** - Design architecture, UX, and technical approach |
123 | | -4. **⚡ Implementation** - Story-driven development with continuous validation |
124 | | - |
125 | | -Each phase has specialized workflows and agents working together to deliver exceptional results. |
126 | | - |
127 | | -## 🤖 Meet Your Team |
128 | | - |
129 | | -**12 Specialized Agents** working in concert: |
130 | | - |
131 | | -| Development | Architecture | Product | Leadership | |
132 | | -| ----------- | -------------- | ----------- | ------------ | |
133 | | -| Developer | Architect | PM | Scrum Master | |
134 | | -| UX Designer | Test Architect | Analyst | BMad Master | |
135 | | -| | | Tech Writer | | |
| 33 | +This analyzes your project and recommends a track: |
136 | 34 |
|
137 | | -**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready web app fixture-based utilities. |
| 35 | +| Track | Best For | Time to First Story | |
| 36 | +| --------------- | ------------------------- | ------------------- | |
| 37 | +| **Quick Flow** | Bug fixes, small features | ~5 minutes | |
| 38 | +| **BMad Method** | Products and platforms | ~15 minutes | |
| 39 | +| **Enterprise** | Compliance-heavy systems | ~30 minutes | |
138 | 40 |
|
139 | | -Each agent brings deep expertise and can be customized to match your team's style. |
| 41 | +## Modules |
140 | 42 |
|
141 | | -## 📦 What's Included |
| 43 | +| Module | Purpose | |
| 44 | +| ------------------------------------- | -------------------------------------------------------- | |
| 45 | +| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases | |
| 46 | +| **BMad Builder (BMB)** | Create custom agents and domain-specific modules | |
| 47 | +| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving | |
142 | 48 |
|
143 | | -### Official Modules |
| 49 | +## Documentation |
144 | 50 |
|
145 | | -- **BMad Method (BMM)** - Complete agile development framework |
146 | | - - 12 specialized agents |
147 | | - - 34 workflows across 4 phases |
148 | | - - Stand Along Quick Spec Flow for a streamlined simple implementation process |
149 | | - - [→ Documentation Hub](http://docs.bmad-method.org/explanation/bmm/) |
| 51 | +**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference |
150 | 52 |
|
151 | | -- **BMad Builder (BMB)** - Create custom agents and workflows |
152 | | - - Build anything from simple agents to complex modules |
153 | | - - Create domain-specific solutions (legal, medical, finance, education) |
154 | | - - [→ Builder Guide](http://docs.bmad-method.org/explanation/bmad-builder/) |
155 | | - |
156 | | -- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving |
157 | | - - Brainstorming, design thinking, storytelling |
158 | | - - 5 creative facilitation workflows |
159 | | - - [→ Creative Workflows](http://docs.bmad-method.org/explanation/creative-intelligence/) |
160 | | - |
161 | | -### Key Features |
162 | | - |
163 | | -- **🎨 Customizable Agents** - Modify personalities, expertise, and communication styles |
164 | | -- **🌐 Multi-Language Support** - Separate settings for communication and code output |
165 | | -- **📄 Document Sharding** - 90% token savings for large projects |
166 | | -- **🔄 Update-Safe** - Your customizations persist through updates |
167 | | -- **🚀 Web Bundles** - Use in ChatGPT, Claude Projects, or Gemini Gems |
168 | | - |
169 | | -## 📚 Documentation |
170 | | - |
171 | | -### Quick Links |
172 | | - |
173 | | -- **[Quick Start Guide](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)** - 15-minute introduction |
174 | | -- **[Complete BMM Documentation](http://docs.bmad-method.org/explanation/bmm/)** - All guides and references |
175 | | -- **[Agent Customization](http://docs.bmad-method.org/how-to/customization/customize-agents/)** - Personalize your agents |
176 | | -- **[All Documentation](http://docs.bmad-method.org/)** - Complete documentation index |
| 53 | +- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/) |
| 54 | +- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/) |
177 | 55 |
|
178 | 56 | ### For v4 Users |
179 | 57 |
|
180 | 58 | - **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)** |
181 | | -- **[v4 to v6 Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)** |
182 | | - |
183 | | -## 💬 Community & Support |
184 | | - |
185 | | -- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects |
186 | | -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features |
187 | | -- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos |
188 | | -- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon) |
189 | | -- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines |
190 | | - |
191 | | -## 🛠️ Development |
192 | | - |
193 | | -If you would like to contribute, first check the [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines. |
194 | | - |
195 | | -## What's New in v6 |
196 | | - |
197 | | -**v6 represents a complete architectural revolution from v4:** |
198 | | - |
199 | | -### 🚀 Major Upgrades |
200 | | - |
201 | | -- **BMad Core Framework** - Modular architecture enabling custom domain solutions |
202 | | -- **Scale-Adaptive Intelligence** - Automatic adjustment from bug fixes to enterprise |
203 | | -- **Visual Workflows** - Beautiful SVG diagrams showing complete methodology |
204 | | -- **BMad Builder Module** - Create and share your own AI agent teams |
205 | | -- **50+ Workflows** - Up from 20 in v4, covering every development scenario |
206 | | -- **19 Specialized Agents** - Enhanced with customizable personalities and expertise |
207 | | -- **Update-Safe Customization** - Your configs persist through all updates |
208 | | -- **Web Bundles** - Use agents in ChatGPT, Claude, and Gemini |
209 | | -- **Multi-Language Support** - Separate settings for communication and code |
210 | | -- **Document Sharding** - 90% token savings for large projects |
211 | 59 |
|
212 | | -### 🔄 For v4 Users |
| 60 | +## Community |
213 | 61 |
|
214 | | -- **[Comprehensive Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)** - Step-by-step migration |
215 | | -- **[v4 Documentation Archive](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)** - Legacy reference |
216 | | -- Backwards compatibility where possible |
217 | | -- Smooth migration path with installer detection |
| 62 | +- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate |
| 63 | +- [YouTube](https://www.youtube.com/@BMadCode) — Video tutorials and updates |
| 64 | +- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests |
| 65 | +- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations |
218 | 66 |
|
219 | | -## 📄 License |
| 67 | +## Contributing |
220 | 68 |
|
221 | | -MIT License - See [LICENSE](LICENSE) for details. |
| 69 | +We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
222 | 70 |
|
223 | | -**Trademarks:** BMad™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. |
| 71 | +## License |
224 | 72 |
|
225 | | -Supported by: <a href="https://m.do.co/c/00f11bd932bb"><img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" height="24" alt="DigitalOcean" style="vertical-align: middle;"></a> |
| 73 | +MIT License — see [LICENSE](LICENSE) for details. |
226 | 74 |
|
227 | 75 | --- |
228 | 76 |
|
229 | | -<p align="center"> |
230 | | - <a href="https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors"> |
231 | | - <img src="https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD" alt="Contributors"> |
232 | | - </a> |
233 | | -</p> |
| 77 | +**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. |
234 | 78 |
|
235 | | -<p align="center"> |
236 | | - <sub>Built with ❤️ for the human-AI collaboration community</sub> |
237 | | -</p> |
| 79 | +[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors) |
0 commit comments