mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
7d3d51ff4f
- Remove duplicate "for" in README example command - Fix "this is" to "thing is" in README - Remove extra "at" in "star project icon at near" in README - Fix "MEthod" to "Method" in customize-bmad.md
119 lines
8.3 KiB
Markdown
119 lines
8.3 KiB
Markdown
|
|
|
|
[](https://www.npmjs.com/package/bmad-method)
|
|
[](LICENSE)
|
|
[](https://nodejs.org)
|
|
[](https://discord.gg/gk8jAdXWmj)
|
|
|
|
**Breakthrough Method of Agile AI Driven Development** — 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.
|
|
|
|
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
|
|
|
|
## Why BMad?
|
|
|
|
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
|
|
|
|
- **AI Intelligent Help**: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for `/bmad-help` after you have installed BMad to your project
|
|
- **Scale-Domain-Adaptive**: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
|
|
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
|
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
|
- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
|
|
- **Complete Lifecycle**: From brainstorming to deployment, BMad is there with you every step of the way
|
|
|
|
## Quick Start
|
|
|
|
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
|
|
|
```bash
|
|
npx bmad-method install
|
|
```
|
|
|
|
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
|
|
|
|
> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like:
|
|
|
|
- `/bmad-help How should I build a web app for my TShirt Business that can scale to millions?`
|
|
- `/bmad-help I just finished the architecture, I am not sure what to do next`
|
|
|
|
And the amazing thing is BMad Help evolves depending on what modules you install also!
|
|
- `/bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?`, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed!
|
|
|
|
The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.
|
|
|
|
### Simple Path (Quick Flow)
|
|
|
|
Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent:
|
|
|
|
1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories
|
|
2. `/dev-story` — implements each story
|
|
3. `/code-review` — validates quality
|
|
|
|
### Full Planning Path (BMad Method)
|
|
|
|
Products, platforms, complex features — structured planning then build:
|
|
|
|
1. `/product-brief` — define problem, users, and MVP scope
|
|
2. `/create-prd` — full requirements with personas, metrics, and risks
|
|
3. `/create-architecture` — technical decisions and system design
|
|
4. `/create-epics-and-stories` — break work into prioritized stories
|
|
5. `/sprint-planning` — initialize sprint tracking
|
|
6. **Repeat per story:** `/create-story` → `/dev-story` → `/code-review`
|
|
|
|
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask `/bmad-help` anytime. For a detailed walkthrough, see the [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/).
|
|
|
|
## Modules
|
|
|
|
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills.
|
|
|
|
| Module | GitHub | NPM | Purpose |
|
|
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
|
|
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
|
|
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
|
|
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
|
|
|
|
* More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!
|
|
|
|
## Documentation
|
|
|
|
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
|
|
|
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/)
|
|
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/upgrade-to-v6/)
|
|
|
|
### For v4 Users
|
|
|
|
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
|
|
|
## Community
|
|
|
|
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
|
- [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
|
|
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
|
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
|
|
|
## Support BMad
|
|
|
|
BMad is free for everyone — and always will be. If you'd like to support development:
|
|
|
|
- ⭐ Please click the star project icon near the top right of this page
|
|
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
|
- 🏢 Corporate sponsorship — DM on Discord
|
|
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord)
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
|
|
## License
|
|
|
|
MIT License — see [LICENSE](LICENSE) for details.
|
|
|
|
---
|
|
|
|
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. See [TRADEMARK.md](TRADEMARK.md) for details.
|
|
|
|
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
|
|
|
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.
|