Files
BMAD-METHOD/README.md

146 lines
8.3 KiB
Markdown
Raw Normal View History

# BMAD-METHOD™: Universal AI Agent Framework
2025-06-08 02:30:28 -05:00
[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
2025-06-13 20:16:33 -05:00
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
2025-06-17 09:35:39 -05:00
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
2025-06-28 08:36:12 -05:00
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
2025-06-08 02:30:28 -05:00
2025-10-24 11:00:09 -05:00
> ## 🚨 **IMPORTANT: This Branch is a Frozen snapshot of the V4 version of the BMad Method.** 🚨
>
> Updates will be made to continue support for critical patches or updates. New features generally will not be added to v4 unless critical for support of existing usage, in very rare instances.
Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, yet so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.
2025-06-13 20:16:33 -05:00
**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
2025-06-28 15:46:52 -05:00
**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you! **Some mobile and VPN may have issue joining the discord, this is a discord issue - if the invite does not work, try from your own internet or another network, or non-VPN.**
**If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMAD-METHOD™ and you will be notified of updates!
## Overview
**BMAD-METHOD™'s Two Key Innovations:**
**1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
**2. Context-Engineered Development:** The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.
This two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why.
2025-08-06 00:00:26 -05:00
**📖 [See the complete workflow in the User Guide](docs/user-guide.md)** - Planning phase, development cycle, and all agent roles
## Quick Navigation
2025-06-28 22:26:37 -05:00
### Understanding the BMad Workflow
2025-06-28 22:26:37 -05:00
2025-07-04 07:47:57 -05:00
**Before diving in, review these critical workflow diagrams that explain how BMad works:**
2025-06-28 22:26:37 -05:00
2025-08-06 00:00:26 -05:00
1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
> ⚠️ **These diagrams explain 90% of BMad Method Agentic Agile flow confusion** - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!
### What would you like to do?
- **[Install and Build software with Full Stack Agile AI Team](#quick-start)** → Quick Start Instruction
2025-08-06 00:00:26 -05:00
- **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough
2025-08-27 00:57:41 -04:00
- **[See available AI agents](/bmad-core/agents)** → Specialized roles for your team
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
2025-08-07 20:49:14 +08:00
- **[Create my own AI agents](docs/expansion-packs.md)** → Build agents for your domain
- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
2025-07-19 00:36:13 -05:00
- **[Join the community](https://discord.gg/gk8jAdXWmj)** → Get help and share ideas
## Important: Keep Your BMad Installation Updated
**Stay up-to-date effortlessly!** If you already have BMAD-METHOD™ installed in your project, simply run:
```bash
npx bmad-method install
# OR
git pull
npm run install:bmad
```
This will:
- ✅ Automatically detect your existing v4 installation
- ✅ Update only the files that have changed and add new files
- ✅ Create `.bak` backup files for any custom modifications you've made
- ✅ Preserve your project-specific configurations
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
## Quick Start
2025-06-13 20:16:33 -05:00
### One Command for Everything (IDE Installation)
**Just run one of these commands:**
```bash
npx bmad-method install
2025-10-24 11:00:09 -05:00
# OR if you already have BMad project itself cloned locally, from the folder of this repo:
git pull
2025-10-24 11:00:09 -05:00
npm run install:bmad # when prompted, enter the destination folder
```
This single command handles:
- **New installations** - Sets up BMad in your project
- **Upgrades** - Updates existing installations automatically
- **Expansion packs** - Installs any expansion packs you've added to package.json
> **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
### Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)
2025-06-13 20:16:33 -05:00
1. **Get the bundle**: Save or clone the [full stack team file](dist/teams/team-fullstack.txt) or choose another team
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
2025-08-06 00:00:26 -05:00
6. **When to move to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details
2025-06-13 20:16:33 -05:00
### Alternative: Clone and Build
2025-06-28 16:12:01 -05:00
```bash
git clone https://github.com/bmadcode/bmad-method.git
npm run install:bmad # build and install all to a destination folder
```
## 🌟 Beyond Software Development - Expansion Packs
2025-06-13 20:16:33 -05:00
BMAD™'s natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMAD-METHOD™ with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
2025-06-08 16:18:35 -05:00
## Documentation & Resources
### Essential Guides
2025-08-06 00:00:26 -05:00
- 📖 **[User Guide](docs/user-guide.md)** - Complete walkthrough from project inception to completion
- 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
- 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development
## Support
2025-06-08 16:18:35 -05:00
2025-07-19 00:36:13 -05:00
- 💬 [Discord Community](https://discord.gg/gk8jAdXWmj)
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
2025-06-13 20:16:33 -05:00
2025-06-13 07:27:22 -05:00
## Contributing
2025-06-08 16:18:35 -05:00
2025-10-24 11:00:09 -05:00
If you are interested in contributing, please switch to the latest on main and contribute to the current version.
## License
2025-06-28 16:12:01 -05:00
MIT License - see [LICENSE](LICENSE) for details.
2025-06-13 20:16:33 -05:00
## Trademark Notice
BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.
2025-06-13 20:16:33 -05:00
[![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
2025-06-13 07:27:22 -05:00
2025-06-13 20:16:33 -05:00
<sub>Built with ❤️ for the AI-assisted development community</sub>