Enhanced BMAD Method documentation to reflect all V4 features and capabilities: Documentation Updates: - docs/versions.md: Added V4 feature list including Memory Bank, ADRs, dev journals, scaffolding preferences, enhanced agents, and session protocols - docs/core-architecture.md: Added comprehensive sections for Memory Bank Architecture, ADR System, Development Journal System, and Project Scaffolding Standards - README.md: Enhanced overview with new key innovations (Memory Bank Pattern, ADRs) and added navigation links to new guides - docs/GUIDING-PRINCIPLES.md: Added new principle for Context Persistence and Knowledge Management - docs/expansion-packs.md: Updated template guidance for YAML specification and enhanced AI Agent Ecosystems integration New Comprehensive Guides: - docs/memory-bank-guide.md: Complete guide to Memory Bank pattern with structure, usage, best practices, and integration points - docs/adr-guide.md: Comprehensive ADR guide covering creation, maintenance, governance, and workflow integration - docs/project-scaffolding-guide.md: Detailed guide to standardized project structures and organizational patterns Framework Integration Updates: - CLAUDE.md: Updated to reflect all V4 enhancements including new architecture components, enhanced agent capabilities, key data files, and practical guidance for V4 features Key Features Documented: - Memory Bank pattern for persistent AI context across sessions - Architecture Decision Records (ADRs) for comprehensive decision tracking - Development Journal system for session documentation and progress tracking - Project scaffolding preferences for standardized directory structures - Enhanced agent capabilities with session kickoff, comprehensive commit/PR workflows, and sprint reviews - Context persistence systems that eliminate context loss between development sessions This documentation update ensures complete coverage of the enhanced BMAD framework capabilities and provides practical guidance for implementing and using all V4 features. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .github | ||
| .husky | ||
| .vscode | ||
| bmad-core | ||
| common | ||
| dist | ||
| docs | ||
| expansion-packs | ||
| tools | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| .releaserc.json | ||
| CHANGELOG.md | ||
| CLAUDE.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| package-lock.json | ||
| package.json | ||
README.md
BMad-Method: Universal AI Agent Framework
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
Join our Discord Community - 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 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.
3. Memory Bank Pattern: Persistent AI context management across development sessions maintains project understanding, architectural decisions, and development progress, eliminating context loss between sessions.
4. Architecture Decision Records (ADRs): Comprehensive tracking and documentation of technical decisions throughout the project lifecycle, preserving institutional knowledge and decision rationale.
This multi-faceted approach eliminates planning inconsistency, context loss, and decision drift - 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, while the Memory Bank ensures continuity across all development sessions.
📖 See the complete workflow in the User Guide - Planning phase, development cycle, and all agent roles
Quick Navigation
Understanding the BMad Workflow
Before diving in, review these critical workflow diagrams that explain how BMad works:
- Planning Workflow (Web UI) - How to create PRD and Architecture documents
- 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 Instruction
- Learn how to use BMad → Complete user guide and walkthrough
- See available AI agents → Specialized roles for your team
- Memory Bank Guide → Persistent context management
- ADR Guide → Architecture decision documentation
- Project Scaffolding Guide → Standardized project structures
- Explore non-technical uses → Creative writing, business, wellness, education
- Create my own AI agents → Build agents for your domain
- Browse ready-made expansion packs → Game dev, DevOps, infrastructure and get inspired with ideas and examples
- Understand the architecture → Technical deep dive
- Join the community → 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:
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
.bakbackup 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
One Command for Everything (IDE Installation)
Just run one of these commands:
npx bmad-method install
# OR if you already have BMad installed:
git pull
npm run install:bmad
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 v20+ required
Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)
- Get the bundle: Save or clone the full stack team file or choose another team
- Create AI agent: Create a new Gemini Gem or CustomGPT
- Upload & configure: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
- Start Ideating and Planning: Start chatting! Type
*helpto see available commands or pick an agent like*analystto start right in on creating a brief. - CRITICAL: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
- 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 for more details
Alternative: Clone and Build
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
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 and learn to create your own!
Documentation & Resources
Essential Guides
- 📖 User Guide - Complete walkthrough from project inception to completion
- 🏗️ Core Architecture - Technical deep dive and system design
- 🚀 Expansion Packs Guide - Extend BMad to any domain beyond software development
Support
Contributing
We're excited about contributions and welcome your ideas, improvements, and expansion packs! 🎉
📋 Read CONTRIBUTING.md - Complete guide to contributing, including guidelines, process, and requirements
License
MIT License - see LICENSE for details.
Built with ❤️ for the AI-assisted development community