261 lines
10 KiB
Markdown
261 lines
10 KiB
Markdown
# BMad CORE v6 Beta
|
|
|
|
[](https://www.npmjs.com/package/bmad-method)
|
|
[](LICENSE)
|
|
[](https://nodejs.org)
|
|
[](https://discord.gg/gk8jAdXWmj)
|
|
|
|
**The Universal Human-AI Collaboration Platform**
|
|
|
|
BMad-CORE (**C**ollaboration **O**ptimized **R**eflection **E**ngine) is a revolutionary framework that amplifies human potential through specialized AI agents. Unlike traditional AI tools that replace human thinking, BMad-CORE guides you through reflective workflows that bring out your best ideas and the AI's full capabilities.
|
|
|
|
**🎯 Human Amplification, Not Replacement** • **🎨 Works in Any Domain** • **⚡ Powered by Specialized Agents**
|
|
|
|
---
|
|
|
|
## 🔄 Upgrading from v4?
|
|
|
|
**[→ v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Complete migration instructions for existing v4 users
|
|
|
|
---
|
|
|
|
## What is BMad-CORE?
|
|
|
|
BMad-CORE is the **universal foundation** that powers all BMad modules. It provides:
|
|
|
|
- **Agent orchestration framework** for specialized AI personas
|
|
- **Workflow execution engine** for guided processes
|
|
- **Modular architecture** allowing domain-specific extensions
|
|
- **IDE integrations** across multiple development environments
|
|
- **Update-safe customization system** for all agents and workflows
|
|
|
|
### Core v6 Framework Enhancements
|
|
|
|
**All modules benefit from these new core capabilities:**
|
|
|
|
- **🎨 Full Agent Customization** - Modify any agent's name, role, personality, and behavior via `bmad/_cfg/agents/` customize files that survive all updates
|
|
- **🌐 Multi-Language Support** - Choose your language for both agent communication and documentation output independently
|
|
- **👤 User Personalization** - Agents address you by name and adapt to your technical level and preferences
|
|
- **🔄 Update-Safe Configuration** - Your customizations persist through framework and module updates
|
|
- **⚙️ Flexible Settings** - Configure communication style, technical depth, output formats, and more per module or globally
|
|
|
|
### The C.O.R.E. Philosophy
|
|
|
|
- **C**ollaboration: Human-AI partnership where both contribute unique strengths
|
|
- **O**ptimized: Refined processes for maximum effectiveness
|
|
- **R**eflection: Guided thinking that unlocks better solutions
|
|
- **E**ngine: Powerful framework orchestrating specialized agents and workflows
|
|
|
|
Instead of giving you answers, BMad-CORE helps you **discover better solutions** through strategic questioning, expert guidance, and structured thinking.
|
|
|
|
---
|
|
|
|
## The BMad Method - Agile AI-Driven Development
|
|
|
|
**The flagship module for software and game development excellence.**
|
|
|
|
The BMad Method (BMM) is a complete AI-driven agile development framework that revolutionizes how you build software and games. Whether you're fixing a bug, building a feature, or architecting an enterprise system, BMM adapts to your needs.
|
|
|
|
### What's New in v6?
|
|
|
|
**🎯 Revolutionary Scale-Adaptive Workflows**
|
|
|
|
- **Levels 0-4**: Automatically adjusts from quick fixes to enterprise-scale projects
|
|
- **Greenfield & Brownfield**: Full support for new projects and existing codebases
|
|
- **Smart Context Engine**: New optimized brownfield documentation engine that understands your existing code
|
|
|
|
**🏗️ Project-Adaptive Architecture**
|
|
|
|
- Architecture documents that adapt to YOUR project type (web, mobile, embedded, game, etc.)
|
|
- No more "one-size-fits-all" templates
|
|
- Specialized sections based on what you're actually building
|
|
- Game development fully integrated with engine-specific guidance (Unity, Phaser, Godot, Unreal, and more)
|
|
|
|
**⚡ From Simple to Complex - All in One System**
|
|
|
|
- **Level 0-1**: Quick fixes and small features with minimal overhead
|
|
- **Level 2**: Feature development with lightweight planning
|
|
- **Level 3-4**: Full enterprise workflows with comprehensive documentation
|
|
- Seamless workflow progression as complexity grows
|
|
|
|
**💬 Highly Interactive & Guided**
|
|
|
|
- Interactive workflows that ask the right questions
|
|
- Agents guide you through discovery rather than giving generic answers
|
|
- Context-aware recommendations based on your project state
|
|
- Real-time validation and course correction
|
|
|
|
**📋 Four-Phase Methodology**
|
|
|
|
1. **Analysis** (Optional) - Brainstorming, research, product briefs
|
|
2. **Planning** (Required) - Scale-adaptive PRD/GDD generation
|
|
3. **Solutioning** (Level 3-4) - Adaptive architecture and tech specs
|
|
4. **Implementation** (Iterative) - Story creation, context gathering, development, review
|
|
|
|
### Specialized Agents
|
|
|
|
- **PM** - Product planning and requirements
|
|
- **Analyst** - Research and business analysis
|
|
- **Architect** - Technical architecture and design
|
|
- **Game Designer** - Game-specific design and documentation
|
|
- **Scrum Master** - Sprint planning and story management
|
|
- **Developer** - Implementation with senior dev review
|
|
- **And more** - UX, Test Architect, specialized game roles
|
|
|
|
### Documentation
|
|
|
|
- **[📚 Complete BMM Documentation](./src/modules/bmm/README.md)** - Full module reference
|
|
- **[📖 BMM Workflows Guide](./src/modules/bmm/workflows/README.md)** - Essential reading for using BMM
|
|
|
|
---
|
|
|
|
## Additional Beta Modules
|
|
|
|
### **[BMad Builder (BMB)](./src/modules/bmb/README.md)** - Create Custom Solutions
|
|
|
|
Build your own agents, workflows, and modules using the BMad-CORE framework.
|
|
|
|
- **Agent Creation**: Design specialized agents with custom roles and behaviors
|
|
- **Workflow Design**: Build structured multi-step processes
|
|
- **Module Development**: Package complete solutions for any domain
|
|
- **Three Agent Types**: Full module, hybrid, and standalone agents
|
|
|
|
**[📚 Complete BMB Documentation](./src/modules/bmb/README.md)** | **[🎯 Agent Creation Guide](./src/modules/bmb/workflows/create-agent/README.md)**
|
|
|
|
---
|
|
|
|
### **[Creative Intelligence Suite (CIS)](./src/modules/cis/readme.md)** - Innovation & Creativity
|
|
|
|
Transform creative and strategic thinking through AI-powered facilitation across five specialized domains.
|
|
|
|
- **5 Interactive Workflows**: Brainstorming, Design Thinking, Problem Solving, Innovation Strategy, Storytelling
|
|
- **150+ Creative Techniques**: Proven frameworks and methodologies
|
|
- **5 Specialized Agents**: Each with unique personas and facilitation styles
|
|
- **Shared Resource**: Powers creative workflows in other modules (e.g., BMM brainstorming)
|
|
|
|
**[📚 Complete CIS Documentation](./src/modules/cis/readme.md)** | **[📖 CIS Workflows](./src/modules/cis/workflows/README.md)**
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
### Prerequisites
|
|
|
|
- **Node.js v20+** ([Download](https://nodejs.org))
|
|
|
|
### Installation
|
|
|
|
Install BMad to your project using npx:
|
|
|
|
```bash
|
|
npx bmad-method install
|
|
```
|
|
|
|
> **Version Selection:** When running `npx bmad-method install`, you'll be prompted to choose:
|
|
>
|
|
> - **Stable (v4.x)** - Production-ready version
|
|
> - **Beta (v6.0.0-beta)** - Latest features with early access
|
|
>
|
|
> To install a specific version directly (skip prompt):
|
|
>
|
|
> ```bash
|
|
> npx bmad-method@4 install # Stable v4.x
|
|
> npx bmad-method@6.0.0-beta.0 install # Beta v6
|
|
> ```
|
|
|
|
The interactive installer will guide you through:
|
|
|
|
1. **Project location** - Where to install BMad
|
|
2. **Module selection** - Choose which modules you need (BMM, BMB, CIS)
|
|
3. **Configuration** - Set your name, language preferences, and module options
|
|
4. **IDE integration** - Configure your development environment
|
|
|
|
### What Gets Installed
|
|
|
|
All modules install to a single `bmad/` folder in your project:
|
|
|
|
```
|
|
your-project/
|
|
└── bmad/
|
|
├── core/ # Core framework (always installed)
|
|
├── bmm/ # BMad Method (if selected)
|
|
├── bmb/ # BMad Builder (if selected)
|
|
├── cis/ # Creative Intelligence Suite (shared resources)
|
|
└── _cfg/ # Your customizations
|
|
└── agents/ # Agent customization files
|
|
```
|
|
|
|
### Getting Started with BMM
|
|
|
|
After installation, activate the Analyst agent in your IDE and run:
|
|
|
|
```bash
|
|
/workflow-init
|
|
```
|
|
|
|
Or run it directly as a command (command syntax varies by IDE - use slash commands in Claude Code, OpenCode, etc.).
|
|
|
|
This sets up the guided workflow system and helps you choose the right starting point for your project based on its complexity.
|
|
|
|
---
|
|
|
|
## Key Features
|
|
|
|
### 🎨 Update-Safe Customization
|
|
|
|
- **Agent Customization**: Modify agents via `bmad/_cfg/agents/` customize files
|
|
- **Persistent Settings**: Your customizations survive updates
|
|
- **Multi-Language Support**: Agents communicate in your preferred language
|
|
- **Flexible Configuration**: Adjust agent names, roles, communication styles, and more
|
|
|
|
### 🚀 Intelligent Installation
|
|
|
|
The installer automatically:
|
|
|
|
- Detects and migrates v4 installations
|
|
- Configures IDE integrations
|
|
- Resolves module dependencies
|
|
- Sets up agent customization templates
|
|
- Creates unified agent manifests
|
|
|
|
### 📁 Unified Architecture
|
|
|
|
Everything in one place - no more scattered configuration folders. Clean, organized, maintainable.
|
|
|
|
---
|
|
|
|
## Additional Documentation
|
|
|
|
- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Migration instructions for v4 users
|
|
- **[CLI Tool Guide](./tools/cli/README.md)** - Installer and bundler reference
|
|
- **[Contributing Guide](./CONTRIBUTING.md)** - How to contribute to BMad
|
|
|
|
---
|
|
|
|
## Community & Support
|
|
|
|
- 💬 **[Discord](https://discord.gg/gk8jAdXWmj)** - Get help, share ideas, and collaborate
|
|
- 🐛 **[Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs and request features
|
|
- 🎥 **[YouTube](https://www.youtube.com/@BMadCode)** - Tutorials and updates
|
|
- ⭐ **[Star this repo](https://github.com/bmad-code-org/BMAD-METHOD)** - Get notified of updates
|
|
|
|
---
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! See **[CONTRIBUTING.md](CONTRIBUTING.md)** for guidelines.
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
MIT License - See [LICENSE](LICENSE) for details.
|
|
|
|
**Trademark Notice**: BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.
|
|
|
|
---
|
|
|
|
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
|
|
|
<sub>Built with ❤️ for the human-AI collaboration community</sub>
|