bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.3

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 (47) hide show
  1. package/.claude/settings.local.json +11 -1
  2. package/README.md +109 -161
  3. package/docs/BMad-Method-V6-Quick-Start.md +341 -0
  4. package/docs/index.md +229 -0
  5. package/docs/v4-to-v6-upgrade.md +9 -7
  6. package/package.json +1 -1
  7. package/src/modules/bmb/README.md +135 -73
  8. package/src/modules/bmb/workflows/create-agent/README.md +126 -243
  9. package/src/modules/bmb/workflows/create-agent/instructions.md +25 -12
  10. package/src/modules/bmb/workflows/create-module/README.md +163 -154
  11. package/src/modules/bmb/workflows/create-workflow/instructions.md +16 -8
  12. package/src/modules/bmm/README.md +86 -83
  13. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +45 -26
  14. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/README.md +100 -16
  15. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +42 -23
  16. package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +42 -28
  17. package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +38 -27
  18. package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +24 -34
  19. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +23 -34
  20. package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +30 -14
  21. package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +23 -34
  22. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +42 -24
  23. package/src/modules/bmm/workflows/2-plan-workflows/gdd/instructions-gdd.md +35 -22
  24. package/src/modules/bmm/workflows/2-plan-workflows/narrative/instructions-narrative.md +73 -22
  25. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +45 -63
  26. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +46 -62
  27. package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +46 -53
  28. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +78 -47
  29. package/src/modules/bmm/workflows/4-implementation/create-story/README.md +99 -82
  30. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +2 -0
  31. package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +3 -0
  32. package/src/modules/bmm/workflows/README.md +149 -511
  33. package/src/modules/bmm/workflows/workflow-status/README.md +38 -19
  34. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +117 -24
  35. package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +2 -2
  36. package/src/modules/bmm/workflows/workflow-status/instructions.md +173 -111
  37. package/src/modules/bmm/workflows/workflow-status/sample-level-3-workflow.yaml +49 -0
  38. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +31 -0
  39. package/src/modules/bmm/workflows/workflow-status/workflow.yaml +3 -3
  40. package/src/modules/cis/README.md +153 -0
  41. package/src/modules/cis/workflows/README.md +102 -30
  42. package/src/modules/cis/workflows/storytelling/instructions.md +10 -2
  43. package/tools/cli/installers/lib/core/manifest-generator.js +4 -1
  44. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.md +0 -30
  45. package/src/modules/cis/readme.md +0 -86
  46. /package/src/modules/bmm/sub-modules/claude-code/{readme.md → README.md} +0 -0
  47. /package/src/modules/bmm/workflows/3-solutioning/architecture/{readme.md → README.md} +0 -0
@@ -31,7 +31,17 @@
31
31
  "Bash(git commit:*)",
32
32
  "Bash(.claude/hooks/play-tts.sh:*)",
33
33
  "Bash(while read file)",
34
- "Bash(do echo \"=== $file ===\")"
34
+ "Bash(do echo \"=== $file ===\")",
35
+ "Bash(npm view:*)",
36
+ "Bash(npm dist-tag:*)",
37
+ "Bash(npm cache clean:*)",
38
+ "Bash(npm info:*)",
39
+ "Bash(./node_modules/.bin/bmad-method:*)",
40
+ "Bash(git checkout:*)",
41
+ "Bash(gh pr create:*)",
42
+ "Bash(gh pr view:*)",
43
+ "Bash(mv:*)",
44
+ "Bash(awk:*)"
35
45
  ],
36
46
  "deny": [],
37
47
  "ask": []
package/README.md CHANGED
@@ -7,254 +7,202 @@
7
7
 
8
8
  > **🚨 ALPHA VERSION DOCUMENTATION**
9
9
  >
