bmad-method 6.0.0-alpha.10 → 6.0.0-alpha.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/CHANGELOG.md +219 -1105
  2. package/README.md +129 -359
  3. package/docs/custom-agent-installation.md +169 -0
  4. package/{v6-open-items.md → docs/v6-open-items.md} +1 -1
  5. package/package.json +4 -2
  6. package/src/core/resources/excalidraw/README.md +160 -0
  7. package/src/core/resources/excalidraw/library-loader.md +50 -0
  8. package/src/modules/bmb/docs/agent-compilation.md +340 -0
  9. package/src/modules/bmb/docs/agent-menu-patterns.md +524 -0
  10. package/src/modules/bmb/docs/expert-agent-architecture.md +364 -0
  11. package/src/modules/bmb/docs/index.md +55 -0
  12. package/src/modules/bmb/docs/module-agent-architecture.md +367 -0
  13. package/src/modules/bmb/docs/simple-agent-architecture.md +288 -0
  14. package/src/modules/bmb/docs/understanding-agent-types.md +184 -0
  15. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/README.md +242 -0
  16. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md +24 -0
  17. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md +108 -0
  18. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md +46 -0
  19. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md +39 -0
  20. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml +152 -0
  21. package/src/modules/bmb/reference/agents/module-examples/README.md +50 -0
  22. package/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml +53 -0
  23. package/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml +57 -0
  24. package/src/modules/bmb/reference/agents/simple-examples/README.md +223 -0
  25. package/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml +126 -0
  26. package/src/modules/bmb/reference/readme.md +3 -0
  27. package/src/modules/bmb/workflows/create-agent/agent-validation-checklist.md +174 -0
  28. package/src/modules/bmb/workflows/create-agent/brainstorm-context.md +99 -120
  29. package/src/modules/bmb/workflows/create-agent/communication-presets.csv +61 -0
  30. package/src/modules/bmb/workflows/create-agent/instructions.md +126 -65
  31. package/src/modules/bmb/workflows/create-agent/workflow.yaml +19 -12
  32. package/src/modules/bmb/workflows/edit-agent/README.md +174 -47
  33. package/src/modules/bmb/workflows/edit-agent/instructions.md +397 -33
  34. package/src/modules/bmb/workflows/edit-agent/workflow.yaml +24 -8
  35. package/src/modules/bmgd/workflows/4-production/story-context/workflow.yaml +1 -1
  36. package/src/modules/bmm/agents/analyst.agent.yaml +2 -2
  37. package/src/modules/bmm/agents/architect.agent.yaml +10 -2
  38. package/src/modules/bmm/agents/dev.agent.yaml +2 -2
  39. package/src/modules/bmm/agents/pm.agent.yaml +7 -3
  40. package/src/modules/bmm/agents/sm.agent.yaml +2 -2
  41. package/src/modules/bmm/agents/tea.agent.yaml +2 -2
  42. package/src/modules/bmm/agents/tech-writer.agent.yaml +15 -3
  43. package/src/modules/bmm/agents/ux-designer.agent.yaml +6 -2
  44. package/src/modules/bmm/docs/README.md +4 -0
  45. package/src/modules/bmm/docs/images/workflow-method-greenfield.excalidraw +5919 -0
  46. package/src/modules/bmm/docs/images/workflow-method-greenfield.svg +2 -0
  47. package/src/modules/bmm/docs/quick-start.md +6 -0
  48. package/src/modules/bmm/docs/scale-adaptive-system.md +6 -0
  49. package/src/modules/bmm/docs/workflows-implementation.md +10 -0
  50. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +4 -4
  51. package/src/modules/bmm/workflows/{2-plan-workflows → 3-solutioning}/create-epics-and-stories/workflow.yaml +5 -5
  52. package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +1 -1
  53. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-dataflow/instructions.md +7 -8
  54. package/src/modules/bmm/workflows/diagrams/create-dataflow/workflow.yaml +27 -0
  55. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-diagram/instructions.md +9 -10
  56. package/src/modules/bmm/workflows/diagrams/create-diagram/workflow.yaml +27 -0
  57. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-flowchart/instructions.md +4 -5
  58. package/src/modules/bmm/workflows/diagrams/create-flowchart/workflow.yaml +27 -0
  59. package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-wireframe/instructions.md +3 -3
  60. package/src/modules/bmm/workflows/diagrams/create-wireframe/workflow.yaml +27 -0
  61. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +18 -30
  62. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +2 -14
  63. package/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml +2 -14
  64. package/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml +2 -14
  65. package/src/modules/cis/agents/presentation-master.agent.yaml +60 -0
  66. package/tools/cli/commands/agent-install.js +409 -0
  67. package/tools/cli/installers/lib/core/installer.js +119 -0
  68. package/tools/cli/installers/lib/ide/_base-ide.js +25 -0
  69. package/tools/cli/installers/lib/ide/antigravity.js +463 -0
  70. package/tools/cli/installers/lib/ide/claude-code.js +43 -0
  71. package/tools/cli/installers/lib/ide/codex.js +217 -32
  72. package/tools/cli/installers/lib/ide/cursor.js +48 -0
  73. package/tools/cli/installers/lib/ide/github-copilot.js +74 -0
  74. package/tools/cli/installers/lib/ide/manager.js +35 -0
  75. package/tools/cli/installers/lib/ide/opencode.js +45 -0
  76. package/tools/cli/installers/lib/ide/windsurf.js +47 -0
  77. package/tools/cli/lib/agent/compiler.js +390 -0
  78. package/tools/cli/lib/agent/installer.js +725 -0
  79. package/tools/cli/lib/agent/template-engine.js +152 -0
  80. package/docs/installers-bundlers/web-bundler-usage.md +0 -54
  81. package/src/modules/bmb/workflows/create-agent/README.md +0 -203
  82. package/src/modules/bmb/workflows/create-agent/agent-architecture.md +0 -415
  83. package/src/modules/bmb/workflows/create-agent/agent-command-patterns.md +0 -759
  84. package/src/modules/bmb/workflows/create-agent/agent-types.md +0 -292
  85. package/src/modules/bmb/workflows/create-agent/checklist.md +0 -62
  86. package/src/modules/bmb/workflows/create-agent/communication-styles.md +0 -202
  87. package/src/modules/bmb/workflows/edit-agent/checklist.md +0 -112
  88. package/src/modules/bmb/workflows/redoc/README.md +0 -87
  89. package/src/modules/bmb/workflows/redoc/checklist.md +0 -99
  90. package/src/modules/bmb/workflows/redoc/instructions.md +0 -265
  91. package/src/modules/bmb/workflows/redoc/workflow.yaml +0 -34
  92. package/src/modules/bmm/agents/frame-expert.agent.yaml +0 -42
  93. package/src/modules/bmm/workflows/frame-expert/create-dataflow/workflow.yaml +0 -24
  94. package/src/modules/bmm/workflows/frame-expert/create-diagram/workflow.yaml +0 -25
  95. package/src/modules/bmm/workflows/frame-expert/create-flowchart/workflow.yaml +0 -28
  96. package/src/modules/bmm/workflows/frame-expert/create-wireframe/workflow.yaml +0 -24
  97. package/src/modules/bmm/workflows/workflow-status/paths/game-design.yaml +0 -52
  98. /package/src/{modules/bmm/workflows/frame-expert/_shared → core/resources/excalidraw}/excalidraw-helpers.md +0 -0
  99. /package/src/{modules/bmm/workflows/frame-expert/_shared → core/resources/excalidraw}/validate-json-instructions.md +0 -0
  100. /package/src/modules/bmm/workflows/{2-plan-workflows → 3-solutioning}/create-epics-and-stories/epics-template.md +0 -0
  101. /package/src/modules/bmm/workflows/{2-plan-workflows → 3-solutioning}/create-epics-and-stories/instructions.md +0 -0
  102. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/_shared/excalidraw-library.json +0 -0
  103. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/_shared/excalidraw-templates.yaml +0 -0
  104. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-dataflow/checklist.md +0 -0
  105. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-diagram/checklist.md +0 -0
  106. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-flowchart/checklist.md +0 -0
  107. /package/src/modules/bmm/workflows/{frame-expert → diagrams}/create-wireframe/checklist.md +0 -0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # BMad CORE + BMad Method
