bmad-method 4.37.0-beta.5 → 4.37.0

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 (206) hide show
  1. package/.github/FUNDING.yaml +15 -0
  2. package/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
  3. package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
  4. package/.github/workflows/discord.yaml +16 -0
  5. package/.github/workflows/release.yaml +60 -0
  6. package/.releaserc.json +21 -0
  7. package/.vscode/settings.json +44 -0
  8. package/CHANGELOG.md +707 -0
  9. package/CONTRIBUTING.md +209 -0
  10. package/LICENSE +21 -0
  11. package/README.md +214 -3
  12. package/bmad-core/agent-teams/team-all.yaml +14 -0
  13. package/bmad-core/agent-teams/team-fullstack.yaml +18 -0
  14. package/bmad-core/agent-teams/team-ide-minimal.yaml +10 -0
  15. package/bmad-core/agent-teams/team-no-ui.yaml +13 -0
  16. package/bmad-core/agents/analyst.md +81 -0
  17. package/bmad-core/agents/architect.md +83 -0
  18. package/bmad-core/agents/bmad-master.md +107 -0
  19. package/bmad-core/agents/bmad-orchestrator.md +149 -0
  20. package/bmad-core/agents/dev.md +75 -0
  21. package/bmad-core/agents/pm.md +81 -0
  22. package/bmad-core/agents/po.md +76 -0
  23. package/bmad-core/agents/qa.md +69 -0
  24. package/bmad-core/agents/sm.md +62 -0
  25. package/bmad-core/agents/ux-expert.md +66 -0
  26. package/bmad-core/checklists/architect-checklist.md +438 -0
  27. package/bmad-core/checklists/change-checklist.md +182 -0
  28. package/bmad-core/checklists/pm-checklist.md +370 -0
  29. package/bmad-core/checklists/po-master-checklist.md +432 -0
  30. package/bmad-core/checklists/story-dod-checklist.md +94 -0
  31. package/bmad-core/checklists/story-draft-checklist.md +153 -0
  32. package/bmad-core/core-config.yaml +20 -0
  33. package/bmad-core/data/bmad-kb.md +806 -0
  34. package/bmad-core/data/brainstorming-techniques.md +36 -0
  35. package/bmad-core/data/elicitation-methods.md +154 -0
  36. package/bmad-core/data/technical-preferences.md +3 -0
  37. package/bmad-core/tasks/advanced-elicitation.md +117 -0
  38. package/bmad-core/tasks/brownfield-create-epic.md +160 -0
  39. package/bmad-core/tasks/brownfield-create-story.md +147 -0
  40. package/bmad-core/tasks/correct-course.md +70 -0
  41. package/bmad-core/tasks/create-brownfield-story.md +312 -0
  42. package/bmad-core/tasks/create-deep-research-prompt.md +278 -0
  43. package/bmad-core/tasks/create-next-story.md +112 -0
  44. package/bmad-core/tasks/document-project.md +343 -0
  45. package/bmad-core/tasks/facilitate-brainstorming-session.md +136 -0
  46. package/bmad-core/tasks/generate-ai-frontend-prompt.md +51 -0
  47. package/bmad-core/tasks/index-docs.md +173 -0
  48. package/bmad-core/tasks/kb-mode-interaction.md +75 -0
  49. package/bmad-core/tasks/review-story.md +154 -0
  50. package/bmad-core/tasks/shard-doc.md +185 -0
  51. package/bmad-core/tasks/validate-next-story.md +134 -0
  52. package/bmad-core/templates/architecture-tmpl.yaml +650 -0
  53. package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
  54. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +476 -0
  55. package/bmad-core/templates/brownfield-prd-tmpl.yaml +280 -0
  56. package/bmad-core/templates/competitor-analysis-tmpl.yaml +293 -0
  57. package/bmad-core/templates/front-end-architecture-tmpl.yaml +206 -0
  58. package/bmad-core/templates/front-end-spec-tmpl.yaml +349 -0
  59. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +805 -0
  60. package/bmad-core/templates/market-research-tmpl.yaml +252 -0
  61. package/bmad-core/templates/prd-tmpl.yaml +202 -0
  62. package/bmad-core/templates/project-brief-tmpl.yaml +221 -0
  63. package/bmad-core/templates/story-tmpl.yaml +137 -0
  64. package/bmad-core/workflows/brownfield-fullstack.yaml +297 -0
  65. package/bmad-core/workflows/brownfield-service.yaml +187 -0
  66. package/bmad-core/workflows/brownfield-ui.yaml +197 -0
  67. package/bmad-core/workflows/greenfield-fullstack.yaml +240 -0
  68. package/bmad-core/workflows/greenfield-service.yaml +206 -0
  69. package/bmad-core/workflows/greenfield-ui.yaml +235 -0
  70. package/common/tasks/create-doc.md +101 -0
  71. package/common/tasks/execute-checklist.md +86 -0
  72. package/common/utils/bmad-doc-template.md +325 -0
  73. package/common/utils/workflow-management.md +69 -0
  74. package/dist/agents/analyst.txt +2882 -0
  75. package/dist/agents/architect.txt +3543 -0
  76. package/dist/agents/bmad-master.txt +8756 -0
  77. package/dist/agents/bmad-orchestrator.txt +1490 -0
  78. package/dist/agents/dev.txt +428 -0
  79. package/dist/agents/pm.txt +2229 -0
  80. package/dist/agents/po.txt +1364 -0
  81. package/dist/agents/qa.txt +386 -0
  82. package/dist/agents/sm.txt +668 -0
  83. package/dist/agents/ux-expert.txt +701 -0
  84. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2408 -0
  85. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +1631 -0
  86. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +822 -0
  87. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +10989 -0
  88. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +4047 -0
  89. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +3744 -0
  90. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +465 -0
  91. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +990 -0
  92. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +15467 -0
  93. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +2077 -0
  94. package/dist/teams/team-all.txt +11062 -0
  95. package/dist/teams/team-fullstack.txt +10392 -0
  96. package/dist/teams/team-ide-minimal.txt +3507 -0
  97. package/dist/teams/team-no-ui.txt +8951 -0
  98. package/docs/GUIDING-PRINCIPLES.md +91 -0
  99. package/docs/core-architecture.md +219 -0
  100. package/docs/enhanced-ide-development-workflow.md +43 -0
  101. package/docs/expansion-packs.md +280 -0
  102. package/docs/how-to-contribute-with-pull-requests.md +158 -0
  103. package/docs/user-guide.md +251 -0
  104. package/docs/versioning-and-releases.md +77 -0
  105. package/docs/versions.md +48 -0
  106. package/docs/working-in-the-brownfield.md +364 -0
  107. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +102 -0
  108. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash copy.txt +13 -0
  109. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash.txt +13 -0
  110. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.2 Agent Development Kit Installation/1.2.2 - Basic Project Structure - txt.txt +25 -0
  111. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.1 - settings.py +34 -0
  112. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.2 - main.py - Base Application.py +70 -0
  113. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.4 Deployment Configuration/1.4.2 - cloudbuild.yaml +26 -0
  114. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +109 -0
  115. package/expansion-packs/README.md +3 -0
  116. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +13 -0
  117. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +71 -0
  118. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +78 -0
  119. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +64 -0
  120. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +201 -0
  121. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +160 -0
  122. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +8 -0
  123. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +250 -0
  124. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +649 -0
  125. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +110 -0
  126. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +216 -0
  127. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +290 -0
  128. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +613 -0
  129. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +356 -0
  130. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +343 -0
  131. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +253 -0
  132. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +484 -0
  133. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +183 -0
  134. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +175 -0
  135. package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +14 -0
  136. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +80 -0
  137. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +77 -0
  138. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +78 -0
  139. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +65 -0
  140. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +391 -0
  141. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +203 -0
  142. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +201 -0
  143. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +124 -0
  144. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +6 -0
  145. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +769 -0
  146. package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +586 -0
  147. package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +110 -0
  148. package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +141 -0
  149. package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +184 -0
  150. package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +290 -0
  151. package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +200 -0
  152. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +1030 -0
  153. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +356 -0
  154. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +705 -0
  155. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +256 -0
  156. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +484 -0
  157. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +183 -0
  158. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +175 -0
  159. package/expansion-packs/bmad-infrastructure-devops/README.md +147 -0
  160. package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +71 -0
  161. package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +484 -0
  162. package/expansion-packs/bmad-infrastructure-devops/config.yaml +9 -0
  163. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +305 -0
  164. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +159 -0
  165. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +153 -0
  166. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +424 -0
  167. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +629 -0
  168. package/package.json +62 -24
  169. package/tools/bmad-npx-wrapper.js +39 -0
  170. package/tools/builders/web-builder.js +681 -0
  171. package/tools/bump-all-versions.js +106 -0
  172. package/tools/bump-expansion-version.js +83 -0
  173. package/tools/cli.js +154 -0
  174. package/tools/flattener/aggregate.js +76 -0
  175. package/tools/flattener/binary.js +53 -0
  176. package/tools/flattener/discovery.js +70 -0
  177. package/tools/flattener/files.js +35 -0
  178. package/tools/flattener/ignoreRules.js +176 -0
  179. package/tools/flattener/main.js +217 -0
  180. package/tools/flattener/projectRoot.js +45 -0
  181. package/tools/flattener/prompts.js +44 -0
  182. package/tools/flattener/stats.js +30 -0
  183. package/tools/flattener/xml.js +86 -0
  184. package/tools/installer/README.md +8 -0
  185. package/tools/installer/package.json +44 -0
  186. package/tools/lib/dependency-resolver.js +179 -0
  187. package/tools/lib/yaml-utils.js +29 -0
  188. package/tools/md-assets/web-agent-startup-instructions.md +39 -0
  189. package/tools/semantic-release-sync-installer.js +30 -0
  190. package/tools/shared/bannerArt.js +105 -0
  191. package/tools/sync-installer-version.js +34 -0
  192. package/tools/update-expansion-version.js +54 -0
  193. package/tools/upgraders/v3-to-v4-upgrader.js +763 -0
  194. package/tools/version-bump.js +79 -0
  195. package/tools/yaml-format.js +240 -0
  196. /package/{bin → tools/installer/bin}/bmad.js +0 -0
  197. /package/{config → tools/installer/config}/ide-agent-config.yaml +0 -0
  198. /package/{config → tools/installer/config}/install.config.yaml +0 -0
  199. /package/{lib → tools/installer/lib}/config-loader.js +0 -0
  200. /package/{lib → tools/installer/lib}/file-manager.js +0 -0
  201. /package/{lib → tools/installer/lib}/ide-base-setup.js +0 -0
  202. /package/{lib → tools/installer/lib}/ide-setup.js +0 -0
  203. /package/{lib → tools/installer/lib}/installer.js +0 -0
  204. /package/{lib → tools/installer/lib}/memory-profiler.js +0 -0
  205. /package/{lib → tools/installer/lib}/module-manager.js +0 -0
  206. /package/{lib → tools/installer/lib}/resource-locator.js +0 -0
