π¨ ALPHA VERSION DOCUMENTATION
This README documents BMad v6 (Alpha) - currently under active development.
To install v6 Alpha:
npx bmad-method@alpha installLooking for stable v4 documentation? View v4 README
Want the stable version?
npx bmad-method install(installs v4.x)
BMad-CORE (Collaboration Optimized Reflection Engine) 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
β v4 to v6 Upgrade Guide - Complete migration instructions for existing v4 users
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
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
- Collaboration: Human-AI partnership where both contribute unique strengths
- Optimized: Refined processes for maximum effectiveness
- Reflection: Guided thinking that unlocks better solutions
- Engine: 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 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.
π― 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
- Analysis (Optional) - Brainstorming, research, product briefs
- Planning (Required) - Scale-adaptive PRD/GDD generation
- Solutioning (Level 3-4) - Adaptive architecture and tech specs
- Implementation (Iterative) - Story creation, context gathering, development, review
- PM - Product planning and requirements
- Analyst - Research and business analysis
- Architect - Technical architecture and design
- Scrum Master - Sprint planning and story management
- Developer - Implementation with senior dev review
- Game Development (Optional) - Game Designer, Game Developer, Game Architect
- And more - UX, Test Architect, and other specialized roles
- π Complete BMM Documentation - Full module reference
- π BMM Workflows Guide - Essential reading for using BMM
BMad Builder (BMB) - 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 | π― Agent Creation Guide
Creative Intelligence Suite (CIS) - 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 | π CIS Workflows
- Node.js v20+ (Download)
Install BMad to your project using npx:
# Install v6 Alpha (this version)
npx bmad-method@alpha install
# Install stable v4 (production-ready)
npx bmad-method installThe interactive installer will guide you through:
- Project location - Where to install BMad
- Module selection - Choose which modules you need (BMM, BMB, CIS)
- Configuration - Set your name, language preferences, and module options
- Game Development (Optional): When installing BMM, you can optionally include game development agents and workflow!
- IDE integration - Configure your development environment
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
After installation, activate the Analyst agent in your IDE and run:
/workflow-initOr 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.
- 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
The installer automatically:
- Detects and migrates v4 installations
- Configures IDE integrations
- Resolves module dependencies
- Sets up agent customization templates
- Creates unified agent manifests
Everything in one place - no more scattered configuration folders. Clean, organized, maintainable.
- v4 to v6 Upgrade Guide - Migration instructions for v4 users
- CLI Tool Guide - Installer and bundler reference
- Contributing Guide - How to contribute to BMad
- π¬ Discord - Get help, share ideas, and collaborate
- π Issues - Report bugs and request features
- π₯ YouTube - Tutorials and updates
- β Star this repo - Get notified of updates
We welcome contributions! See CONTRIBUTING.md for guidelines.
MIT License - See LICENSE for details.
Trademark Notice: BMADβ’ and BMAD-METHODβ’ are trademarks of BMad Code, LLC. All rights reserved.
Built with β€οΈ for the human-AI collaboration community