mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
999ece33a9
* Add interactive workflow guide page Replace confusing static SVG workflow diagram with an interactive guide at /workflow-guide. Users select their track (Quick Flow, BMad Method, Enterprise) and see relevant phases, agents, commands, and outputs. Update link validator to recognize custom page routes. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add visual dev loop indicator to workflow guide Wrap create-story, dev-story, and code-review in a dashed border group with a "Repeat for each story" label to clearly communicate the iterative development cycle in Phase 4. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Simplify workflow guide to vertical slash command flow Replace expandable phase cards with a clean vertical flow showing slash commands as the primary element, with down arrows between steps, agent badges, required/optional status, and concise descriptions. Add prominent /bmad-help callout and note that agent loading is optional. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Simplify README Quick Start with numbered command flows Replace wordy paragraphs and track table with two clear numbered paths (Quick Flow: 3 commands, BMad Method: 6 steps) and a prominent /bmad-help callout as the primary guidance mechanism. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add Party Mode to README, /bmad-help to getting-started Add Party Mode bullet to Why BMad section, note about agent-based usage as an alternative to direct workflows, and a /bmad-help mention in the getting-started tutorial after installation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add link to getting-started tutorial in README Quick Start Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add workflow guide link to docs index New Here section Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Update README tagline and format modules table Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Fix workflow-guide links to use relative paths The /workflow-guide absolute path breaks with non-root base paths. Use relative paths since workflow-guide is a custom Astro page outside the docs collection. Docs-to-docs links keep the /docs/ pattern which the rehype plugin handles. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Revert workflow-guide links to absolute paths Use /workflow-guide to match the /docs/ convention used throughout. Works correctly on the production site where base path is /. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
111 lines
7.3 KiB
Markdown
111 lines
7.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 act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
|
|
|
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
|
|
- **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
|
|
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
|
|
|
|
## Quick Start
|
|
|
|
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
|
|
|
```bash
|
|
npx bmad-method@alpha 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 XYZ?`
|
|
|
|
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. `/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/getting-started-bmadv6/).
|
|
|
|
## 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.
|
|
|
|
| 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 |
|
|
|
|
## 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/getting-started-bmadv6/)
|
|
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/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
|
|
- [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:
|
|
|
|
- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad
|
|
- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026
|
|
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
|
- 🏢 Corporate sponsorship — DM on Discord
|
|
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (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.
|