1
+ # BMad Method & BMad Core
2
2
 
3
3
  [![Stable Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=stable)](https://www.npmjs.com/package/bmad-method)
4
4
  [![Alpha Version](https://img.shields.io/npm/v/bmad-method/alpha?color=orange&label=alpha)](https://www.npmjs.com/package/bmad-method)
@@ -6,437 +6,207 @@
6
6
  [![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
7
7
  [![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
8
8
 
9
- > **🚨 Alpha Version Notice**
10
- >
11
- > v6-alpha is near-beta quality—stable and vastly improved over v4, but documentation is still being refined. New videos coming soon to the [BMadCode YouTube channel](https://www.youtube.com/@BMadCode)—subscribe for updates! (There is no v5).
12
- >
13
- > **Getting Started:**
14
- >
15
- > - **Install v6 Alpha:** `npx bmad-method install`
16
- > - **Install stable v4:** `npx bmad-method@latest install`
17
- > - **Not sure what to do?** Load any agent and run `*workflow-init` for guided setup
18
- > - **v4 Users:** [View v4 documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4) or [upgrade guide](./docs/v4-to-v6-upgrade.md)
19
-
20
- ## Universal Human-AI Collaboration Platform
21
-
22
- **BMad-CORE** (**C**ollaboration **O**ptimized **R**eflection **E**ngine) amplifies human potential through specialized AI agents. Unlike tools that replace thinking, BMad-CORE guides reflective workflows that bring out your best ideas and AI's full capabilities.
23
-
24
- The **BMad-CORE** powers the **BMad Method** (probably why you're here!), but you can also use **BMad Builder** to create custom agents, workflows, and modules for any domain—software development, business strategy, creativity, learning, and more.
25
-
26
- **🎯 Human Amplification** • **🎨 Domain Agnostic** • **⚡ Agent-Powered**
27
-
28
- ## Table of Contents
29
-
30
- - [BMad CORE + BMad Method](#bmad-core--bmad-method)
31
- - [Universal Human-AI Collaboration Platform](#universal-human-ai-collaboration-platform)
32
- - [Table of Contents](#table-of-contents)
33
- - [What is BMad-CORE?](#what-is-bmad-core)
34
- - [v6 Core Enhancements](#v6-core-enhancements)
35
- - [C.O.R.E. Philosophy](#core-philosophy)
36
- - [Modules](#modules)
37
- - [BMad Method (BMM) - AI-Driven Agile Development](#bmad-method-bmm---ai-driven-agile-development)
38
- - [v6 Highlights](#v6-highlights)
39
- - [🚀 Quick Start](#-quick-start)
40
- - [BMad Builder (BMB) - Create Custom Solutions](#bmad-builder-bmb---create-custom-solutions)
41
- - [Creative Intelligence Suite (CIS) - Innovation \& Creativity](#creative-intelligence-suite-cis---innovation--creativity)
42
- - [Installation](#installation)
43
- - [🎯 Working with Agents \& Commands](#-working-with-agents--commands)
44
- - [Method 1: Agent Menu (Recommended for Beginners)](#method-1-agent-menu-recommended-for-beginners)
45
- - [Method 2: Direct Slash Commands](#method-2-direct-slash-commands)
46
- - [Method 3: Party Mode Execution](#method-3-party-mode-execution)
47
- - [Key Features](#key-features)
48
- - [🎨 Update-Safe Customization](#-update-safe-customization)
49
- - [🚀 Intelligent Installation](#-intelligent-installation)
50
- - [📁 Clean Architecture](#-clean-architecture)
51
- - [📄 Document Sharding (Advanced)](#-document-sharding-advanced)
52
- - [Documentation](#documentation)
53
- - [Community \& Support](#community--support)
54
- - [Development \& Quality Checks](#development--quality-checks)
55
- - [Testing \& Validation](#testing--validation)
56
- - [Code Quality](#code-quality)
57
- - [Build \& Development](#build--development)
58
- - [Contributing](#contributing)
59
- - [License](#license)
9
+ ## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
60
10
 
61
- ---
62
-
63
- ## What is BMad-CORE?
64
-
65
- Foundation framework powering all BMad modules:
66
-
67
- - **Agent Orchestration** - Specialized AI personas with domain expertise
68
- - **Workflow Engine** - Guided multi-step processes with built-in best practices
69
- - **Modular Architecture** - Extend with domain-specific modules (BMM, BMB, CIS, custom)
70
- - **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code, and more
71
- - **Update-Safe Customization** - Your configs persist through all updates
72
-
73
- ### v6 Core Enhancements
74
-
75
- - **🎨 Agent Customization** - Modify names, roles, personalities via `{bmad_folder}/_cfg/agents/` **[→ Customization Guide](./docs/agent-customization-guide.md)**
76
- - **🌐 Multi-Language** - Independent language settings for communication and output
77
- - **👤 Personalization** - Agents adapt to your name, skill level, and preferences
78
- - **🔄 Persistent Config** - Customizations survive module updates
79
- - **⚙️ Flexible Settings** - Configure per-module or globally
80
- - **📦 Web Bundles** - Share agents in Gemini Gems and Custom GPTs **[→ Web Bundles Guide](./docs/web-bundles-gemini-gpt-guide.md)**
81
-
82
- ### C.O.R.E. Philosophy
83
-
84
- - **C**ollaboration: Human-AI partnership leveraging complementary strengths
85
- - **O**ptimized: Battle-tested processes for maximum effectiveness
86
- - **R**eflection: Strategic questioning that unlocks breakthrough solutions
87
- - **E**ngine: Framework orchestrating 19+ specialized agents and 50+ workflows
88
-
89
- BMad-CORE doesn't give you answers—it helps you **discover better solutions** through guided reflection.
90
-
91
- ## Modules
11
+ **Build More, Architect Dreams** (BMAD) with **19 specialized AI agents** and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms.
92
12
 
93
- ### BMad Method (BMM) - AI-Driven Agile Development
13
+ > **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6)
94
14
 
95
- Revolutionary AI-driven agile framework for software and game development. Automatically adapts from single bug fixes to enterprise-scale systems.
15
+ > **📌 v6 Alpha Status:** Near-beta quality with vastly improved stability. Documentation is being finalized. New videos coming soon to [BMadCode YouTube](https://www.youtube.com/@BMadCode).
96
16
 
97
- #### v6 Highlights
17
+ ## 🎯 Why BMad Method?
98
18
 
99
- **🎯 Scale-Adaptive Intelligence (3 Planning Tracks)**
19
+ Unlike generic AI coding assistants, BMad Method provides **structured, battle-tested workflows** powered by specialized agents who understand agile development. Each agent has deep domain expertise—from product management to architecture to testing—working together seamlessly.
100
20
 
101
- Automatically adjusts planning depth and documentation based on project needs:
21
+ **✨ Key Benefits:**
102
22
 
103
- - **Quick Flow Track:** Fast implementation (tech-spec only) - bug fixes, small features, clear scope
104
- - **BMad Method Track:** Full planning (PRD + Architecture + UX) - products, platforms, complex features
105
- - **Enterprise Method Track:** Extended planning (BMad Method + Security/DevOps/Test) - enterprise requirements, compliance
23
+ - **Scale-Adaptive Intelligence** - Automatically adjusts planning depth from bug fixes to enterprise systems
24
+ - **Complete Development Lifecycle** - Analysis Planning Architecture Implementation
25
+ - **Specialized Expertise** - 19 agents with specific roles (PM, Architect, Developer, UX Designer, etc.)
26
+ - **Proven Methodologies** - Built on agile best practices with AI amplification
27
+ - **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code
106
28
 
107
- **🏗️ Four-Phase Methodology**
29
+ ## 🏗️ The Power of BMad Core
108
30
 
109
- 1. **Phase 1: Analysis** (Optional) - Brainstorming, research, product briefs
110
- 2. **Phase 2: Planning** (Required) - Scale-adaptive PRD/tech-spec/GDD
111
- 3. **Phase 3: Solutioning** (Track-dependent) - Architecture, (Coming soon: security, DevOps, test strategy)
112
- 4. **Phase 4: Implementation** (Iterative) - Story-centric development with just-in-time context
31
+ **BMad Method** is actually a sophisticated module built on top of **BMad Core** (**C**ollaboration **O**ptimized **R**eflection **E**ngine). This revolutionary architecture means:
113
32
 
114
- **🤖 12 Specialized Agents**
33
+ - **BMad Core** provides the universal framework for human-AI collaboration
34
+ - **BMad Method** leverages Core to deliver agile development workflows
35
+ - **BMad Builder** lets YOU create custom modules as powerful as BMad Method itself
115
36
 
116
- PM Analyst Architect Scrum Master Developer Test Architect (TEA) UX Designer Technical Writer Game Designer Game Developer Game Architect BMad Master (Orchestrator)
37
+ With **BMad Builder**, you can architect both simple agents and vastly complex domain-specific modules (legal, medical, finance, education, creative) that will soon be sharable in an **official community marketplace**. Imagine building and sharing your own specialized AI team!
117
38
 
118
- **📚 Documentation**
39
+ ## 📊 See It In Action
119
40
 
120
- - **[Complete Documentation Hub](./src/modules/bmm/docs/README.md)** - Start here for all BMM guides
121
- - **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - Get building in 15 minutes
122
- - **[Agents Guide](./src/modules/bmm/docs/agents-guide.md)** - Meet all 12 agents (45 min read)
123
- - **[34 Workflow Guides](./src/modules/bmm/docs/README.md#-workflow-guides)** - Complete phase-by-phase reference
124
- - **[BMM Module Overview](./src/modules/bmm/README.md)** - Module structure and quick links
41
+ <p align="center">
42
+ <img src="./src/modules/bmm/docs/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
43
+ </p>
125
44
 
126
- ---
127
-
128
- ## 🚀 Quick Start
129
-
130
- **After installation** (see [Installation](#installation) below), choose your path:
131
-
132
- **Three Planning Tracks:**
133
-
134
- 1. **⚡ Quick Flow Track** - Bug fixes and small features
135
- - 🐛 Bug fixes in minutes
136
- - ✨ Small features (2-3 related changes)
137
- - 🚀 Rapid prototyping
138
- - **[→ Quick Spec Flow Guide](./src/modules/bmm/docs/quick-spec-flow.md)**
139
-
140
- 2. **📋 BMad Method Track** - Products and platforms
141
- - Complete planning (PRD/GDD)
142
- - Architecture decisions
143
- - Story-centric implementation
144
- - **[→ Complete Quick Start Guide](./src/modules/bmm/docs/quick-start.md)**
145
-
146
- 3. **🏢 Brownfield Projects** - Add to existing codebases
147
- - Document existing code first
148
- - Then choose Quick Flow or BMad Method
149
- - **[→ Brownfield Guide](./src/modules/bmm/docs/brownfield-guide.md)**
150
-
151
- **Not sure which path?** Run `*workflow-init` and let BMM analyze your project goal and recommend the right track.
152
-
153
- **[📚 Learn More: Scale Adaptive System](./src/modules/bmm/docs/scale-adaptive-system.md)** - How BMM adapts across three planning tracks
154
-
155
- ---
45
+ <p align="center">
46
+ <em>Complete BMad Method workflow showing all phases, agents, and decision points</em>
47
+ </p>
156
48
 
157
- ### BMad Builder (BMB) - Create Custom Solutions
49
+ ## 🚀 Get Started in 3 Steps
158
50
 
159
- Build your own agents, workflows, and modules using the BMad-CORE framework.
160
-
161
- **What You Can Build:**
162
-
163
- - **Custom Agents** - Domain experts with specialized knowledge
164
- - **Guided Workflows** - Multi-step processes for any task
165
- - **Complete Modules** - Full solutions for specific domains
166
- - **Three Agent Types** - Full module, hybrid, or standalone
167
-
168
- **Perfect For:** Creating domain-specific solutions (legal, medical, finance, education, creative, etc.) or extending BMM with custom development workflows.
169
-
170
- **Documentation:**
171
-
172
- - **[BMB Module Overview](./src/modules/bmb/README.md)** - Complete reference
173
- - **[Create Agent Workflow](./src/modules/bmb/workflows/create-agent/README.md)** - Build custom agents
174
- - **[Create Workflow](./src/modules/bmb/workflows/create-workflow/README.md)** - Design guided processes
175
- - **[Create Module](./src/modules/bmb/workflows/create-module/README.md)** - Package complete solutions
176
-
177
- ### Creative Intelligence Suite (CIS) - Innovation & Creativity
178
-
179
- AI-powered creative facilitation using proven methodologies and techniques.
180
-
181
- **5 Interactive Workflows:**
182
-
183
- - **Brainstorming** - Generate and refine ideas with 30+ techniques
184
- - **Design Thinking** - Human-centered problem solving
185
- - **Problem Solving** - Systematic breakthrough techniques
186
- - **Innovation Strategy** - Disruptive business model thinking
187
- - **Storytelling** - Compelling narrative frameworks
188
-
189
- **5 Specialized Agents:** Each with unique facilitation styles and domain expertise
190
-
191
- **Shared Resource:** CIS workflows are used by other modules (BMM's `brainstorm-project` uses CIS brainstorming)
192
-
193
- **Documentation:**
194
-
195
- - **[CIS Module Overview](./src/modules/cis/README.md)** - Complete reference
196
- - **[CIS Workflows Guide](./src/modules/cis/workflows/README.md)** - All 5 creative workflows
197
-
198
- ---
199
-
200
- ## Installation
201
-
202
- **Prerequisites:** Node.js v20+ ([Download](https://nodejs.org))
51
+ ### 1. Install BMad Method
203
52
 
204
53
  ```bash
205
- # v6 Alpha (recommended for new projects)
54
+ # Install v6 Alpha (recommended)
206
55
  npx bmad-method@alpha install
207
56
 
208
- # Stable v4 (production)
57
+ # Or stable v4 for production
209
58
  npx bmad-method install
210
59
  ```
211
60
 
212
- The installer provides:
213
-
214
- 1. **Module Selection** - Choose BMM, BMB, CIS (or all)
215
- 2. **Configuration** - Your name, language preferences, game dev options
216
- 3. **IDE Integration** - Automatic setup for your IDE
61
+ ### 2. Initialize Your Project
217
62
 
218
- **Installation creates:**
63
+ Load any agent in your IDE and run:
219
64
 
220
65
  ```
221
- your-project/
222
- └── {bmad_folder}/
223
- ├── core/ # Core framework + BMad Master agent
224
- ├── bmm/ # BMad Method (12 agents, 34 workflows)
225
- ├── bmb/ # BMad Builder (1 agent, 7 workflows)
226
- ├── cis/ # Creative Intelligence (5 agents, 5 workflows)
227
- └── _cfg/ # Your customizations (survives updates)
228
- └── agents/ # Agent customization files
66
+ *workflow-init
229
67
  ```
230
68
 
231
- **Next Steps:**
69
+ This analyzes your project and recommends the right workflow track.
232
70
 
233
- 1. Load any agent in your IDE
234
- 2. Run `*workflow-init` to set up your project workflow path
235
- 3. Follow the [Quick Start](#-quick-start) guide above to choose your planning track
71
+ ### 3. Choose Your Track
236
72
 
237
- **Alternative:** [**Web Bundles**](https://bmad-code-org.github.io/bmad-bundles/) - Download pre-built agent bundles for use in Claude Projects, ChatGPT, or Gemini without installation (automatically updated on every commit to main)
73
+ BMad Method adapts to your needs with three intelligent tracks:
238
74
 
239
- ---
75
+ | Track | Use For | Planning | Time to Start |
76
+ | ------------------ | ------------------------- | ----------------------- | ------------- |
77
+ | **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes |
78
+ | **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes |
79
+ | **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes |
240
80
 
241
- ## 🎯 Working with Agents & Commands
81
+ > **Not sure?** Run `*workflow-init` and let BMad analyze your project goal.
242
82
 
243
- **Multiple Ways to Execute Workflows:**
83
+ ## 🔄 How It Works: 4-Phase Methodology
244
84
 
245
- BMad is flexible - you can execute workflows in several ways depending on your preference and IDE:
85
+ BMad Method guides you through a proven development lifecycle:
246
86
 
247
- ### Method 1: Agent Menu (Recommended for Beginners)
87
+ 1. **📊 Analysis** (Optional) - Brainstorm, research, and explore solutions
88
+ 2. **📝 Planning** - Create PRDs, tech specs, or game design documents
89
+ 3. **🏗️ Solutioning** - Design architecture, UX, and technical approach
90
+ 4. **⚡ Implementation** - Story-driven development with continuous validation
248
91
 
249
- 1. **Load an agent** in your IDE (see [IDE-specific instructions](./docs/ide-info/))
250
- 2. **Wait for the menu** to appear showing available workflows
251
- 3. **Tell the agent** what to run using natural language or shortcuts:
252
- - Natural: "Run workflow-init"
253
- - Shortcut: `*workflow-init`
254
- - Menu number: "Run option 2"
92
+ Each phase has specialized workflows and agents working together to deliver exceptional results.
255
93
 
256
- ### Method 2: Direct Slash Commands
94
+ ## 🤖 Meet Your Team
257
95
 
258
- **Execute workflows directly** using slash commands:
96
+ **12 Specialized Agents** working in concert:
259
97
 
260
- ```
261
- /bmad:bmm:workflows:workflow-init
262
- /bmad:bmm:workflows:prd
263
- /bmad:bmm:workflows:dev-story
264
- ```
98
+ | Development | Architecture | Product | Leadership |
99
+ | ----------- | -------------- | ------------- | -------------- |
100
+ | Developer | Architect | PM | Scrum Master |
101
+ | UX Designer | Test Architect | Analyst | BMad Master |
102
+ | Tech Writer | Game Architect | Game Designer | Game Developer |
265
103
 
266
- **Tip:** While you can run these without loading an agent first, **loading an agent is still recommended** - it can make a difference with certain workflows.
104
+ Each agent brings deep expertise and can be customized to match your team's style.
267
105
 
268
- **Benefits:**
106
+ ## 📦 What's Included
269
107
 
270
- - Mix and match any agent with any workflow
271
- - ✅ Run workflows not in the loaded agent's menu
272
- - ✅ Faster access for experienced users who know the command names
108
+ ### Core Modules
273
109
 
274
- ### Method 3: Party Mode Execution
110
+ - **BMad Method (BMM)** - Complete agile development framework
111
+ - 12 specialized agents
112
+ - 34 workflows across 4 phases
113
+ - Scale-adaptive planning
114
+ - [→ Documentation Hub](./src/modules/bmm/docs/README.md)
275
115
 
276
- **Run workflows with multi-agent collaboration:**
116
+ - **BMad Builder (BMB)** - Create custom agents and workflows
117
+ - Build anything from simple agents to complex modules
118
+ - Create domain-specific solutions (legal, medical, finance, education)
119
+ - Share your creations in the upcoming community marketplace
120
+ - [→ Builder Guide](./src/modules/bmb/README.md)
277
121
 
278
- 1. Start party mode: `/bmad:core:workflows:party-mode`
279
- 2. Execute any workflow - **the entire team collaborates on it**
280
- 3. Get diverse perspectives from multiple specialized agents
122
+ - **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
123
+ - Brainstorming, design thinking, storytelling
124
+ - 5 creative facilitation workflows
125
+ - [→ Creative Workflows](./src/modules/cis/README.md)
281
126
 
282
- **Perfect for:** Strategic decisions, complex workflows, cross-functional tasks
127
+ ### Key Features
283
128
 
284
- ---
285
-
286
- > **📌 IDE-Specific Note:**
287
- >
288
- > Slash command format varies by IDE:
289
- >
290
- > - **Claude Code:** `/bmad:bmm:workflows:prd`
291
- > - **Cursor/Windsurf:** May use different syntax - check your IDE's [documentation](./docs/ide-info/)
292
- > - **VS Code with Copilot Chat:** Syntax may differ
293
- >
294
- > See **[IDE Integration Guides](./docs/ide-info/)** for your specific IDE's command format.
295
-
296
- ---
297
-
298
- ## Key Features
299
-
300
- ### 🎨 Update-Safe Customization
301
-
302
- Modify agents without touching core files:
303
-
304
- - Override agent names, personalities, expertise via `{bmad_folder}/_cfg/agents/`
305
- - Customizations persist through all updates
306
- - Multi-language support (communication + output)
307
- - Module-level or global configuration
308
-
309
- ### 🚀 Intelligent Installation
310
-
311
- Smart setup that adapts to your environment:
312
-
313
- - Auto-detects v4 installations for smooth upgrades
314
- - Configures IDE integrations (Claude Code, Cursor, Windsurf, VS Code)
315
- - Resolves cross-module dependencies
316
- - Generates unified agent/workflow manifests
317
-
318
- ### 📁 Clean Architecture
319
-
320
- Everything in one place:
321
-
322
- - Single `{bmad_folder}/` folder (no scattered files, default folder name is .bmad)
323
- - Modules live side-by-side (core, bmm, bmb, cis)
324
- - Your configs in `_cfg/` (survives updates)
325
- - Easy to version control or exclude
326
-
327
- ### 📄 Document Sharding (Advanced)
328
-
329
- Optional optimization for large projects (BMad Method and Enterprise tracks):
330
-
331
- - **Massive Token Savings** - Phase 4 workflows load only needed sections (90%+ reduction)
332
- - **Automatic Support** - All workflows handle whole or sharded documents seamlessly
333
- - **Easy Setup** - Built-in tool splits documents by headings
334
- - **Smart Discovery** - Workflows auto-detect format
335
-
336
- **[→ Document Sharding Guide](./docs/document-sharding-guide.md)**
337
-
338
- ---
339
-
340
- ## Documentation
129
+ - **🎨 Customizable Agents** - Modify personalities, expertise, and communication styles
130
+ - **🌐 Multi-Language Support** - Separate settings for communication and code output
131
+ - **📄 Document Sharding** - 90% token savings for large projects
132
+ - **🔄 Update-Safe** - Your customizations persist through updates
133
+ - **🚀 Web Bundles** - Use in ChatGPT, Claude Projects, or Gemini Gems
341
134
 
342
- **Module Documentation:**
135
+ ## 📚 Documentation
343
136
 
344
- - **[BMM Complete Documentation Hub](./src/modules/bmm/docs/README.md)** - All BMM guides, FAQs, troubleshooting
345
- - **[BMB Module Reference](./src/modules/bmb/README.md)** - Build custom agents and workflows
346
- - **[CIS Workflows Guide](./src/modules/cis/workflows/README.md)** - Creative facilitation workflows
137
+ ### Quick Links
347
138
 
348
- **Customization & Sharing:**
139
+ - **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
140
+ - **[Complete BMM Documentation](./src/modules/bmm/docs/README.md)** - All guides and references
141
+ - **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents
142
+ - **[All Documentation](./docs/index.md)** - Complete documentation index
349
143
 
350
- - **[Agent Customization Guide](./docs/agent-customization-guide.md)** - Customize agent names, personas, and behaviors
351
- - **[Web Bundles for Gemini & GPT](./docs/web-bundles-gemini-gpt-guide.md)** - Use BMad agents in Gemini Gems and Custom GPTs
144
+ ### For v4 Users
352
145
 
353
- **Additional Resources:**
146
+ - **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)**
147
+ - **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)**
354
148
 
355
- - **[Documentation Index](./docs/index.md)** - All project documentation
356
- - **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Migration instructions
357
- - **[CLI Tool Guide](./tools/cli/README.md)** - Installer and build tool reference
358
- - **[Contributing Guide](./CONTRIBUTING.md)** - How to contribute
149
+ ## 💬 Community & Support
359
150
 
360
- ---
361
-
362
- ## Community & Support
363
-
364
- - 💬 **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects (#general-dev, #bugs-issues)
365
- - 🐛 **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
366
- - 🎥 **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
367
- - ⭐ **[Star this repo](https://github.com/bmad-code-org/BMAD-METHOD)** - Stay updated on releases
368
-
369
- ---
370
-
371
- ## Development & Quality Checks
151
+ - **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
152
+ - **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
153
+ - **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
154
+ - **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles
372
155
 
373
- **For contributors working on the BMAD codebase:**
156
+ ## 🛠️ Development
374
157
 
375
- **Requirements:** Node.js 22+ (see `.nvmrc`). Run `nvm use` to switch to the correct version.
376
-
377
- ### Testing & Validation
158
+ For contributors working on the BMad codebase:
378
159
 
379
160
  ```bash
380
- # Run all quality checks (comprehensive - use before pushing)
161
+ # Run all quality checks
381
162
  npm test
382
163
 
383
- # Individual test suites
384
- npm run test:schemas # Agent schema validation (fixture-based)
385
- npm run test:install # Installation component tests (compilation)
386
- npm run validate:schemas # YAML schema validation
387
- npm run validate:bundles # Web bundle integrity
164
+ # Development commands
165
+ npm run lint # Check code style
166
+ npm run format:fix # Auto-format code
167
+ npm run bundle # Build web bundles
388
168
  ```
389
169
 
390
- ### Code Quality
391
-
392
- ```bash
393
- # Lint check
394
- npm run lint
170
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
395
171
 
396
- # Auto-fix linting issues
397
- npm run lint:fix
172
+ ## What's New in v6
398
173
 
399
- # Format check
400
- npm run format:check
401
-
402
- # Auto-format all files
403
- npm run format:fix
404
- ```
174
+ **v6 represents a complete architectural revolution from v4:**
405
175
 
406
- ### Build & Development
176
+ ### 🚀 Major Upgrades
407
177
 
408
- ```bash
409
- # Bundle for web deployment
410
- npm run bundle
411
-
412
- # Test local installation
413
- npm run install:bmad
414
- ```
415
-
416
- **Pre-commit Hook:** Auto-fixes changed files (lint-staged) + validates everything (npm test)
417
- **CI:** GitHub Actions runs all quality checks in parallel on every PR
418
-
419
- ---
420
-
421
- ## Contributing
422
-
423
- We welcome contributions! See **[CONTRIBUTING.md](CONTRIBUTING.md)** for:
178
+ - **BMad Core Framework** - Modular architecture enabling custom domain solutions
179
+ - **Scale-Adaptive Intelligence** - Automatic adjustment from bug fixes to enterprise
180
+ - **Visual Workflows** - Beautiful SVG diagrams showing complete methodology
181
+ - **BMad Builder Module** - Create and share your own AI agent teams
182
+ - **50+ Workflows** - Up from 20 in v4, covering every development scenario
183
+ - **19 Specialized Agents** - Enhanced with customizable personalities and expertise
184
+ - **Update-Safe Customization** - Your configs persist through all updates
185
+ - **Web Bundles** - Use agents in ChatGPT, Claude, and Gemini
186
+ - **Multi-Language Support** - Separate settings for communication and code
187
+ - **Document Sharding** - 90% token savings for large projects
424
188
 
425
- - Code contribution guidelines
426
- - Documentation improvements
427
- - Module development
428
- - Issue reporting
189
+ ### 🔄 For v4 Users
429
190
 
430
- ---
191
+ - **[Comprehensive Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Step-by-step migration
192
+ - **[v4 Documentation Archive](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)** - Legacy reference
193
+ - Backwards compatibility where possible
194
+ - Smooth migration path with installer detection
431
195
 
432
- ## License
196
+ ## 📄 License
433
197
 
434
- **MIT License** - See [LICENSE](LICENSE) for details
198
+ MIT License - See [LICENSE](LICENSE) for details.
435
199
 
436
200
  **Trademarks:** BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
437
201
 
438
202
  ---
439
203
 
440
- [![Contributors](https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD)](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
204
+ <p align="center">
205
+ <a href="https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors">
206
+ <img src="https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD" alt="Contributors">
207
+ </a>
208
+ </p>
441
209
 
442
- <sub>Built with ❤️ for the human-AI collaboration community</sub>
210
+ <p align="center">
211
+ <sub>Built with ❤️ for the human-AI collaboration community</sub>
212
+ </p>