10
- > This README documents **BMad v6 (Alpha)** - currently under active development.
11
- >
12
- > **To install v6 Alpha:** `npx bmad-method@alpha install`
13
- >
14
- > **Looking for stable v4 documentation?** [View v4 README](https://github.com/bmad-code-org/BMAD-METHOD/tree/v4-stable)
15
- >
16
- > **Want the stable version?** `npx bmad-method install` (installs v4.x)
10
+ > - **Install v6 Alpha:** `npx bmad-method@alpha install`
11
+ > - **Install stable v4:** `npx bmad-method install`
12
+ > - **[View v4 documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)**
17
13
 
18
- ## The Universal Human-AI Collaboration Platform
14
+ ## Universal Human-AI Collaboration Platform
19
15
 
20
- 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.
16
+ 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.
21
17
 
22
- **🎯 Human Amplification, Not Replacement** • **🎨 Works in Any Domain** • **⚡ Powered by Specialized Agents**
18
+ **🎯 Human Amplification** • **🎨 Domain Agnostic** • **⚡ Agent-Powered**
23
19
 
24
- ---
20
+ ## Table of Contents
25
21
 
26
- ## 🔄 Upgrading from v4?
22
+ - [Quick Start](#quick-start)
23
+ - [What is BMad-CORE?](#what-is-bmad-core)
24
+ - [Modules](#modules)
25
+ - [BMad Method (BMM)](#bmad-method-bmm---agile-ai-development)
26
+ - [BMad Builder (BMB)](#bmad-builder-bmb---create-custom-solutions)
27
+ - [Creative Intelligence Suite (CIS)](#creative-intelligence-suite-cis---innovation--creativity)
28
+ - [Installation](#installation)
29
+ - [Key Features](#key-features)
30
+ - [Documentation](#documentation)
31
+ - [Community & Support](#community--support)
27
32
 
28
- **[→ v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Complete migration instructions for existing v4 users
33
+ ## Quick Start
29
34
 
30
- ---
35
+ - **New to v6?** [→ BMad Method V6 Quick Start Guide](./docs/BMad-Method-V6-Quick-Start.md)
36
+ - **Upgrading?** [→ v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)
31
37
 
32
38
  ## What is BMad-CORE?
33
39
 
34
- BMad-CORE is the **universal foundation** that powers all BMad modules. It provides:
35
-
36
- - **Agent orchestration framework** for specialized AI personas
37
- - **Workflow execution engine** for guided processes
38
- - **Modular architecture** allowing domain-specific extensions
39
- - **IDE integrations** across multiple development environments
40
- - **Update-safe customization system** for all agents and workflows
40
+ Foundation framework powering all BMad modules:
41
41
 
42
- ### Core v6 Framework Enhancements
42
+ - **Agent Orchestration** - Specialized AI personas with unique capabilities
43
+ - **Workflow Engine** - Guided multi-step processes
44
+ - **Modular Architecture** - Domain-specific extensions
45
+ - **IDE Integration** - Works across development environments
46
+ - **Update-Safe Customization** - Persistent configuration through updates
43
47
 
44
- **All modules benefit from these new core capabilities:**
48
+ ### v6 Core Enhancements
45
49
 
46
- - **🎨 Full Agent Customization** - Modify any agent's name, role, personality, and behavior via `bmad/_cfg/agents/` customize files that survive all updates
47
- - **🌐 Multi-Language Support** - Choose your language for both agent communication and documentation output independently
48
- - **👤 User Personalization** - Agents address you by name and adapt to your technical level and preferences
49
- - **🔄 Update-Safe Configuration** - Your customizations persist through framework and module updates
50
- - **⚙️ Flexible Settings** - Configure communication style, technical depth, output formats, and more per module or globally
50
+ - **🎨 Agent Customization** - Modify names, roles, personalities via `bmad/_cfg/agents/`
51
+ - **🌐 Multi-Language** - Independent language settings for communication and output
52
+ - **👤 Personalization** - Agents adapt to your name, technical level, preferences
53
+ - **🔄 Persistent Config** - Customizations survive all updates
54
+ - **⚙️ Flexible Settings** - Module or global configuration options
51
55
 
52
- ### The C.O.R.E. Philosophy
56
+ ### C.O.R.E. Philosophy
53
57
 
54
- - **C**ollaboration: Human-AI partnership where both contribute unique strengths
58
+ - **C**ollaboration: Human-AI partnership leveraging unique strengths
55
59
  - **O**ptimized: Refined processes for maximum effectiveness
56
- - **R**eflection: Guided thinking that unlocks better solutions
57
- - **E**ngine: Powerful framework orchestrating specialized agents and workflows
60
+ - **R**eflection: Guided thinking unlocking better solutions
61
+ - **E**ngine: Framework orchestrating specialized agents and workflows
58
62
 
59
- Instead of giving you answers, BMad-CORE helps you **discover better solutions** through strategic questioning, expert guidance, and structured thinking.
63
+ BMad-CORE helps you **discover better solutions** through strategic questioning and structured thinking.
60
64
 
61
- ---
65
+ ## Modules
62
66
 
63
- ## The BMad Method - Agile AI-Driven Development
67
+ ### BMad Method (BMM) - Agile AI Development
64
68
 
65
- **The flagship module for software and game development excellence.**
69
+ AI-driven agile framework revolutionizing software and game development. Adapts from bug fixes to enterprise systems.
66
70
 
67
- 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.
71
+ #### v6 Highlights
68
72
 
69
- ### What's New in v6?
73
+ **🎯 Scale-Adaptive Workflows (Levels 0-4)**
70
74
 
71
- **🎯 Revolutionary Scale-Adaptive Workflows**
72
-
73
- - **Levels 0-4**: Automatically adjusts from quick fixes to enterprise-scale projects
74
- - **Greenfield & Brownfield**: Full support for new projects and existing codebases
75
- - **Smart Context Engine**: New optimized brownfield documentation engine that understands your existing code
75
+ - Automatically adjusts complexity from quick fixes to enterprise projects
76
+ - Greenfield & brownfield support with smart context engine
76
77
 
77
78
  **🏗️ Project-Adaptive Architecture**
78
79
 
79
- - Architecture documents that adapt to YOUR project type (web, mobile, embedded, game, etc.)
80
- - No more "one-size-fits-all" templates
81
- - Specialized sections based on what you're actually building
82
- - Game development fully integrated with engine-specific guidance (Unity, Phaser, Godot, Unreal, and more)
83
-
84
- **⚡ From Simple to Complex - All in One System**
85
-
86
- - **Level 0-1**: Quick fixes and small features with minimal overhead
87
- - **Level 2**: Feature development with lightweight planning
88
- - **Level 3-4**: Full enterprise workflows with comprehensive documentation
89
- - Seamless workflow progression as complexity grows
90
-
91
- **💬 Highly Interactive & Guided**
92
-
93
- - Interactive workflows that ask the right questions
94
- - Agents guide you through discovery rather than giving generic answers
95
- - Context-aware recommendations based on your project state
96
- - Real-time validation and course correction
80
+ - Documents adapt to project type (web, mobile, embedded, game)
81
+ - Engine-specific game development (Unity, Phaser, Godot, Unreal)
97
82
 
98
83
  **📋 Four-Phase Methodology**
99
84
 
100
- 1. **Analysis** (Optional) - Brainstorming, research, product briefs
101
- 2. **Planning** (Required) - Scale-adaptive PRD/GDD generation
102
- 3. **Solutioning** (Level 3-4) - Adaptive architecture and tech specs
103
- 4. **Implementation** (Iterative) - Story creation, context gathering, development, review
104
-
105
- ### Specialized Agents
106
-
107
- - **PM** - Product planning and requirements
108
- - **Analyst** - Research and business analysis
109
- - **Architect** - Technical architecture and design
110
- - **Scrum Master** - Sprint planning and story management
111
- - **Developer** - Implementation with senior dev review
112
- - **Game Development** (Optional) - Game Designer, Game Developer, Game Architect
113
- - **And more** - UX, Test Architect, and other specialized roles
114
-
115
- ### Documentation
116
-
117
- - **[📚 Complete BMM Documentation](./src/modules/bmm/README.md)** - Full module reference
118
- - **[📖 BMM Workflows Guide](./src/modules/bmm/workflows/README.md)** - Essential reading for using BMM
119
-
120
- ---
121
-
122
- ## Additional Beta Modules
85
+ 1. **Analysis** - Brainstorming, research, briefs
86
+ 2. **Planning** - Scale-adaptive PRD/GDD
87
+ 3. **Solutioning** - Architecture and tech specs
88
+ 4. **Implementation** - Stories, development, review
123
89
 
124
- ### **[BMad Builder (BMB)](./src/modules/bmb/README.md)** - Create Custom Solutions
90
+ **Specialized Agents**: PM, Analyst, Architect, Scrum Master, Developer, Game Designer/Developer/Architect, UX, Test Architect
125
91
 
126
- Build your own agents, workflows, and modules using the BMad-CORE framework.
92
+ **Documentation**: [📚 BMM Module](./src/modules/bmm/README.md) | [📖 Workflows Guide](./src/modules/bmm/workflows/README.md)
127
93
 
128
- - **Agent Creation**: Design specialized agents with custom roles and behaviors
129
- - **Workflow Design**: Build structured multi-step processes
130
- - **Module Development**: Package complete solutions for any domain
131
- - **Three Agent Types**: Full module, hybrid, and standalone agents
94
+ ### BMad Builder (BMB) - Create Custom Solutions
132
95
 
133
- **[📚 Complete BMB Documentation](./src/modules/bmb/README.md)** | **[🎯 Agent Creation Guide](./src/modules/bmb/workflows/create-agent/README.md)**
96
+ Build custom agents, workflows, and modules using BMad-CORE framework.
134
97
 
135
- ---
136
-
137
- ### **[Creative Intelligence Suite (CIS)](./src/modules/cis/readme.md)** - Innovation & Creativity
98
+ - **Agent Creation** - Custom roles and behaviors
99
+ - **Workflow Design** - Structured multi-step processes
100
+ - **Module Development** - Complete domain solutions
101
+ - **Three Agent Types** - Full module, hybrid, standalone
138
102
 
139
- Transform creative and strategic thinking through AI-powered facilitation across five specialized domains.
103
+ **Documentation**:
140
104
 
141
- - **5 Interactive Workflows**: Brainstorming, Design Thinking, Problem Solving, Innovation Strategy, Storytelling
142
- - **150+ Creative Techniques**: Proven frameworks and methodologies
143
- - **5 Specialized Agents**: Each with unique personas and facilitation styles
144
- - **Shared Resource**: Powers creative workflows in other modules (e.g., BMM brainstorming)
105
+ - [📚 BMB Module](./src/modules/bmb/README.md) - Complete module reference
106
+ - [🎯 Create Agent](./src/modules/bmb/workflows/create-agent/README.md) - Agent builder workflow
107
+ - [📋 Create Workflow](./src/modules/bmb/workflows/create-workflow/README.md) - Workflow designer
108
+ - [📦 Create Module](./src/modules/bmb/workflows/create-module/README.md) - Module scaffolding
145
109
 
146
- **[📚 Complete CIS Documentation](./src/modules/cis/readme.md)** | **[📖 CIS Workflows](./src/modules/cis/workflows/README.md)**
110
+ ### Creative Intelligence Suite (CIS) - Innovation & Creativity
147
111
 
148
- ---
149
-
150
- ## Quick Start
112
+ AI-powered creative facilitation across five domains.
151
113
 
152
- ### Prerequisites
114
+ - **5 Interactive Workflows** - Brainstorming, Design Thinking, Problem Solving, Innovation Strategy, Storytelling
115
+ - **150+ Creative Techniques** - Proven frameworks and methodologies
116
+ - **5 Specialized Agents** - Unique personas and facilitation styles
117
+ - **Shared Resource** - Powers creative workflows in other modules
153
118
 
154
- - **Node.js v20+** ([Download](https://nodejs.org))
119
+ **Documentation**: [📚 CIS Module](./src/modules/cis/README.md) | [📖 CIS Workflows](./src/modules/cis/workflows/README.md)
155
120
 
156
- ### Installation
121
+ ## Installation
157
122
 
158
- Install BMad to your project using npx:
123
+ **Prerequisites**: Node.js v20+ ([Download](https://nodejs.org))
159
124
 
160
125
  ```bash
161
- # Install v6 Alpha (this version)
126
+ # Install v6 Alpha
162
127
  npx bmad-method@alpha install
163
128
 
164
- # Install stable v4 (production-ready)
129
+ # Install stable v4
165
130
  npx bmad-method install
166
131
  ```
167
132
 
168
- The interactive installer will guide you through:
133
+ Interactive installer guides you through:
169
134
 
170
- 1. **Project location** - Where to install BMad
171
- 2. **Module selection** - Choose which modules you need (BMM, BMB, CIS)
172
- 3. **Configuration** - Set your name, language preferences, and module options
173
- - **Game Development (Optional)**: When installing BMM, you can optionally include game development agents and workflow!
174
- 4. **IDE integration** - Configure your development environment
135
+ 1. **Project location** - Installation directory
136
+ 2. **Module selection** - BMM, BMB, CIS
137
+ 3. **Configuration** - Name, language, game dev options
138
+ 4. **IDE integration** - Environment setup
175
139
 
176
- ### What Gets Installed
177
-
178
- All modules install to a single `bmad/` folder in your project:
140
+ ### Project Structure
179
141
 
180
142
  ```
181
143
  your-project/
182
144
  └── bmad/
183
- ├── core/ # Core framework (always installed)
184
- ├── bmm/ # BMad Method (if selected)
185
- ├── bmb/ # BMad Builder (if selected)
186
- ├── cis/ # Creative Intelligence Suite (shared resources)
145
+ ├── core/ # Core framework
146
+ ├── bmm/ # BMad Method
147
+ ├── bmb/ # BMad Builder
148
+ ├── cis/ # Creative Intelligence
187
149
  └── _cfg/ # Your customizations
188
- └── agents/ # Agent customization files
150
+ └── agents/ # Agent configs
189
151
  ```
190
152
 
191
- ### Getting Started with BMM
153
+ ### Getting Started
192
154
 
193
- After installation, activate the Analyst agent in your IDE and run:
155
+ After installation, activate Analyst agent and run:
194
156
 
195
- ```bash
157
+ ```
196
158
  /workflow-init
197
159
  ```
198
160
 
199
- Or run it directly as a command (command syntax varies by IDE - use slash commands in Claude Code, OpenCode, etc.).
200
-
201
- This sets up the guided workflow system and helps you choose the right starting point for your project based on its complexity.
202
-
203
- ---
161
+ This initializes the workflow system and helps choose your starting point.
204
162
 
205
163
  ## Key Features
206
164
 
207
165
  ### 🎨 Update-Safe Customization
208
166
 
209
- - **Agent Customization**: Modify agents via `bmad/_cfg/agents/` customize files
210
- - **Persistent Settings**: Your customizations survive updates
211
- - **Multi-Language Support**: Agents communicate in your preferred language
212
- - **Flexible Configuration**: Adjust agent names, roles, communication styles, and more
167
+ - Agent modification via `bmad/_cfg/agents/`
168
+ - Persistent settings through updates
169
+ - Multi-language support
170
+ - Flexible configuration
213
171
 
214
172
  ### 🚀 Intelligent Installation
215
173
 
216
- The installer automatically:
217
-
218
- - Detects and migrates v4 installations
174
+ - Auto-detects v4 installations
219
175
  - Configures IDE integrations
220
- - Resolves module dependencies
221
- - Sets up agent customization templates
222
- - Creates unified agent manifests
176
+ - Resolves dependencies
177
+ - Creates unified manifests
223
178
 
224
179
  ### 📁 Unified Architecture
225
180
 
226
- Everything in one place - no more scattered configuration folders. Clean, organized, maintainable.
227
-
228
- ---
229
-
230
- ## Additional Documentation
181
+ Single `bmad/` folder - clean, organized, maintainable.
231
182
 
232
- - **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Migration instructions for v4 users
233
- - **[CLI Tool Guide](./tools/cli/README.md)** - Installer and bundler reference
234
- - **[Contributing Guide](./CONTRIBUTING.md)** - How to contribute to BMad
183
+ ## Documentation
235
184
 
236
- ---
185
+ - **[📚 Documentation Index](./docs/index.md)** - Complete documentation map
186
+ - **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Migration instructions
187
+ - **[CLI Tool Guide](./tools/cli/README.md)** - Installer reference
188
+ - **[Contributing Guide](./CONTRIBUTING.md)** - Contribution guidelines
237
189
 
238
190
  ## Community & Support
239
191
 
240
- - 💬 **[Discord](https://discord.gg/gk8jAdXWmj)** - Get help, share ideas, and collaborate
241
- - 🐛 **[Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs and request features
242
- - 🎥 **[YouTube](https://www.youtube.com/@BMadCode)** - Tutorials and updates
243
- - ⭐ **[Star this repo](https://github.com/bmad-code-org/BMAD-METHOD)** - Get notified of updates
244
-
245
- ---
192
+ - 💬 **[Discord](https://discord.gg/gk8jAdXWmj)** - Community help
193
+ - 🐛 **[Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Bug reports
194
+ - 🎥 **[YouTube](https://www.youtube.com/@BMadCode)** - Tutorials
195
+ - ⭐ **[Star this repo](https://github.com/bmad-code-org/BMAD-METHOD)** - Updates
246
196
 
247
197
  ## Contributing
248
198
 
249
- We welcome contributions! See **[CONTRIBUTING.md](CONTRIBUTING.md)** for guidelines.
250
-
251
- ---
199
+ See **[CONTRIBUTING.md](CONTRIBUTING.md)** for guidelines.
252
200
 
253
201
  ## License
254
202
 
255
- MIT License - See [LICENSE](LICENSE) for details.
203
+ MIT License - See [LICENSE](LICENSE)
256
204
 
257
- **Trademark Notice**: BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.
205
+ **Trademark**: BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
258
206
 
259
207
  ---
260
208