@@ -0,0 +1,91 @@
1
+ # BMad Method Guiding Principles
2
+
3
+ The BMad Method is a natural language framework for AI-assisted software development. These principles ensure contributions maintain the method's effectiveness.
4
+
5
+ ## Core Principles
6
+
7
+ ### 1. Dev Agents Must Be Lean
8
+
9
+ - **Minimize dev agent dependencies**: Development agents that work in IDEs must have minimal context overhead
10
+ - **Save context for code**: Every line counts - dev agents should focus on coding, not documentation
11
+ - **Web agents can be larger**: Planning agents (PRD Writer, Architect) used in web UI can have more complex tasks and dependencies
12
+ - **Small files, loaded on demand**: Multiple small, focused files are better than large files with many branches
13
+
14
+ ### 2. Natural Language First
15
+
16
+ - **Everything is markdown**: Agents, tasks, templates - all written in plain English
17
+ - **No code in core**: The framework itself contains no programming code, only natural language instructions
18
+ - **Self-contained templates**: Templates are defined as YAML files with structured sections that include metadata, workflow configuration, and detailed instructions for content generation
19
+
20
+ ### 3. Agent and Task Design
21
+
22
+ - **Agents define roles**: Each agent is a persona with specific expertise (e.g., Frontend Developer, API Developer)
23
+ - **Tasks are procedures**: Step-by-step instructions an agent follows to complete work
24
+ - **Templates are outputs**: Structured documents with embedded instructions for generation
25
+ - **Dependencies matter**: Explicitly declare only what's needed
26
+
27
+ ## Practical Guidelines
28
+
29
+ ### When to Add to Core
30
+
31
+ - Universal software development needs only
32
+ - Doesn't bloat dev agent contexts
33
+ - Follows existing agent/task/template patterns
34
+
35
+ ### When to Create Expansion Packs
36
+
37
+ - Domain-specific needs beyond software development
38
+ - Non-technical domains (business, wellness, education, creative)
39
+ - Specialized technical domains (games, infrastructure, mobile)
40
+ - Heavy documentation or knowledge bases
41
+ - Anything that would bloat core agents
42
+
43
+ See [Expansion Packs Guide](../docs/expansion-packs.md) for detailed examples and ideas.
44
+
45
+ ### Agent Design Rules
46
+
47
+ 1. **Web/Planning Agents**: Can have richer context, multiple tasks, extensive templates
48
+ 2. **Dev Agents**: Minimal dependencies, focused on code generation, lean task sets
49
+ 3. **All Agents**: Clear persona, specific expertise, well-defined capabilities
50
+
51
+ ### Task Writing Rules
52
+
53
+ 1. Write clear step-by-step procedures
54
+ 2. Use markdown formatting for readability
55
+ 3. Keep dev agent tasks focused and concise
56
+ 4. Planning tasks can be more elaborate
57
+ 5. **Prefer multiple small tasks over one large branching task**
58
+ - Instead of one task with many conditional paths
59
+ - Create multiple focused tasks the agent can choose from
60
+ - This keeps context overhead minimal
61
+ 6. **Reuse common tasks** - Don't create new document creation tasks
62
+ - Use the existing `create-doc` task
63
+ - Pass the appropriate YAML template with structured sections
64
+ - This maintains consistency and reduces duplication
65
+
66
+ ### Template Rules
67
+
68
+ Templates follow the [BMad Document Template](../common/utils/bmad-doc-template.md) specification using YAML format:
69
+
70
+ 1. **Structure**: Templates are defined in YAML with clear metadata, workflow configuration, and section hierarchy
71
+ 2. **Separation of Concerns**: Instructions for LLMs are in `instruction` fields, separate from content
72
+ 3. **Reusability**: Templates are agent-agnostic and can be used across different agents
73
+ 4. **Key Components**:
74
+ - `template` block for metadata (id, name, version, output settings)
75
+ - `workflow` block for interaction mode configuration
76
+ - `sections` array defining document structure with nested subsections
77
+ - Each section has `id`, `title`, and `instruction` fields
78
+ 5. **Advanced Features**:
79
+ - Variable substitution using `{{variable_name}}` syntax
80
+ - Conditional sections with `condition` field
81
+ - Repeatable sections with `repeatable: true`
82
+ - Agent permissions with `owner` and `editors` fields
83
+ - Examples arrays for guidance (never included in output)
84
+ 6. **Clean Output**: YAML structure ensures all processing logic stays separate from generated content
85
+
86
+ ## Remember
87
+
88
+ - The power is in natural language orchestration, not code
89
+ - Dev agents code, planning agents plan
90
+ - Keep dev agents lean for maximum coding efficiency
91
+ - Expansion packs handle specialized domains
@@ -0,0 +1,219 @@
1
+ # BMad Method: Core Architecture
2
+
3
+ ## 1. Overview
4
+
5
+ The BMad Method is designed to provide agentic modes, tasks and templates to allow repeatable helpful workflows be it for agile agentic development, or expansion into vastly different domains. The core purpose of the project is to provide a structured yet flexible set of prompts, templates, and workflows that users can employ to guide AI agents (like Gemini, Claude, or ChatGPT) to perform complex tasks, guided discussions, or other meaningful domain specific flows in a predictable, high-quality manner.
6
+
7
+ The systems core module facilitates a full development lifecycle tailored to the challenges of current modern AI Agentic tooling:
8
+
9
+ 1. **Ideation & Planning**: Brainstorming, market research, and creating project briefs.
10
+ 2. **Architecture & Design**: Defining system architecture and UI/UX specifications.
11
+ 3. **Development Execution**: A cyclical workflow where a Scrum Master (SM) agent drafts stories with extremely specific context and a Developer (Dev) agent implements them one at a time. This process works for both new (Greenfield) and existing (Brownfield) projects.
12
+
13
+ ## 2. System Architecture Diagram
14
+
15
+ The entire BMad-Method ecosystem is designed around the installed `bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
16
+
17
+ ```mermaid
18
+ graph TD
19
+ subgraph BMad Method Project
20
+ subgraph Core Framework
21
+ A["bmad-core"]
22
+ A --> B["agents"]
23
+ A --> C["agent-teams"]
24
+ A --> D["workflows"]
25
+ A --> E["templates"]
26
+ A --> F["tasks"]
27
+ A --> G["checklists"]
28
+ A --> H["data (KB)"]
29
+ end
30
+
31
+ subgraph Tooling
32
+ I["tools/builders/web-builder.js"]
33
+ end
34
+
35
+ subgraph Outputs
36
+ J["dist"]
37
+ end
38
+
39
+ B -- defines dependencies for --> E
40
+ B -- defines dependencies for --> F
41
+ B -- defines dependencies for --> G
42
+ B -- defines dependencies for --> H
43
+
44
+ C -- bundles --> B
45
+ I -- reads from --> A
46
+ I -- creates --> J
47
+ end
48
+
49
+ subgraph Target Environments
50
+ K["IDE (Cursor, VS Code, etc.)"]
51
+ L["Web UI (Gemini, ChatGPT)"]
52
+ end
53
+
54
+ B --> K
55
+ J --> L
56
+
57
+ style A fill:#1a73e8,color:#fff
58
+ style I fill:#f9ab00,color:#fff
59
+ style J fill:#34a853,color:#fff
60
+ ```
61
+
62
+ ## 3. Core Components
63
+
64
+ The `bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
65
+
66
+ ### 3.1. Agents (`bmad-core/agents/`)
67
+
68
+ - **Purpose**: These are the foundational building blocks of the system. Each markdown file (e.g., `bmad-master.md`, `pm.md`, `dev.md`) defines the persona, capabilities, and dependencies of a single AI agent.
69
+ - **Structure**: An agent file contains a YAML header that specifies its role, persona, dependencies, and startup instructions. These dependencies are lists of tasks, templates, checklists, and data files that the agent is allowed to use.
70
+ - **Startup Instructions**: Agents can include startup sequences that load project-specific documentation from the `docs/` folder, such as coding standards, API specifications, or project structure documents. This provides immediate project context upon activation.
71
+ - **Document Integration**: Agents can reference and load documents from the project's `docs/` folder as part of tasks, workflows, or startup sequences. Users can also drag documents directly into chat interfaces to provide additional context.
72
+ - **Example**: The `bmad-master` agent lists its dependencies, which tells the build tool which files to include in a web bundle and informs the agent of its own capabilities.
73
+
74
+ ### 3.2. Agent Teams (`bmad-core/agent-teams/`)
75
+
76
+ - **Purpose**: Team files (e.g., `team-all.yaml`) define collections of agents and workflows that are bundled together for a specific purpose, like "full-stack development" or "backend-only". This creates a larger, pre-packaged context for web UI environments.
77
+ - **Structure**: A team file lists the agents to include. It can use wildcards, such as `"*"` to include all agents. This allows for the creation of comprehensive bundles like `team-all`.
78
+
79
+ ### 3.3. Workflows (`bmad-core/workflows/`)
80
+
81
+ - **Purpose**: Workflows are YAML files (e.g., `greenfield-fullstack.yaml`) that define a prescribed sequence of steps and agent interactions for a specific project type. They act as a strategic guide for the user and the `bmad-orchestrator` agent.
82
+ - **Structure**: A workflow defines sequences for both complex and simple projects, lists the agents involved at each step, the artifacts they create, and the conditions for moving from one step to the next. It often includes a Mermaid diagram for visualization.
83
+
84
+ ### 3.4. Reusable Resources (`templates`, `tasks`, `checklists`, `data`)
85
+
86
+ - **Purpose**: These folders house the modular components that are dynamically loaded by agents based on their dependencies.
87
+ - **`templates/`**: Contains markdown templates for common documents like PRDs, architecture specifications, and user stories.
88
+ - **`tasks/`**: Defines the instructions for carrying out specific, repeatable actions like "shard-doc" or "create-next-story".
89
+ - **`checklists/`**: Provides quality assurance checklists for agents like the Product Owner (`po`) or Architect.
90
+ - **`data/`**: Contains the core knowledge base (`bmad-kb.md`), technical preferences (`technical-preferences.md`), and other key data files.
91
+
92
+ #### 3.4.1. Template Processing System
93
+
94
+ A key architectural principle of BMad is that templates are self-contained and interactive - they embed both the desired document output and the LLM instructions needed to work with users. This means that in many cases, no separate task is needed for document creation, as the template itself contains all the processing logic.
95
+
96
+ The BMad framework employs a sophisticated template processing system orchestrated by three key components:
97
+
98
+ - **`template-format.md`** (`bmad-core/utils/`): Defines the foundational markup language used throughout all BMad templates. This specification establishes syntax rules for variable substitution (`{{placeholders}}`), AI-only processing directives (`[[LLM: instructions]]`), and conditional logic blocks. Templates follow this format to ensure consistent processing across the system.
99
+
100
+ - **`create-doc.md`** (`bmad-core/tasks/`): Acts as the orchestration engine that manages the entire document generation workflow. This task coordinates template selection, manages user interaction modes (incremental vs. rapid generation), enforces template-format processing rules, and handles validation. It serves as the primary interface between users and the template system.
101
+
102
+ - **`advanced-elicitation.md`** (`bmad-core/tasks/`): Provides an interactive refinement layer that can be embedded within templates through `[[LLM: instructions]]` blocks. This component offers 10 structured brainstorming actions, section-by-section review capabilities, and iterative improvement workflows to enhance content quality.
103
+
104
+ The system maintains a clean separation of concerns: template markup is processed internally by AI agents but never exposed to users, while providing sophisticated AI processing capabilities through embedded intelligence within the templates themselves.
105
+
106
+ #### 3.4.2. Technical Preferences System
107
+
108
+ BMad includes a personalization layer through the `technical-preferences.md` file in `bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
109
+
110
+ **Purpose and Benefits:**
111
+
112
+ - **Consistency**: Ensures all agents reference the same technical preferences
113
+ - **Efficiency**: Eliminates the need to repeatedly specify preferred technologies
114
+ - **Personalization**: Agents provide recommendations aligned with user preferences
115
+ - **Learning**: Captures lessons learned and preferences that evolve over time
116
+
117
+ **Content Structure:**
118
+ The file typically includes preferred technology stacks, design patterns, external services, coding standards, and anti-patterns to avoid. Agents automatically reference this file during planning and development to provide contextually appropriate suggestions.
119
+
120
+ **Integration Points:**
121
+
122
+ - Templates can reference technical preferences during document generation
123
+ - Agents suggest preferred technologies when appropriate for project requirements
124
+ - When preferences don't fit project needs, agents explain alternatives
125
+ - Web bundles can include preferences content for consistent behavior across platforms
126
+
127
+ **Evolution Over Time:**
128
+ Users are encouraged to continuously update this file with discoveries from projects, adding both positive preferences and technologies to avoid, creating a personalized knowledge base that improves agent recommendations over time.
129
+
130
+ ## 4. The Build & Delivery Process
131
+
132
+ The framework is designed for two primary environments: local IDEs and web-based AI chat interfaces. The `web-builder.js` script is the key to supporting the latter.
133
+
134
+ ### 4.1. Web Builder (`tools/builders/web-builder.js`)
135
+
136
+ - **Purpose**: This Node.js script is responsible for creating the `.txt` bundles found in `dist`.
137
+ - **Process**:
138
+ 1. **Resolves Dependencies**: For a given agent or team, the script reads its definition file.
139
+ 2. It recursively finds all dependent resources (tasks, templates, etc.) that the agent/team needs.
140
+ 3. **Bundles Content**: It reads the content of all these files and concatenates them into a single, large text file, with clear separators indicating the original file path of each section.
141
+ 4. **Outputs Bundle**: The final `.txt` file is saved in the `dist` directory, ready to be uploaded to a web UI.
142
+
143
+ ### 4.2. Environment-Specific Usage
144
+
145
+ - **For IDEs**: Users interact with the agents directly via their markdown files in `bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
146
+ - **For Web UIs**: Users upload a pre-built bundle from `dist`. This single file provides the AI with the context of the entire team and all their required tools and knowledge.
147
+
148
+ ## 5. BMad Workflows
149
+
150
+ ### 5.1. The Planning Workflow
151
+
152
+ Before development begins, BMad follows a structured planning workflow that establishes the foundation for successful project execution:
153
+
154
+ ```mermaid
155
+ graph TD
156
+ A["Start: Project Idea"] --> B{"Optional: Analyst Brainstorming"}
157
+ B -->|Yes| C["Analyst: Market Research & Analysis"]
158
+ B -->|No| D["Create Project Brief"]
159
+ C --> D["Analyst: Create Project Brief"]
160
+ D --> E["PM: Create PRD from Brief"]
161
+ E --> F["Architect: Create Architecture from PRD"]
162
+ F --> G["PO: Run Master Checklist"]
163
+ G --> H{"Documents Aligned?"}
164
+ H -->|Yes| I["Planning Complete"]
165
+ H -->|No| J["PO: Update Epics & Stories"]
166
+ J --> K["Update PRD/Architecture as needed"]
167
+ K --> G
168
+ I --> L["📁 Switch to IDE"]
169
+ L --> M["PO: Shard Documents"]
170
+ M --> N["Ready for SM/Dev Cycle"]
171
+
172
+ style I fill:#34a853,color:#fff
173
+ style G fill:#f9ab00,color:#fff
174
+ style L fill:#1a73e8,color:#fff
175
+ style N fill:#34a853,color:#fff
176
+ ```
177
+
178
+ **Key Planning Phases:**
179
+
180
+ 1. **Optional Analysis**: Analyst conducts market research and competitive analysis
181
+ 2. **Project Brief**: Foundation document created by Analyst or user
182
+ 3. **PRD Creation**: PM transforms brief into comprehensive product requirements
183
+ 4. **Architecture Design**: Architect creates technical foundation based on PRD
184
+ 5. **Validation & Alignment**: PO ensures all documents are consistent and complete
185
+ 6. **Refinement**: Updates to epics, stories, and documents as needed
186
+ 7. **Environment Transition**: Critical switch from web UI to IDE for development workflow
187
+ 8. **Document Preparation**: PO shards large documents for development consumption
188
+
189
+ **Workflow Orchestration**: The `bmad-orchestrator` agent uses these workflow definitions to guide users through the complete process, ensuring proper transitions between planning (web UI) and development (IDE) phases.
190
+
191
+ ### 5.2. The Core Development Cycle
192
+
193
+ Once the initial planning and architecture phases are complete, the project moves into a cyclical development workflow, as detailed in the `bmad-kb.md`. This ensures a steady, sequential, and quality-controlled implementation process.
194
+
195
+ ```mermaid
196
+ graph TD
197
+ A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
198
+ B --> C["PO: Shard Arch"]
199
+ C --> D["Development Phase"]
200
+ D --> E["Scrum Master: Drafts next story from sharded epic"]
201
+ E --> F{"User Approval"}
202
+ F -->|Approved| G["Dev: Implement Story"]
203
+ F -->|Needs Changes| E
204
+ G --> H["Dev: Complete story Tasks"]
205
+ H --> I["Dev: Mark Ready for Review"]
206
+ I --> J{"User Verification"}
207
+ J -->|Request QA Review| K["QA: Run review-story task"]
208
+ J -->|Approve Without QA| M["Mark Story as Done"]
209
+ K --> L{"QA Review Results"}
210
+ L -->|Needs Work| G
211
+ L -->|Approved| M["Mark Story as Done"]
212
+ J -->|Needs Fixes| G
213
+ M --> E
214
+
215
+ style M fill:#34a853,color:#fff
216
+ style K fill:#f9ab00,color:#fff
217
+ ```
218
+
219
+ This cycle continues, with the Scrum Master, Developer, and optionally QA agents working together. The QA agent provides senior developer review capabilities through the `review-story` task, offering code refactoring, quality improvements, and knowledge transfer. This ensures high code quality while maintaining development velocity.
@@ -0,0 +1,43 @@
1
+ # Enhanced Development Workflow
2
+
3
+ This is a simple step-by-step guide to help you efficiently manage your development workflow using the BMad Method. Refer to the **[<ins>User Guide</ins>](user-guide.md)** for any scenario that is not covered here.
4
+
5
+ ## Create new Branch
6
+
7
+ 1. **Start new branch**
8
+
9
+ ## Story Creation (Scrum Master)
10
+
11
+ 1. **Start new chat/conversation**
12
+ 2. **Load SM agent**
13
+ 3. **Execute**: `*draft` (runs create-next-story task)
14
+ 4. **Review generated story** in `docs/stories/`
15
+ 5. **Update status**: Change from "Draft" to "Approved"
16
+
17
+ ## Story Implementation (Developer)
18
+
19
+ 1. **Start new chat/conversation**
20
+ 2. **Load Dev agent**
21
+ 3. **Execute**: `*develop-story {selected-story}` (runs execute-checklist task)
22
+ 4. **Review generated report** in `{selected-story}`
23
+
24
+ ## Story Review (Quality Assurance)
25
+
26
+ 1. **Start new chat/conversation**
27
+ 2. **Load QA agent**
28
+ 3. **Execute**: `*review {selected-story}` (runs review-story task)
29
+ 4. **Review generated report** in `{selected-story}`
30
+
31
+ ## Commit Changes and Push
32
+
33
+ 1. **Commit changes**
34
+ 2. **Push to remote**
35
+
36
+ ## Repeat Until Complete
37
+
38
+ - **SM**: Create next story → Review → Approve
39
+ - **Dev**: Implement story → Complete → Mark Ready for Review
40
+ - **QA**: Review story → Mark done
41
+ - **Commit**: All changes
42
+ - **Push**: To remote
43
+ - **Continue**: Until all features implemented
@@ -0,0 +1,280 @@
1
+ # The Power of BMad Expansion Packs
2
+
3
+ ## Overview
4
+
5
+ BMad Method's expansion packs unlock the framework's true potential by extending its natural language AI orchestration to ANY domain. While the core framework focuses on software development, expansion packs transform BMad into a universal AI agent system.
6
+
7
+ ## Why Expansion Packs?
8
+
9
+ ### Keep Core Lean
10
+
11
+ The core BMad framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
12
+
13
+ ### Domain Expertise
14
+
15
+ Each expansion pack provides deep, specialized knowledge without bloating the core system. Install only what you need.
16
+
17
+ ### Community Innovation
18
+
19
+ Anyone can create and share expansion packs, fostering a ecosystem of AI-powered solutions across all industries and interests.
20
+
21
+ ## Technical Expansion Packs
22
+
23
+ ### Game Development Pack
24
+
25
+ Transform your AI into a complete game development studio:
26
+
27
+ - **Game Designer**: Mechanics, balance, progression systems
28
+ - **Level Designer**: Map layouts, puzzle design, difficulty curves
29
+ - **Narrative Designer**: Story arcs, dialog trees, lore creation
30
+ - **Art Director**: Visual style guides, asset specifications
31
+ - **Sound Designer**: Audio direction, music themes, SFX planning
32
+
33
+ ### Mobile Development Pack
34
+
35
+ Specialized agents for mobile app creation:
36
+
37
+ - **iOS Specialist**: Swift/SwiftUI patterns, Apple guidelines
38
+ - **Android Expert**: Kotlin best practices, Material Design
39
+ - **Mobile UX Designer**: Touch interfaces, gesture patterns
40
+ - **App Store Optimizer**: ASO strategies, listing optimization
41
+ - **Performance Tuner**: Battery optimization, network efficiency
42
+
43
+ ### DevOps/Infrastructure Pack
44
+
45
+ Complete infrastructure automation team:
46
+
47
+ - **Cloud Architect**: AWS/Azure/GCP design patterns
48
+ - **Security Specialist**: Zero-trust implementation, compliance
49
+ - **SRE Expert**: Monitoring, alerting, incident response
50
+ - **Container Orchestrator**: Kubernetes, Docker optimization
51
+ - **Cost Optimizer**: Cloud spend analysis, resource right-sizing
52
+
53
+ ### Data Science Pack
54
+
55
+ AI-powered data analysis team:
56
+
57
+ - **Data Scientist**: Statistical analysis, ML model selection
58
+ - **Data Engineer**: Pipeline design, ETL processes
59
+ - **ML Engineer**: Model deployment, A/B testing
60
+ - **Visualization Expert**: Dashboard design, insight communication
61
+ - **Ethics Advisor**: Bias detection, fairness assessment
62
+
63
+ ## Non-Technical Expansion Packs
64
+
65
+ ### Business Strategy Pack
66
+
67
+ Complete business advisory team:
68
+
69
+ - **Strategy Consultant**: Market positioning, competitive analysis
70
+ - **Financial Analyst**: Projections, unit economics, funding strategies
71
+ - **Operations Manager**: Process optimization, efficiency improvements
72
+ - **Marketing Strategist**: Go-to-market plans, growth hacking
73
+ - **HR Advisor**: Talent strategies, culture building
74
+
75
+ ### Creative Writing Pack
76
+
77
+ Your personal writing team:
78
+
79
+ - **Plot Architect**: Three-act structure, story beats, pacing
80
+ - **Character Psychologist**: Deep motivations, authentic dialog
81
+ - **World Builder**: Consistent universes, cultural systems
82
+ - **Editor**: Style consistency, grammar, flow
83
+ - **Beta Reader**: Feedback simulation, plot hole detection
84
+
85
+ ### Health & Wellness Pack
86
+
87
+ Personal wellness coaching system:
88
+
89
+ - **Fitness Trainer**: Progressive overload, form correction
90
+ - **Nutritionist**: Macro planning, supplement guidance
91
+ - **Sleep Coach**: Circadian optimization, sleep hygiene
92
+ - **Stress Manager**: Coping strategies, work-life balance
93
+ - **Habit Engineer**: Behavior change, accountability systems
94
+
95
+ ### Education Pack
96
+
97
+ Complete learning design system:
98
+
99
+ - **Curriculum Architect**: Learning objectives, scope & sequence
100
+ - **Instructional Designer**: Engagement strategies, multimedia learning
101
+ - **Assessment Specialist**: Rubrics, formative/summative evaluation
102
+ - **Differentiation Expert**: Adaptive learning, special needs
103
+ - **EdTech Integrator**: Tool selection, digital pedagogy
104
+
105
+ ### Mental Health Support Pack
106
+
107
+ Therapeutic support system:
108
+
109
+ - **CBT Guide**: Cognitive restructuring, thought challenging
110
+ - **Mindfulness Teacher**: Meditation scripts, awareness exercises
111
+ - **Journal Therapist**: Reflective prompts, emotional processing
112
+ - **Crisis Support**: Coping strategies, safety planning
113
+ - **Habit Tracker**: Mood monitoring, trigger identification
114
+
115
+ ### Legal Assistant Pack
116
+
117
+ Legal document and research support:
118
+
119
+ - **Contract Analyst**: Term review, risk assessment
120
+ - **Legal Researcher**: Case law, precedent analysis
121
+ - **Document Drafter**: Template customization, clause libraries
122
+ - **Compliance Checker**: Regulatory alignment, audit prep
123
+ - **IP Advisor**: Patent strategies, trademark guidance
124
+
125
+ ### Real Estate Pack
126
+
127
+ Property investment and management:
128
+
129
+ - **Market Analyst**: Comparable analysis, trend prediction
130
+ - **Investment Calculator**: ROI modeling, cash flow analysis
131
+ - **Property Manager**: Tenant screening, maintenance scheduling
132
+ - **Flip Strategist**: Renovation ROI, project planning
133
+ - **Agent Assistant**: Listing optimization, showing prep
134
+
135
+ ### Personal Development Pack
136
+
137
+ Complete personal growth system:
138
+
139
+ - **Life Coach**: Guides personal growth and transformation
140
+ - **Goal Strategist**: Helps achieve objectives with SMART goals
141
+ - **Habit Builder**: Creates lasting habits with accountability
142
+ - **Mindset Mentor**: Develops positive thinking patterns
143
+
144
+ Key tasks include:
145
+
146
+ - `goal-setting`: Defines SMART goals with action plans
147
+ - `habit-tracking`: Monitors habit formation progress
148
+ - `reflection-exercise`: Facilitates deep self-reflection
149
+
150
+ ## Unique & Innovative Packs
151
+
152
+ ### Role-Playing Game Master Pack
153
+
154
+ AI-powered tabletop RPG assistance:
155
+
156
+ - **World Master**: Dynamic world generation, NPC creation
157
+ - **Combat Referee**: Initiative tracking, rule clarification
158
+ - **Story Weaver**: Plot hooks, side quests, consequences
159
+ - **Character Builder**: Backstory generation, stat optimization
160
+ - **Loot Master**: Treasure generation, magic item creation
161
+
162
+ ### Life Event Planning Pack
163
+
164
+ Major life event coordination:
165
+
166
+ - **Wedding Planner**: Vendor coordination, timeline creation
167
+ - **Event Designer**: Theme development, decoration plans
168
+ - **Budget Manager**: Cost tracking, vendor negotiation
169
+ - **Guest Coordinator**: RSVP tracking, seating arrangements
170
+ - **Timeline Keeper**: Day-of scheduling, contingency planning
171
+
172
+ ### Hobby Mastery Pack
173
+
174
+ Deep dive into specific hobbies:
175
+
176
+ - **Garden Designer**: Plant selection, seasonal planning
177
+ - **Brew Master**: Recipe formulation, process optimization
178
+ - **Maker Assistant**: 3D printing, woodworking, crafts
179
+ - **Collection Curator**: Organization, valuation, trading
180
+ - **Photography Coach**: Composition, lighting, post-processing
181
+
182
+ ### Scientific Research Pack
183
+
184
+ Research acceleration tools:
185
+
186
+ - **Literature Reviewer**: Paper summarization, gap analysis
187
+ - **Hypothesis Generator**: Research question formulation
188
+ - **Methodology Designer**: Experiment planning, control design
189
+ - **Statistical Advisor**: Test selection, power analysis
190
+ - **Grant Writer**: Proposal structure, impact statements
191
+
192
+ ## Creating Your Own Expansion Pack
193
+
194
+ ### Step 1: Define Your Domain
195
+
196
+ What expertise are you capturing? What problems will it solve?
197
+
198
+ ### Step 2: Design Your Agents
199
+
200
+ Each agent should have:
201
+
202
+ - Clear expertise area
203
+ - Specific personality traits
204
+ - Defined capabilities
205
+ - Knowledge boundaries
206
+
207
+ ### Step 3: Create Tasks
208
+
209
+ Tasks should be:
210
+
211
+ - Step-by-step procedures
212
+ - Reusable across scenarios
213
+ - Clear and actionable
214
+ - Domain-specific
215
+
216
+ ### Step 4: Build Templates
217
+
218
+ Templates need:
219
+
220
+ - Structured output format
221
+ - Embedded LLM instructions
222
+ - Placeholders for customization
223
+ - Professional formatting
224
+
225
+ ### Step 5: Test & Iterate
226
+
227
+ - Use with real scenarios
228
+ - Gather user feedback
229
+ - Refine agent responses
230
+ - Improve task clarity
231
+
232
+ ### Step 6: Package & Share
233
+
234
+ - Create clear documentation
235
+ - Include usage examples
236
+ - Add to expansion-packs directory
237
+ - Share with community
238
+
239
+ ## The Future of Expansion Packs
240
+
241
+ ### Marketplace Potential
242
+
243
+ Imagine a future where:
244
+
245
+ - Professional expansion packs are sold
246
+ - Certified packs for regulated industries
247
+ - Community ratings and reviews
248
+ - Automatic updates and improvements
249
+
250
+ ### AI Agent Ecosystems
251
+
252
+ Expansion packs could enable:
253
+
254
+ - Cross-pack agent collaboration
255
+ - Industry-standard agent protocols
256
+ - Interoperable AI workflows
257
+ - Universal agent languages
258
+
259
+ ### Democratizing Expertise
260
+
261
+ Every expansion pack:
262
+
263
+ - Makes expert knowledge accessible
264
+ - Reduces barriers to entry
265
+ - Enables solo entrepreneurs
266
+ - Empowers small teams
267
+
268
+ ## Getting Started
269
+
270
+ 1. **Browse existing packs**: Check `expansion-packs/` directory
271
+ 2. **Install what you need**: Use the installer's expansion pack option
272
+ 3. **Create your own**: Use the expansion-creator pack
273
+ 4. **Share with others**: Submit PRs with new packs
274
+ 5. **Build the future**: Help shape AI-assisted work
275
+
276
+ ## Remember
277
+
278
+ The BMad Method is more than a development framework - it's a platform for structuring human expertise into AI-accessible formats. Every expansion pack you create makes specialized knowledge more accessible to everyone.
279
+
280
+ **What expertise will you share with the world?**