|
|
|
|
@ -1,41 +1,33 @@
|
|
|
|
|
# BMAD-METHOD™: Universal AI Agent Framework
|
|
|
|
|
|
|
|
|
|
> ## 🚨 **IMPORTANT VERSION ANNOUNCEMENT** 🚨
|
|
|
|
|
>
|
|
|
|
|
> ### Current Stable: v4.x | Next Major: v6 Alpha
|
|
|
|
|
>
|
|
|
|
|
> - **v4.x** - The current stable release version available via npm
|
|
|
|
|
> - **v5** - Skipped (replaced by v6)
|
|
|
|
|
> - **[v6-alpha](https://github.com/bmad-code-org/BMAD-METHOD/tree/v6-alpha)** - **NOW AVAILABLE FOR EARLY TESTING!**
|
|
|
|
|
>
|
|
|
|
|
> ### 🧪 Try v6 Alpha (Early Adopters Only)
|
|
|
|
|
>
|
|
|
|
|
> The next major version of BMAD-METHOD is now available for early experimentation and testing. This is a complete rewrite with significant architectural changes.
|
|
|
|
|
>
|
|
|
|
|
> **⚠️ WARNING: v6-alpha is for early adopters who are comfortable with:**
|
|
|
|
|
>
|
|
|
|
|
> - Potential breaking changes
|
|
|
|
|
> - Daily updates and instability
|
|
|
|
|
> - Incomplete features
|
|
|
|
|
> - Experimental functionality
|
|
|
|
|
>
|
|
|
|
|
> **📅 Timeline:** Official beta version will be merged mid-October 2025
|
|
|
|
|
>
|
|
|
|
|
> **To try v6-alpha:**
|
|
|
|
|
>
|
|
|
|
|
> ```bash
|
|
|
|
|
> git clone https://github.com/bmad-code-org/BMAD-METHOD.git
|
|
|
|
|
> cd BMAD-METHOD
|
|
|
|
|
> git checkout v6-alpha
|
|
|
|
|
> ```
|
|
|
|
|
>
|
|
|
|
|
> ---
|
|
|
|
|
# BMAD-METHOD™: Universal AI Agent Framework (v4 - Stable)
|
|
|
|
|
|
|
|
|
|
[](https://www.npmjs.com/package/bmad-method)
|
|
|
|
|
[](LICENSE)
|
|
|
|
|
[](https://nodejs.org)
|
|
|
|
|
[](https://discord.gg/gk8jAdXWmj)
|
|
|
|
|
|
|
|
|
|
> ## 🚨 **v4 STABLE - NO NEW FEATURES** 🚨
|
|
|
|
|
>
|
|
|
|
|
> This is the **stable, production-ready v4 version** of BMad Method. It will receive **critical patches only** - no new features will be added.
|
|
|
|
|
>
|
|
|
|
|
> **Install v4 Stable:** `npx bmad-method install`
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## 🆕 Want to Try v6 Alpha?
|
|
|
|
|
|
|
|
|
|
**BMad v6** is under active development with major improvements:
|
|
|
|
|
|
|
|
|
|
- Scale-adaptive workflows (Levels 0-4)
|
|
|
|
|
- Project-adaptive architecture
|
|
|
|
|
- Enhanced module system (BMM, BMB, CIS)
|
|
|
|
|
- Update-safe customization
|
|
|
|
|
|
|
|
|
|
**[View v6 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/main)** | **Install:** `npx bmad-method@alpha install`
|
|
|
|
|
|
|
|
|
|
> **Note:** v6 is in alpha - stable enough for testing but not production-ready yet.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
|
|
|
|
|
@ -78,43 +70,37 @@ This two-phase approach eliminates both **planning inconsistency** and **context
|
|
|
|
|
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
|
|
|
|
- **[Join the community](https://discord.gg/gk8jAdXWmj)** → Get help and share ideas
|
|
|
|
|
|
|
|
|
|
## Important: Keep Your BMad Installation Updated
|
|
|
|
|
## Important: Keep Your v4 Installation Updated
|
|
|
|
|
|
|
|
|
|
**Stay up-to-date effortlessly!** If you already have BMAD-METHOD™ installed in your project, simply run:
|
|
|
|
|
**Stay up-to-date with v4 patches!** If you already have BMAD-METHOD™ v4 installed in your project, 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
|
|
|
|
|
- ✅ Update only the files that have changed (critical patches only)
|
|
|
|
|
- ✅ 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!
|
|
|
|
|
> **Remember:** v4 receives critical patches only. For new features, try [v6 alpha](#-want-to-try-v6-alpha).
|
|
|
|
|
|
|
|
|
|
## Quick Start
|
|
|
|
|
## Quick Start (v4 Stable)
|
|
|
|
|
|
|
|
|
|
### One Command for Everything (IDE Installation)
|
|
|
|
|
### One Command Installation
|
|
|
|
|
|
|
|
|
|
**Just run one of these commands:**
|
|
|
|
|
**Install v4 stable version:**
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npx bmad-method install
|
|
|
|
|
# OR if you already have BMad installed:
|
|
|
|
|
git pull
|
|
|
|
|
npm run install:bmad
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This single command handles:
|
|
|
|
|
This command handles:
|
|
|
|
|
|
|
|
|
|
- **New installations** - Sets up BMad in your project
|
|
|
|
|
- **Upgrades** - Updates existing installations automatically
|
|
|
|
|
- **New installations** - Sets up BMad v4 in your project
|
|
|
|
|
- **Upgrades** - Updates existing v4 installations with patches
|
|
|
|
|
- **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.
|
|
|
|
|
@ -130,10 +116,11 @@ This single command handles:
|
|
|
|
|
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
### Alternative: Clone and Build
|
|
|
|
|
### Alternative: Clone v4 Branch
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/bmadcode/bmad-method.git
|
|
|
|
|
git clone -b V4 https://github.com/bmad-code-org/BMAD-METHOD.git
|
|
|
|
|
cd BMAD-METHOD
|
|
|
|
|
npm run install:bmad # build and install all to a destination folder
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
@ -157,29 +144,7 @@ BMAD™'s natural language framework works in ANY domain. Expansion packs provid
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
|
|
|
|
|
|
|
|
|
|
📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
|
|
|
|
|
|
|
|
|
|
### Working with Forks
|
|
|
|
|
|
|
|
|
|
When you fork this repository, CI/CD workflows are **disabled by default** to save resources. This is intentional and helps keep your fork clean.
|
|
|
|
|
|
|
|
|
|
#### Need CI/CD in Your Fork?
|
|
|
|
|
|
|
|
|
|
See our [Fork CI/CD Guide](.github/FORK_GUIDE.md) for instructions on enabling workflows in your fork.
|
|
|
|
|
|
|
|
|
|
#### Contributing Workflow
|
|
|
|
|
|
|
|
|
|
1. **Fork the repository** - Click the Fork button on GitHub
|
|
|
|
|
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/BMAD-METHOD.git`
|
|
|
|
|
3. **Create a feature branch** - `git checkout -b feature/amazing-feature`
|
|
|
|
|
4. **Make your changes** - Test locally with `npm test`
|
|
|
|
|
5. **Commit your changes** - `git commit -m 'feat: add amazing feature'`
|
|
|
|
|
6. **Push to your fork** - `git push origin feature/amazing-feature`
|
|
|
|
|
7. **Open a Pull Request** - CI/CD will run automatically on the PR
|
|
|
|
|
|
|
|
|
|
Your contributions are tested when you submit a PR - no need to enable CI in your fork!
|
|
|
|
|
**v4 is frozen** - only critical patches accepted. For new features and contributions, please work on **[v6 (main branch)](https://github.com/bmad-code-org/BMAD-METHOD/tree/main)**.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
|