bmad-method 5.1.2 → 6.0.0-alpha.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 (579) hide show
  1. package/.github/FUNDING.yaml +2 -2
  2. package/.github/ISSUE_TEMPLATE/config.yaml +1 -0
  3. package/.github/ISSUE_TEMPLATE/idea_submission.md +109 -0
  4. package/.github/workflows/discord.yaml +1 -10
  5. package/.github/workflows/format-check.yaml +3 -2
  6. package/.github/workflows/manual-release.yaml +2 -2
  7. package/.nvmrc +1 -0
  8. package/.vscode/settings.json +34 -9
  9. package/CHANGELOG.md +211 -577
  10. package/CONTRIBUTING.md +130 -60
  11. package/LICENSE +6 -1
  12. package/docs/codebase-flattener.md +19 -0
  13. package/docs/ide-info/auggie.md +31 -0
  14. package/docs/ide-info/claude-code.md +25 -0
  15. package/docs/ide-info/cline.md +31 -0
  16. package/docs/ide-info/codex.md +32 -0
  17. package/docs/ide-info/crush.md +30 -0
  18. package/docs/ide-info/cursor.md +25 -0
  19. package/docs/ide-info/gemini.md +25 -0
  20. package/docs/ide-info/github-copilot.md +26 -0
  21. package/docs/ide-info/iflow.md +33 -0
  22. package/docs/ide-info/kilo.md +24 -0
  23. package/docs/ide-info/qwen.md +25 -0
  24. package/docs/ide-info/roo.md +27 -0
  25. package/docs/ide-info/trae.md +25 -0
  26. package/docs/ide-info/windsurf.md +22 -0
  27. package/docs/installers-bundlers/ide-injections.md +196 -0
  28. package/docs/installers-bundlers/installers-modules-platforms-reference.md +355 -0
  29. package/docs/installers-bundlers/web-bundler-usage.md +54 -0
  30. package/eslint.config.mjs +17 -7
  31. package/package.json +26 -35
  32. package/prettier.config.mjs +1 -1
  33. package/readme.md +216 -0
  34. package/src/core/_module-installer/install-menu-config.yaml +24 -0
  35. package/src/core/_module-installer/installer.js +68 -0
  36. package/src/core/agents/bmad-master.md +27 -0
  37. package/src/core/agents/bmad-web-orchestrator.md +71 -0
  38. package/src/core/tasks/adv-elicit-methods.csv +39 -0
  39. package/src/core/tasks/adv-elicit.md +109 -0
  40. package/src/core/tasks/index-docs.md +69 -0
  41. package/src/core/tasks/shard-doc.md +57 -0
  42. package/src/core/tasks/validate-workflow.md +92 -0
  43. package/src/core/tasks/workflow.md +141 -0
  44. package/src/core/workflows/bmad-init/instructions.md +79 -0
  45. package/src/core/workflows/bmad-init/workflow.yaml +24 -0
  46. package/src/core/workflows/party-mode/instructions.md +181 -0
  47. package/src/core/workflows/party-mode/workflow.yaml +24 -0
  48. package/src/modules/bmb/_module-installer/install-menu-config.yaml +16 -0
  49. package/src/modules/bmb/agents/bmad-builder.md +30 -0
  50. package/src/modules/bmb/workflows/convert-legacy/README.md +262 -0
  51. package/src/modules/bmb/workflows/convert-legacy/checklist.md +204 -0
  52. package/src/modules/bmb/workflows/convert-legacy/instructions.md +328 -0
  53. package/src/modules/bmb/workflows/convert-legacy/workflow.yaml +35 -0
  54. package/src/modules/bmb/workflows/create-agent/README.md +268 -0
  55. package/src/modules/bmb/workflows/create-agent/agent-architecture.md +412 -0
  56. package/src/modules/bmb/workflows/create-agent/agent-command-patterns.md +757 -0
  57. package/src/modules/bmb/workflows/create-agent/agent-types.md +177 -0
  58. package/src/modules/bmb/workflows/create-agent/brainstorm-context.md +174 -0
  59. package/src/modules/bmb/workflows/create-agent/checklist.md +134 -0
  60. package/src/modules/bmb/workflows/create-agent/communication-styles.md +240 -0
  61. package/src/modules/bmb/workflows/create-agent/instructions.md +340 -0
  62. package/src/modules/bmb/workflows/create-agent/workflow.yaml +39 -0
  63. package/src/modules/bmb/workflows/create-module/README.md +218 -0
  64. package/src/modules/bmb/workflows/create-module/brainstorm-context.md +137 -0
  65. package/src/modules/bmb/workflows/create-module/checklist.md +245 -0
  66. package/src/modules/bmb/workflows/create-module/installer-templates/install-module-config.yaml +132 -0
  67. package/src/modules/bmb/workflows/create-module/installer-templates/installer.js +231 -0
  68. package/src/modules/bmb/workflows/create-module/instructions.md +509 -0
  69. package/src/modules/bmb/workflows/create-module/module-structure.md +310 -0
  70. package/src/modules/bmb/workflows/create-module/workflow.yaml +47 -0
  71. package/src/modules/bmb/workflows/create-workflow/README.md +216 -0
  72. package/src/modules/bmb/workflows/create-workflow/brainstorm-context.md +197 -0
  73. package/src/modules/bmb/workflows/create-workflow/checklist.md +72 -0
  74. package/src/modules/bmb/workflows/create-workflow/instructions.md +267 -0
  75. package/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md +456 -0
  76. package/src/modules/bmb/workflows/create-workflow/workflow-template/checklist.md +24 -0
  77. package/src/modules/bmb/workflows/create-workflow/workflow-template/instructions.md +12 -0
  78. package/src/modules/bmb/workflows/create-workflow/workflow-template/template.md +9 -0
  79. package/src/modules/bmb/workflows/create-workflow/workflow-template/workflow.yaml +35 -0
  80. package/src/modules/bmb/workflows/create-workflow/workflow.yaml +42 -0
  81. package/src/modules/bmb/workflows/edit-workflow/README.md +63 -0
  82. package/src/modules/bmb/workflows/edit-workflow/checklist.md +70 -0
  83. package/src/modules/bmb/workflows/edit-workflow/instructions.md +170 -0
  84. package/src/modules/bmb/workflows/edit-workflow/workflow.yaml +34 -0
  85. package/src/modules/bmb/workflows/module-brief/README.md +264 -0
  86. package/src/modules/bmb/workflows/module-brief/checklist.md +116 -0
  87. package/src/modules/bmb/workflows/module-brief/instructions.md +265 -0
  88. package/src/modules/bmb/workflows/module-brief/template.md +275 -0
  89. package/src/modules/bmb/workflows/module-brief/workflow.yaml +30 -0
  90. package/src/modules/bmb/workflows/redoc/README.md +87 -0
  91. package/src/modules/bmb/workflows/redoc/checklist.md +99 -0
  92. package/src/modules/bmb/workflows/redoc/instructions.md +255 -0
  93. package/src/modules/bmb/workflows/redoc/workflow.yaml +33 -0
  94. package/src/modules/bmm/_module-installer/assets/bmm-kb.md +1 -0
  95. package/src/modules/bmm/_module-installer/assets/technical-decisions-template.md +30 -0
  96. package/src/modules/bmm/_module-installer/install-menu-config.yaml +49 -0
  97. package/src/modules/bmm/_module-installer/installer.js +131 -0
  98. package/src/modules/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
  99. package/src/modules/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
  100. package/src/modules/bmm/agents/analyst.md +26 -0
  101. package/src/modules/bmm/agents/architect.md +29 -0
  102. package/src/modules/bmm/agents/dev.md +61 -0
  103. package/src/modules/bmm/agents/game-architect.md +26 -0
  104. package/src/modules/bmm/agents/game-designer.md +27 -0
  105. package/src/modules/bmm/agents/game-dev.md +28 -0
  106. package/src/modules/bmm/agents/pm.md +26 -0
  107. package/src/modules/bmm/agents/po.md +25 -0
  108. package/src/modules/bmm/agents/sm.md +29 -0
  109. package/src/modules/bmm/agents/tea.md +32 -0
  110. package/src/modules/bmm/agents/ux-expert.md +24 -0
  111. package/src/modules/bmm/sub-modules/claude-code/config.yaml +5 -0
  112. package/src/modules/bmm/sub-modules/claude-code/injections.yaml +242 -0
  113. package/src/modules/bmm/sub-modules/claude-code/readme.md +87 -0
  114. package/src/modules/bmm/sub-modules/claude-code/sub-agents/api-documenter.md +85 -0
  115. package/src/modules/bmm/sub-modules/claude-code/sub-agents/codebase-analyzer.md +64 -0
  116. package/src/modules/bmm/sub-modules/claude-code/sub-agents/data-analyst.md +84 -0
  117. package/src/modules/bmm/sub-modules/claude-code/sub-agents/dependency-mapper.md +67 -0
  118. package/src/modules/bmm/sub-modules/claude-code/sub-agents/document-reviewer.md +85 -0
  119. package/src/modules/bmm/sub-modules/claude-code/sub-agents/epic-optimizer.md +66 -0
  120. package/src/modules/bmm/sub-modules/claude-code/sub-agents/market-researcher.md +34 -0
  121. package/src/modules/bmm/sub-modules/claude-code/sub-agents/pattern-detector.md +67 -0
  122. package/src/modules/bmm/sub-modules/claude-code/sub-agents/requirements-analyst.md +61 -0
  123. package/src/modules/bmm/sub-modules/claude-code/sub-agents/tech-debt-auditor.md +89 -0
  124. package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-decisions-curator.md +146 -0
  125. package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-evaluator.md +51 -0
  126. package/src/modules/bmm/sub-modules/claude-code/sub-agents/test-coverage-analyzer.md +91 -0
  127. package/src/modules/bmm/sub-modules/claude-code/sub-agents/trend-spotter.md +99 -0
  128. package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-journey-mapper.md +101 -0
  129. package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-researcher.md +56 -0
  130. package/src/modules/bmm/tasks/daily-standup.md +91 -0
  131. package/src/modules/bmm/tasks/retrospective.md +110 -0
  132. package/src/modules/bmm/teams/team-all.yaml +7 -0
  133. package/src/modules/bmm/teams/team-dev.yaml +14 -0
  134. package/src/modules/bmm/teams/team-gamedev.yaml +9 -0
  135. package/src/modules/bmm/testarch/atdd.md +40 -0
  136. package/src/modules/bmm/testarch/automate.md +38 -0
  137. package/src/modules/bmm/testarch/ci.md +39 -0
  138. package/src/modules/bmm/testarch/framework.md +41 -0
  139. package/src/modules/bmm/testarch/nfr-assess.md +38 -0
  140. package/src/modules/bmm/testarch/risk-profile.md +38 -0
  141. package/src/modules/bmm/testarch/tea-commands.csv +11 -0
  142. package/src/modules/bmm/testarch/tea-gate.md +38 -0
  143. package/src/modules/bmm/testarch/tea-knowledge.md +275 -0
  144. package/src/modules/bmm/testarch/test-design.md +39 -0
  145. package/{bmad-core/data → src/modules/bmm/testarch}/test-levels-framework.md +2 -0
  146. package/{bmad-core/data → src/modules/bmm/testarch}/test-priorities-matrix.md +2 -0
  147. package/src/modules/bmm/testarch/trace-requirements.md +38 -0
  148. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-brain-methods.csv +26 -0
  149. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-context.md +115 -0
  150. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +47 -0
  151. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/workflow.yaml +22 -0
  152. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +38 -0
  153. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/project-context.md +25 -0
  154. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +21 -0
  155. package/src/modules/bmm/workflows/1-analysis/game-brief/README.md +221 -0
  156. package/src/modules/bmm/workflows/1-analysis/game-brief/checklist.md +128 -0
  157. package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +517 -0
  158. package/src/modules/bmm/workflows/1-analysis/game-brief/template.md +205 -0
  159. package/src/modules/bmm/workflows/1-analysis/game-brief/workflow.yaml +34 -0
  160. package/src/modules/bmm/workflows/1-analysis/product-brief/README.md +180 -0
  161. package/src/modules/bmm/workflows/1-analysis/product-brief/checklist.md +115 -0
  162. package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +353 -0
  163. package/src/modules/bmm/workflows/1-analysis/product-brief/template.md +165 -0
  164. package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +33 -0
  165. package/src/modules/bmm/workflows/1-analysis/research/README.md +454 -0
  166. package/src/modules/bmm/workflows/1-analysis/research/checklist.md +202 -0
  167. package/src/modules/bmm/workflows/1-analysis/research/claude-code/injections.yaml +114 -0
  168. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-competitor-analyzer.md +259 -0
  169. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-data-analyst.md +190 -0
  170. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-market-researcher.md +337 -0
  171. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-trend-spotter.md +107 -0
  172. package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-user-researcher.md +329 -0
  173. package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +370 -0
  174. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +553 -0
  175. package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +91 -0
  176. package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +442 -0
  177. package/src/modules/bmm/workflows/1-analysis/research/template-deep-prompt.md +94 -0
  178. package/src/modules/bmm/workflows/1-analysis/research/template-market.md +311 -0
  179. package/src/modules/bmm/workflows/1-analysis/research/template-technical.md +210 -0
  180. package/src/modules/bmm/workflows/1-analysis/research/workflow.yaml +149 -0
  181. package/src/modules/bmm/workflows/2-plan/README.md +203 -0
  182. package/src/modules/bmm/workflows/2-plan/checklist.md +369 -0
  183. package/src/modules/bmm/workflows/2-plan/gdd/README.md +222 -0
  184. package/src/modules/bmm/workflows/2-plan/gdd/game-types/action-platformer.md +45 -0
  185. package/src/modules/bmm/workflows/2-plan/gdd/game-types/adventure.md +84 -0
  186. package/src/modules/bmm/workflows/2-plan/gdd/game-types/card-game.md +76 -0
  187. package/src/modules/bmm/workflows/2-plan/gdd/game-types/fighting.md +89 -0
  188. package/src/modules/bmm/workflows/2-plan/gdd/game-types/horror.md +86 -0
  189. package/src/modules/bmm/workflows/2-plan/gdd/game-types/idle-incremental.md +78 -0
  190. package/src/modules/bmm/workflows/2-plan/gdd/game-types/metroidvania.md +87 -0
  191. package/src/modules/bmm/workflows/2-plan/gdd/game-types/moba.md +74 -0
  192. package/src/modules/bmm/workflows/2-plan/gdd/game-types/party-game.md +79 -0
  193. package/src/modules/bmm/workflows/2-plan/gdd/game-types/puzzle.md +58 -0
  194. package/src/modules/bmm/workflows/2-plan/gdd/game-types/racing.md +88 -0
  195. package/src/modules/bmm/workflows/2-plan/gdd/game-types/rhythm.md +79 -0
  196. package/src/modules/bmm/workflows/2-plan/gdd/game-types/roguelike.md +69 -0
  197. package/src/modules/bmm/workflows/2-plan/gdd/game-types/rpg.md +70 -0
  198. package/src/modules/bmm/workflows/2-plan/gdd/game-types/sandbox.md +79 -0
  199. package/src/modules/bmm/workflows/2-plan/gdd/game-types/shooter.md +62 -0
  200. package/src/modules/bmm/workflows/2-plan/gdd/game-types/simulation.md +73 -0
  201. package/src/modules/bmm/workflows/2-plan/gdd/game-types/sports.md +75 -0
  202. package/src/modules/bmm/workflows/2-plan/gdd/game-types/strategy.md +71 -0
  203. package/src/modules/bmm/workflows/2-plan/gdd/game-types/survival.md +79 -0
  204. package/src/modules/bmm/workflows/2-plan/gdd/game-types/text-based.md +91 -0
  205. package/src/modules/bmm/workflows/2-plan/gdd/game-types/tower-defense.md +79 -0
  206. package/src/modules/bmm/workflows/2-plan/gdd/game-types/turn-based-tactics.md +88 -0
  207. package/src/modules/bmm/workflows/2-plan/gdd/game-types/visual-novel.md +89 -0
  208. package/src/modules/bmm/workflows/2-plan/gdd/game-types.csv +25 -0
  209. package/src/modules/bmm/workflows/2-plan/gdd/gdd-template.md +159 -0
  210. package/src/modules/bmm/workflows/2-plan/gdd/instructions-gdd.md +480 -0
  211. package/src/modules/bmm/workflows/2-plan/instructions-router.md +222 -0
  212. package/src/modules/bmm/workflows/2-plan/narrative/instructions-narrative.md +517 -0
  213. package/src/modules/bmm/workflows/2-plan/narrative/narrative-template.md +195 -0
  214. package/src/modules/bmm/workflows/2-plan/prd/analysis-template.md +53 -0
  215. package/src/modules/bmm/workflows/2-plan/prd/epics-template.md +18 -0
  216. package/src/modules/bmm/workflows/2-plan/prd/instructions-lg.md +267 -0
  217. package/src/modules/bmm/workflows/2-plan/prd/instructions-med.md +251 -0
  218. package/src/modules/bmm/workflows/2-plan/prd/prd-template.md +73 -0
  219. package/src/modules/bmm/workflows/2-plan/tech-spec/instructions-sm.md +137 -0
  220. package/src/modules/bmm/workflows/2-plan/tech-spec/tech-spec-template.md +59 -0
  221. package/src/modules/bmm/workflows/2-plan/ux/instructions-ux.md +360 -0
  222. package/src/modules/bmm/workflows/2-plan/ux/ux-spec-template.md +162 -0
  223. package/src/modules/bmm/workflows/2-plan/workflow.yaml +60 -0
  224. package/src/modules/bmm/workflows/3-solutioning/ADR-template.md +74 -0
  225. package/src/modules/bmm/workflows/3-solutioning/README.md +565 -0
  226. package/src/modules/bmm/workflows/3-solutioning/checklist.md +170 -0
  227. package/src/modules/bmm/workflows/3-solutioning/instructions.md +661 -0
  228. package/src/modules/bmm/workflows/3-solutioning/project-types/backend-questions.md +490 -0
  229. package/src/modules/bmm/workflows/3-solutioning/project-types/cli-questions.md +337 -0
  230. package/src/modules/bmm/workflows/3-solutioning/project-types/data-questions.md +472 -0
  231. package/src/modules/bmm/workflows/3-solutioning/project-types/desktop-questions.md +299 -0
  232. package/src/modules/bmm/workflows/3-solutioning/project-types/embedded-questions.md +118 -0
  233. package/src/modules/bmm/workflows/3-solutioning/project-types/extension-questions.md +374 -0
  234. package/src/modules/bmm/workflows/3-solutioning/project-types/game-questions.md +133 -0
  235. package/src/modules/bmm/workflows/3-solutioning/project-types/infra-questions.md +484 -0
  236. package/src/modules/bmm/workflows/3-solutioning/project-types/library-questions.md +146 -0
  237. package/src/modules/bmm/workflows/3-solutioning/project-types/mobile-questions.md +110 -0
  238. package/src/modules/bmm/workflows/3-solutioning/project-types/project-types.csv +12 -0
  239. package/src/modules/bmm/workflows/3-solutioning/project-types/web-questions.md +136 -0
  240. package/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md +195 -0
  241. package/src/modules/bmm/workflows/3-solutioning/tech-spec/checklist.md +17 -0
  242. package/src/modules/bmm/workflows/3-solutioning/tech-spec/instructions.md +73 -0
  243. package/src/modules/bmm/workflows/3-solutioning/tech-spec/template.md +76 -0
  244. package/src/modules/bmm/workflows/3-solutioning/tech-spec/workflow.yaml +51 -0
  245. package/src/modules/bmm/workflows/3-solutioning/templates/backend-service-architecture.md +66 -0
  246. package/src/modules/bmm/workflows/3-solutioning/templates/cli-tool-architecture.md +66 -0
  247. package/src/modules/bmm/workflows/3-solutioning/templates/data-pipeline-architecture.md +66 -0
  248. package/src/modules/bmm/workflows/3-solutioning/templates/desktop-app-architecture.md +66 -0
  249. package/src/modules/bmm/workflows/3-solutioning/templates/embedded-firmware-architecture.md +66 -0
  250. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-architecture.md +244 -0
  251. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-godot-guide.md +428 -0
  252. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-unity-guide.md +333 -0
  253. package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-web-guide.md +528 -0
  254. package/src/modules/bmm/workflows/3-solutioning/templates/infrastructure-architecture.md +66 -0
  255. package/src/modules/bmm/workflows/3-solutioning/templates/library-package-architecture.md +66 -0
  256. package/src/modules/bmm/workflows/3-solutioning/templates/mobile-app-architecture.md +66 -0
  257. package/src/modules/bmm/workflows/3-solutioning/templates/registry.csv +172 -0
  258. package/src/modules/bmm/workflows/3-solutioning/templates/web-api-architecture.md +66 -0
  259. package/src/modules/bmm/workflows/3-solutioning/templates/web-fullstack-architecture.md +277 -0
  260. package/src/modules/bmm/workflows/3-solutioning/workflow.yaml +65 -0
  261. package/src/modules/bmm/workflows/4-implementation/correct-course/checklist.md +279 -0
  262. package/src/modules/bmm/workflows/4-implementation/correct-course/instructions.md +190 -0
  263. package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +35 -0
  264. package/src/modules/bmm/workflows/4-implementation/create-story/README.md +42 -0
  265. package/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +39 -0
  266. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +81 -0
  267. package/src/modules/bmm/workflows/4-implementation/create-story/template.md +57 -0
  268. package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +72 -0
  269. package/src/modules/bmm/workflows/4-implementation/dev-story/README.md +84 -0
  270. package/src/modules/bmm/workflows/4-implementation/dev-story/checklist.md +38 -0
  271. package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.md +87 -0
  272. package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +53 -0
  273. package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +391 -0
  274. package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +41 -0
  275. package/src/modules/bmm/workflows/4-implementation/review-story/README.md +72 -0
  276. package/src/modules/bmm/workflows/4-implementation/review-story/backlog_template.md +12 -0
  277. package/src/modules/bmm/workflows/4-implementation/review-story/checklist.md +22 -0
  278. package/src/modules/bmm/workflows/4-implementation/review-story/instructions.md +176 -0
  279. package/src/modules/bmm/workflows/4-implementation/review-story/workflow.yaml +99 -0
  280. package/src/modules/bmm/workflows/4-implementation/story-context/README.md +234 -0
  281. package/src/modules/bmm/workflows/4-implementation/story-context/checklist.md +16 -0
  282. package/src/modules/bmm/workflows/4-implementation/story-context/context-template.xml +34 -0
  283. package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +76 -0
  284. package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +56 -0
  285. package/src/modules/cis/_module-installer/install-menu-config.yaml +14 -0
  286. package/src/modules/cis/_module-installer/installer.js +92 -0
  287. package/src/modules/cis/agents/README.md +104 -0
  288. package/src/modules/cis/agents/brainstorming-coach.md +24 -0
  289. package/src/modules/cis/agents/creative-problem-solver.md +24 -0
  290. package/src/modules/cis/agents/design-thinking-coach.md +24 -0
  291. package/src/modules/cis/agents/innovation-strategist.md +24 -0
  292. package/src/modules/cis/agents/storyteller.md +24 -0
  293. package/src/modules/cis/readme.md +86 -0
  294. package/src/modules/cis/teams/creative-squad.yaml +6 -0
  295. package/src/modules/cis/workflows/README.md +67 -0
  296. package/src/modules/cis/workflows/brainstorming/README.md +271 -0
  297. package/src/modules/cis/workflows/brainstorming/brain-methods.csv +36 -0
  298. package/src/modules/cis/workflows/brainstorming/instructions.md +310 -0
  299. package/src/modules/cis/workflows/brainstorming/template.md +102 -0
  300. package/src/modules/cis/workflows/brainstorming/workflow.yaml +30 -0
  301. package/src/modules/cis/workflows/design-thinking/README.md +56 -0
  302. package/src/modules/cis/workflows/design-thinking/design-methods.csv +31 -0
  303. package/src/modules/cis/workflows/design-thinking/instructions.md +200 -0
  304. package/src/modules/cis/workflows/design-thinking/template.md +111 -0
  305. package/src/modules/cis/workflows/design-thinking/workflow.yaml +29 -0
  306. package/src/modules/cis/workflows/innovation-strategy/README.md +56 -0
  307. package/src/modules/cis/workflows/innovation-strategy/innovation-frameworks.csv +31 -0
  308. package/src/modules/cis/workflows/innovation-strategy/instructions.md +274 -0
  309. package/src/modules/cis/workflows/innovation-strategy/template.md +189 -0
  310. package/src/modules/cis/workflows/innovation-strategy/workflow.yaml +29 -0
  311. package/src/modules/cis/workflows/problem-solving/README.md +56 -0
  312. package/src/modules/cis/workflows/problem-solving/instructions.md +250 -0
  313. package/src/modules/cis/workflows/problem-solving/solving-methods.csv +31 -0
  314. package/src/modules/cis/workflows/problem-solving/template.md +165 -0
  315. package/src/modules/cis/workflows/problem-solving/workflow.yaml +29 -0
  316. package/src/modules/cis/workflows/storytelling/README.md +58 -0
  317. package/src/modules/cis/workflows/storytelling/instructions.md +275 -0
  318. package/src/modules/cis/workflows/storytelling/story-types.csv +26 -0
  319. package/src/modules/cis/workflows/storytelling/template.md +113 -0
  320. package/src/modules/cis/workflows/storytelling/workflow.yaml +29 -0
  321. package/src/utility/models/agent-activation-ide.xml +51 -0
  322. package/src/utility/models/agent-config-template.md +23 -0
  323. package/tools/cli/bmad-cli.js +42 -0
  324. package/tools/cli/bundlers/bundle-web.js +157 -0
  325. package/tools/cli/bundlers/test-analyst.js +28 -0
  326. package/tools/cli/bundlers/test-bundler.js +118 -0
  327. package/tools/cli/bundlers/web-bundler.js +880 -0
  328. package/tools/cli/commands/install.js +41 -0
  329. package/tools/cli/commands/list.js +28 -0
  330. package/tools/cli/commands/status.js +47 -0
  331. package/tools/cli/commands/uninstall.js +44 -0
  332. package/tools/cli/commands/update.js +28 -0
  333. package/tools/cli/installers/lib/core/config-collector.js +383 -0
  334. package/tools/cli/installers/lib/core/dependency-resolver.js +721 -0
  335. package/tools/cli/installers/lib/core/detector.js +208 -0
  336. package/tools/cli/installers/lib/core/installer.js +1070 -0
  337. package/tools/cli/installers/lib/core/manifest-generator.js +385 -0
  338. package/tools/cli/installers/lib/core/manifest.js +484 -0
  339. package/tools/cli/installers/lib/ide/_base-ide.js +281 -0
  340. package/tools/cli/installers/lib/ide/auggie.js +271 -0
  341. package/tools/cli/installers/lib/ide/claude-code.js +625 -0
  342. package/tools/cli/installers/lib/ide/cline.js +301 -0
  343. package/tools/cli/installers/lib/ide/codex.js +267 -0
  344. package/tools/cli/installers/lib/ide/crush.js +204 -0
  345. package/tools/cli/installers/lib/ide/cursor.js +224 -0
  346. package/tools/cli/installers/lib/ide/gemini.js +160 -0
  347. package/tools/cli/installers/lib/ide/github-copilot.js +289 -0
  348. package/tools/cli/installers/lib/ide/iflow.js +142 -0
  349. package/tools/cli/installers/lib/ide/kilo.js +171 -0
  350. package/tools/cli/installers/lib/ide/manager.js +203 -0
  351. package/tools/cli/installers/lib/ide/qwen.js +188 -0
  352. package/tools/cli/installers/lib/ide/roo.js +288 -0
  353. package/tools/cli/installers/lib/ide/trae.js +182 -0
  354. package/tools/cli/installers/lib/ide/windsurf.js +149 -0
  355. package/tools/cli/installers/lib/ide/workflow-command-generator.js +162 -0
  356. package/tools/cli/installers/lib/ide/workflow-command-template.md +11 -0
  357. package/tools/cli/installers/lib/modules/manager.js +452 -0
  358. package/tools/cli/lib/agent-party-generator.js +206 -0
  359. package/tools/cli/lib/cli-utils.js +208 -0
  360. package/tools/cli/lib/config.js +210 -0
  361. package/tools/cli/lib/file-ops.js +204 -0
  362. package/tools/cli/lib/platform-codes.js +116 -0
  363. package/tools/cli/lib/project-root.js +71 -0
  364. package/tools/cli/lib/replace-project-root.js +239 -0
  365. package/tools/cli/lib/ui.js +516 -0
  366. package/tools/cli/lib/xml-handler.js +183 -0
  367. package/tools/cli/lib/xml-to-markdown.js +82 -0
  368. package/tools/{yaml-format.js → cli/lib/yaml-format.js} +3 -10
  369. package/tools/cli/regenerate-manifests.js +28 -0
  370. package/tools/flattener/ignoreRules.js +2 -6
  371. package/tools/flattener/main.js +31 -121
  372. package/tools/flattener/projectRoot.js +3 -8
  373. package/tools/flattener/stats.helpers.js +8 -35
  374. package/tools/flattener/stats.js +1 -6
  375. package/tools/flattener/test-matrix.js +1 -5
  376. package/tools/platform-codes.yaml +127 -0
  377. package/tools/test-agents/captain-kirk-commander.md +110 -0
  378. package/tools/test-agents/data-operations-android.md +123 -0
  379. package/tools/test-agents/geordi-chief-engineer.md +135 -0
  380. package/tools/test-agents/isabella-martinez-ethicist.md +109 -0
  381. package/tools/test-agents/marcus-thompson-security.md +109 -0
  382. package/tools/test-agents/maya-patel-pragmatist.md +82 -0
  383. package/tools/test-agents/picard-diplomat-captain.md +134 -0
  384. package/tools/test-agents/spock-science-officer.md +124 -0
  385. package/tools/test-agents/william-smithers-technocrat.md +71 -0
  386. package/tools/test-agents/zara-chen-designer.md +94 -0
  387. package/tools/validate-bundles.js +87 -0
  388. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
  389. package/README.md +0 -221
  390. package/bmad-core/agent-teams/team-all.yaml +0 -14
  391. package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
  392. package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
  393. package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
  394. package/bmad-core/agents/analyst.md +0 -81
  395. package/bmad-core/agents/architect.md +0 -83
  396. package/bmad-core/agents/bmad-master.md +0 -107
  397. package/bmad-core/agents/bmad-orchestrator.md +0 -149
  398. package/bmad-core/agents/dev.md +0 -75
  399. package/bmad-core/agents/pm.md +0 -81
  400. package/bmad-core/agents/po.md +0 -76
  401. package/bmad-core/agents/qa.md +0 -88
  402. package/bmad-core/agents/sm.md +0 -62
  403. package/bmad-core/agents/ux-expert.md +0 -66
  404. package/bmad-core/checklists/architect-checklist.md +0 -438
  405. package/bmad-core/checklists/change-checklist.md +0 -182
  406. package/bmad-core/checklists/pm-checklist.md +0 -370
  407. package/bmad-core/checklists/po-master-checklist.md +0 -432
  408. package/bmad-core/checklists/story-dod-checklist.md +0 -94
  409. package/bmad-core/checklists/story-draft-checklist.md +0 -153
  410. package/bmad-core/core-config.yaml +0 -20
  411. package/bmad-core/data/bmad-kb.md +0 -806
  412. package/bmad-core/data/brainstorming-techniques.md +0 -36
  413. package/bmad-core/data/elicitation-methods.md +0 -154
  414. package/bmad-core/data/technical-preferences.md +0 -3
  415. package/bmad-core/tasks/advanced-elicitation.md +0 -117
  416. package/bmad-core/tasks/brownfield-create-epic.md +0 -160
  417. package/bmad-core/tasks/brownfield-create-story.md +0 -147
  418. package/bmad-core/tasks/correct-course.md +0 -70
  419. package/bmad-core/tasks/create-brownfield-story.md +0 -312
  420. package/bmad-core/tasks/create-deep-research-prompt.md +0 -278
  421. package/bmad-core/tasks/create-next-story.md +0 -112
  422. package/bmad-core/tasks/document-project.md +0 -343
  423. package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
  424. package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
  425. package/bmad-core/tasks/index-docs.md +0 -173
  426. package/bmad-core/tasks/kb-mode-interaction.md +0 -75
  427. package/bmad-core/tasks/nfr-assess.md +0 -343
  428. package/bmad-core/tasks/qa-gate.md +0 -159
  429. package/bmad-core/tasks/review-story.md +0 -314
  430. package/bmad-core/tasks/risk-profile.md +0 -353
  431. package/bmad-core/tasks/shard-doc.md +0 -185
  432. package/bmad-core/tasks/test-design.md +0 -174
  433. package/bmad-core/tasks/trace-requirements.md +0 -264
  434. package/bmad-core/tasks/validate-next-story.md +0 -134
  435. package/bmad-core/templates/architecture-tmpl.yaml +0 -650
  436. package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
  437. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
  438. package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
  439. package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -306
  440. package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -218
  441. package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
  442. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -823
  443. package/bmad-core/templates/market-research-tmpl.yaml +0 -252
  444. package/bmad-core/templates/prd-tmpl.yaml +0 -202
  445. package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
  446. package/bmad-core/templates/qa-gate-tmpl.yaml +0 -102
  447. package/bmad-core/templates/story-tmpl.yaml +0 -137
  448. package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
  449. package/bmad-core/workflows/brownfield-service.yaml +0 -187
  450. package/bmad-core/workflows/brownfield-ui.yaml +0 -197
  451. package/bmad-core/workflows/greenfield-fullstack.yaml +0 -240
  452. package/bmad-core/workflows/greenfield-service.yaml +0 -206
  453. package/bmad-core/workflows/greenfield-ui.yaml +0 -235
  454. package/common/tasks/create-doc.md +0 -101
  455. package/common/tasks/execute-checklist.md +0 -86
  456. package/common/utils/bmad-doc-template.md +0 -325
  457. package/common/utils/workflow-management.md +0 -69
  458. package/dist/agents/analyst.txt +0 -2889
  459. package/dist/agents/architect.txt +0 -3552
  460. package/dist/agents/bmad-master.txt +0 -8769
  461. package/dist/agents/bmad-orchestrator.txt +0 -1513
  462. package/dist/agents/dev.txt +0 -414
  463. package/dist/agents/pm.txt +0 -2204
  464. package/dist/agents/po.txt +0 -1346
  465. package/dist/agents/qa.txt +0 -1987
  466. package/dist/agents/sm.txt +0 -658
  467. package/dist/agents/ux-expert.txt +0 -694
  468. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2371
  469. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1620
  470. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -815
  471. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -10952
  472. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +0 -4012
  473. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +0 -3698
  474. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -450
  475. package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +0 -973
  476. package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +0 -15376
  477. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2075
  478. package/dist/teams/team-all.txt +0 -12682
  479. package/dist/teams/team-fullstack.txt +0 -10421
  480. package/dist/teams/team-ide-minimal.txt +0 -5103
  481. package/dist/teams/team-no-ui.txt +0 -8980
  482. package/docs/GUIDING-PRINCIPLES.md +0 -91
  483. package/docs/core-architecture.md +0 -219
  484. package/docs/enhanced-ide-development-workflow.md +0 -248
  485. package/docs/expansion-packs.md +0 -280
  486. package/docs/how-to-contribute-with-pull-requests.md +0 -158
  487. package/docs/user-guide.md +0 -504
  488. package/docs/versioning-and-releases.md +0 -147
  489. package/docs/versions.md +0 -48
  490. package/docs/working-in-the-brownfield.md +0 -597
  491. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +0 -102
  492. 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 +0 -13
  493. 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 +0 -13
  494. 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 +0 -25
  495. 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 +0 -34
  496. 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 +0 -70
  497. 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 +0 -26
  498. package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +0 -109
  499. package/expansion-packs/README.md +0 -3
  500. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
  501. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -71
  502. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -78
  503. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -64
  504. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
  505. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
  506. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -8
  507. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -250
  508. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -647
  509. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -110
  510. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
  511. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -290
  512. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
  513. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
  514. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
  515. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
  516. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  517. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  518. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
  519. package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +0 -14
  520. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +0 -80
  521. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +0 -77
  522. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +0 -78
  523. package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +0 -65
  524. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +0 -391
  525. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +0 -203
  526. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +0 -201
  527. package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +0 -124
  528. package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +0 -6
  529. package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +0 -769
  530. package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +0 -586
  531. package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +0 -110
  532. package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +0 -141
  533. package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +0 -184
  534. package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +0 -290
  535. package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +0 -200
  536. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +0 -1030
  537. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +0 -356
  538. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +0 -705
  539. package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +0 -256
  540. package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
  541. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +0 -183
  542. package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +0 -175
  543. package/expansion-packs/bmad-infrastructure-devops/README.md +0 -147
  544. package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +0 -71
  545. package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +0 -484
  546. package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -9
  547. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -305
  548. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +0 -159
  549. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +0 -153
  550. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
  551. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
  552. package/release_notes.md +0 -32
  553. package/tools/bmad-npx-wrapper.js +0 -39
  554. package/tools/builders/web-builder.js +0 -675
  555. package/tools/bump-all-versions.js +0 -115
  556. package/tools/bump-expansion-version.js +0 -90
  557. package/tools/cli.js +0 -152
  558. package/tools/installer/README.md +0 -8
  559. package/tools/installer/bin/bmad.js +0 -585
  560. package/tools/installer/config/ide-agent-config.yaml +0 -58
  561. package/tools/installer/config/install.config.yaml +0 -123
  562. package/tools/installer/lib/config-loader.js +0 -257
  563. package/tools/installer/lib/file-manager.js +0 -389
  564. package/tools/installer/lib/ide-base-setup.js +0 -228
  565. package/tools/installer/lib/ide-setup.js +0 -1441
  566. package/tools/installer/lib/installer.js +0 -1995
  567. package/tools/installer/lib/memory-profiler.js +0 -225
  568. package/tools/installer/lib/module-manager.js +0 -114
  569. package/tools/installer/lib/resource-locator.js +0 -308
  570. package/tools/installer/package.json +0 -44
  571. package/tools/lib/dependency-resolver.js +0 -175
  572. package/tools/lib/yaml-utils.js +0 -29
  573. package/tools/md-assets/web-agent-startup-instructions.md +0 -39
  574. package/tools/preview-release-notes.js +0 -66
  575. package/tools/shared/bannerArt.js +0 -105
  576. package/tools/sync-installer-version.js +0 -32
  577. package/tools/update-expansion-version.js +0 -53
  578. package/tools/upgraders/v3-to-v4-upgrader.js +0 -672
  579. package/tools/version-bump.js +0 -94
@@ -1,504 +0,0 @@
1
- # BMad Method — User Guide
2
-
3
- This guide will help you understand and effectively use the BMad Method for agile AI-driven planning and development.
4
-
5
- ## The BMad Plan and Execute Workflow
6
-
7
- First, here is the full standard Greenfield Planning + Execution Workflow. Brownfield is very similar, but it's suggested to understand this greenfield first, even if on a simple project before tackling a brownfield project. The BMad Method needs to be installed to the root of your new project folder. For the planning phase, you can optionally perform it with powerful web agents, potentially resulting in higher quality results at a fraction of the cost it would take to complete if providing your own API key or credits in some Agentic tools. For planning, powerful thinking models and larger context - along with working as a partner with the agents will net the best results.
8
-
9
- If you are going to use the BMad Method with a Brownfield project (an existing project), review **[Working in the Brownfield](./working-in-the-brownfield.md)**.
10
-
11
- If the diagrams below don't render, install Markdown All in One along with the Markdown Preview Mermaid Support plugins to VSCode (or one of the forked clones). With these plugins, if you right click on the tab when open, there should be an Open Preview option, or check the IDE documentation.
12
-
13
- ### The Planning Workflow (Web UI or Powerful IDE Agents)
14
-
15
- Before development begins, BMad follows a structured planning workflow that's ideally done in web UI for cost efficiency:
16
-
17
- ```mermaid
18
- graph TD
19
- A["Start: Project Idea"] --> B{"Optional: Analyst Research"}
20
- B -->|Yes| C["Analyst: Brainstorming (Optional)"]
21
- B -->|No| G{"Project Brief Available?"}
22
- C --> C2["Analyst: Market Research (Optional)"]
23
- C2 --> C3["Analyst: Competitor Analysis (Optional)"]
24
- C3 --> D["Analyst: Create Project Brief"]
25
- D --> G
26
- G -->|Yes| E["PM: Create PRD from Brief (Fast Track)"]
27
- G -->|No| E2["PM: Interactive PRD Creation (More Questions)"]
28
- E --> F["PRD Created with FRs, NFRs, Epics & Stories"]
29
- E2 --> F
30
- F --> F2{"UX Required?"}
31
- F2 -->|Yes| F3["UX Expert: Create Front End Spec"]
32
- F2 -->|No| H["Architect: Create Architecture from PRD"]
33
- F3 --> F4["UX Expert: Generate UI Prompt for Lovable/V0 (Optional)"]
34
- F4 --> H2["Architect: Create Architecture from PRD + UX Spec"]
35
- H --> Q{"Early Test Strategy? (Optional)"}
36
- H2 --> Q
37
- Q -->|Yes| R["QA: Early Test Architecture Input on High-Risk Areas"]
38
- Q -->|No| I
39
- R --> I["PO: Run Master Checklist"]
40
- I --> J{"Documents Aligned?"}
41
- J -->|Yes| K["Planning Complete"]
42
- J -->|No| L["PO: Update Epics & Stories"]
43
- L --> M["Update PRD/Architecture as needed"]
44
- M --> I
45
- K --> N["📁 Switch to IDE (If in a Web Agent Platform)"]
46
- N --> O["PO: Shard Documents"]
47
- O --> P["Ready for SM/Dev Cycle"]
48
-
49
- style A fill:#f5f5f5,color:#000
50
- style B fill:#e3f2fd,color:#000
51
- style C fill:#e8f5e9,color:#000
52
- style C2 fill:#e8f5e9,color:#000
53
- style C3 fill:#e8f5e9,color:#000
54
- style D fill:#e8f5e9,color:#000
55
- style E fill:#fff3e0,color:#000
56
- style E2 fill:#fff3e0,color:#000
57
- style F fill:#fff3e0,color:#000
58
- style F2 fill:#e3f2fd,color:#000
59
- style F3 fill:#e1f5fe,color:#000
60
- style F4 fill:#e1f5fe,color:#000
61
- style G fill:#e3f2fd,color:#000
62
- style H fill:#f3e5f5,color:#000
63
- style H2 fill:#f3e5f5,color:#000
64
- style Q fill:#e3f2fd,color:#000
65
- style R fill:#ffd54f,color:#000
66
- style I fill:#f9ab00,color:#fff
67
- style J fill:#e3f2fd,color:#000
68
- style K fill:#34a853,color:#fff
69
- style L fill:#f9ab00,color:#fff
70
- style M fill:#fff3e0,color:#000
71
- style N fill:#1a73e8,color:#fff
72
- style O fill:#f9ab00,color:#fff
73
- style P fill:#34a853,color:#fff
74
- ```
75
-
76
- #### Web UI to IDE Transition
77
-
78
- **Critical Transition Point**: Once the PO confirms document alignment, you must switch from web UI to IDE to begin the development workflow:
79
-
80
- 1. **Copy Documents to Project**: Ensure `docs/prd.md` and `docs/architecture.md` are in your project's docs folder (or a custom location you can specify during installation)
81
- 2. **Switch to IDE**: Open your project in your preferred Agentic IDE
82
- 3. **Document Sharding**: Use the PO agent to shard the PRD and then the Architecture
83
- 4. **Begin Development**: Start the Core Development Cycle that follows
84
-
85
- #### Planning Artifacts (Standard Paths)
86
-
87
- ```text
88
- PRD → docs/prd.md
89
- Architecture → docs/architecture.md
90
- Sharded Epics → docs/epics/
91
- Sharded Stories → docs/stories/
92
- QA Assessments → docs/qa/assessments/
93
- QA Gates → docs/qa/gates/
94
- ```
95
-
96
- ### The Core Development Cycle (IDE)
97
-
98
- Once planning is complete and documents are sharded, BMad follows a structured development workflow:
99
-
100
- ```mermaid
101
- graph TD
102
- A["Development Phase Start"] --> B["SM: Reviews Previous Story Dev/QA Notes"]
103
- B --> B2["SM: Drafts Next Story from Sharded Epic + Architecture"]
104
- B2 --> S{"High-Risk Story? (Optional)"}
105
- S -->|Yes| T["QA: *risk + *design on Draft Story"]
106
- S -->|No| B3
107
- T --> U["Test Strategy & Risk Profile Created"]
108
- U --> B3{"PO: Validate Story Draft (Optional)"}
109
- B3 -->|Validation Requested| B4["PO: Validate Story Against Artifacts"]
110
- B3 -->|Skip Validation| C{"User Approval"}
111
- B4 --> C
112
- C -->|Approved| D["Dev: Sequential Task Execution"]
113
- C -->|Needs Changes| B2
114
- D --> E["Dev: Implement Tasks + Tests"]
115
- E --> V{"Mid-Dev QA Check? (Optional)"}
116
- V -->|Yes| W["QA: *trace or *nfr for Early Validation"]
117
- V -->|No| F
118
- W --> X["Dev: Address Coverage/NFR Gaps"]
119
- X --> F["Dev: Run All Validations"]
120
- F --> G["Dev: Mark Ready for Review + Add Notes"]
121
- G --> H{"User Verification"}
122
- H -->|Request QA Review| I["QA: Test Architect Review + Quality Gate"]
123
- H -->|Approve Without QA| M["IMPORTANT: Verify All Regression Tests and Linting are Passing"]
124
- I --> J["QA: Test Architecture Analysis + Active Refactoring"]
125
- J --> L{"QA Decision"}
126
- L -->|Needs Dev Work| D
127
- L -->|Approved| M
128
- H -->|Needs Fixes| D
129
- M --> N["IMPORTANT: COMMIT YOUR CHANGES BEFORE PROCEEDING!"]
130
- N --> Y{"Gate Update Needed?"}
131
- Y -->|Yes| Z["QA: *gate to Update Status"]
132
- Y -->|No| K
133
- Z --> K["Mark Story as Done"]
134
- K --> B
135
-
136
- style A fill:#f5f5f5,color:#000
137
- style B fill:#e8f5e9,color:#000
138
- style B2 fill:#e8f5e9,color:#000
139
- style S fill:#e3f2fd,color:#000
140
- style T fill:#ffd54f,color:#000
141
- style U fill:#ffd54f,color:#000
142
- style B3 fill:#e3f2fd,color:#000
143
- style B4 fill:#fce4ec,color:#000
144
- style C fill:#e3f2fd,color:#000
145
- style D fill:#e3f2fd,color:#000
146
- style E fill:#e3f2fd,color:#000
147
- style V fill:#e3f2fd,color:#000
148
- style W fill:#ffd54f,color:#000
149
- style X fill:#e3f2fd,color:#000
150
- style F fill:#e3f2fd,color:#000
151
- style G fill:#e3f2fd,color:#000
152
- style H fill:#e3f2fd,color:#000
153
- style I fill:#f9ab00,color:#fff
154
- style J fill:#ffd54f,color:#000
155
- style K fill:#34a853,color:#fff
156
- style L fill:#e3f2fd,color:#000
157
- style M fill:#ff5722,color:#fff
158
- style N fill:#d32f2f,color:#fff
159
- style Y fill:#e3f2fd,color:#000
160
- style Z fill:#ffd54f,color:#000
161
- ```
162
-
163
- ## Prerequisites
164
-
165
- Before installing BMad Method, ensure you have:
166
-
167
- - **Node.js** ≥ 18, **npm** ≥ 9
168
- - **Git** installed and configured
169
- - **(Optional)** VS Code with "Markdown All in One" + "Markdown Preview Mermaid Support" extensions
170
-
171
- ## Installation
172
-
173
- ### Optional
174
-
175
- If you want to do the planning on the web with Claude (Sonnet 4 or Opus), Gemini Gem (2.5 Pro), or Custom GPTs:
176
-
177
- 1. Navigate to `dist/teams/`
178
- 2. Copy `team-fullstack.txt`
179
- 3. Create new Gemini Gem or CustomGPT
180
- 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
181
- 5. Type `/help` to see available commands
182
-
183
- ### IDE Project Setup
184
-
185
- ```bash
186
- # Interactive installation (recommended)
187
- npx bmad-method install
188
- ```
189
-
190
- ## Special Agents
191
-
192
- There are two BMad agents — in the future they'll be consolidated into a single BMad-Master.
193
-
194
- ### BMad-Master
195
-
196
- This agent can do any task or command that all other agents can do, aside from actual story implementation. Additionally, this agent can help explain the BMad Method when on the web by accessing the knowledge base and explaining anything to you about the process.
197
-
198
- If you don't want to bother switching between different agents aside from the dev, this is the agent for you. Just remember that as the context grows, the performance of the agent degrades, therefore it is important to instruct the agent to compact the conversation and start a new conversation with the compacted conversation as the initial message. Do this often, preferably after each story is implemented.
199
-
200
- ### BMad-Orchestrator
201
-
202
- This agent should NOT be used within the IDE, it is a heavyweight, special-purpose agent that utilizes a lot of context and can morph into any other agent. This exists solely to facilitate the teams within the web bundles. If you use a web bundle you will be greeted by the BMad Orchestrator.
203
-
204
- ### How Agents Work
205
-
206
- #### Dependencies System
207
-
208
- Each agent has a YAML section that defines its dependencies:
209
-
210
- ```yaml
211
- dependencies:
212
- templates:
213
- - prd-template.md
214
- - user-story-template.md
215
- tasks:
216
- - create-doc.md
217
- - shard-doc.md
218
- data:
219
- - bmad-kb.md
220
- ```
221
-
222
- **Key Points:**
223
-
224
- - Agents only load resources they need (lean context)
225
- - Dependencies are automatically resolved during bundling
226
- - Resources are shared across agents to maintain consistency
227
-
228
- #### Agent Interaction
229
-
230
- **In IDE:**
231
-
232
- ```bash
233
- # Some IDEs, like Cursor or Windsurf for example, utilize manual rules so interaction is done with the '@' symbol
234
- @pm Create a PRD for a task management app
235
- @architect Design the system architecture
236
- @dev Implement the user authentication
237
-
238
- # Some IDEs, like Claude Code, use slash commands instead
239
- /pm Create user stories
240
- /dev Fix the login bug
241
- ```
242
-
243
- #### Interactive Modes
244
-
245
- - **Incremental Mode**: Step-by-step with user input
246
- - **YOLO Mode**: Rapid generation with minimal interaction
247
-
248
- ## IDE Integration
249
-
250
- ### IDE Best Practices
251
-
252
- - **Context Management**: Keep relevant files only in context, keep files as lean and focused as necessary
253
- - **Agent Selection**: Use appropriate agent for task
254
- - **Iterative Development**: Work in small, focused tasks
255
- - **File Organization**: Maintain clean project structure
256
- - **Commit Regularly**: Save your work frequently
257
-
258
- ## The Test Architect (QA Agent)
259
-
260
- ### Overview
261
-
262
- The QA agent in BMad is not just a "senior developer reviewer" - it's a **Test Architect** with deep expertise in test strategy, quality gates, and risk-based testing. Named Quinn, this agent provides advisory authority on quality matters while actively improving code when safe to do so.
263
-
264
- #### Quick Start (Essential Commands)
265
-
266
- ```bash
267
- @qa *risk {story} # Assess risks before development
268
- @qa *design {story} # Create test strategy
269
- @qa *trace {story} # Verify test coverage during dev
270
- @qa *nfr {story} # Check quality attributes
271
- @qa *review {story} # Full assessment → writes gate
272
- ```
273
-
274
- #### Command Aliases (Test Architect)
275
-
276
- The documentation uses short forms for convenience. Both styles are valid:
277
-
278
- ```text
279
- *risk → *risk-profile
280
- *design → *test-design
281
- *nfr → *nfr-assess
282
- *trace → *trace-requirements (or just *trace)
283
- *review → *review
284
- *gate → *gate
285
- ```
286
-
287
- ### Core Capabilities
288
-
289
- #### 1. Risk Profiling (`*risk`)
290
-
291
- **When:** After story draft, before development begins (earliest intervention point)
292
-
293
- Identifies and assesses implementation risks:
294
-
295
- - **Categories**: Technical, Security, Performance, Data, Business, Operational
296
- - **Scoring**: Probability × Impact analysis (1-9 scale)
297
- - **Mitigation**: Specific strategies for each identified risk
298
- - **Gate Impact**: Risks ≥9 trigger FAIL, ≥6 trigger CONCERNS (see `tasks/risk-profile.md` for authoritative rules)
299
-
300
- #### 2. Test Design (`*design`)
301
-
302
- **When:** After story draft, before development begins (guides what tests to write)
303
-
304
- Creates comprehensive test strategies including:
305
-
306
- - Test scenarios for each acceptance criterion
307
- - Appropriate test level recommendations (unit vs integration vs E2E)
308
- - Risk-based prioritization (P0/P1/P2)
309
- - Test data requirements and mock strategies
310
- - Execution strategies for CI/CD integration
311
-
312
- **Example output:**
313
-
314
- ```yaml
315
- test_summary:
316
- total: 24
317
- by_level:
318
- unit: 15
319
- integration: 7
320
- e2e: 2
321
- by_priority:
322
- P0: 8 # Must have - linked to critical risks
323
- P1: 10 # Should have - medium risks
324
- P2: 6 # Nice to have - low risks
325
- ```
326
-
327
- #### 3. Requirements Tracing (`*trace`)
328
-
329
- **When:** During development (mid-implementation checkpoint)
330
-
331
- Maps requirements to test coverage:
332
-
333
- - Documents which tests validate each acceptance criterion
334
- - Uses Given-When-Then for clarity (documentation only, not BDD code)
335
- - Identifies coverage gaps with severity ratings
336
- - Creates traceability matrix for audit purposes
337
-
338
- #### 4. NFR Assessment (`*nfr`)
339
-
340
- **When:** During development or early review (validate quality attributes)
341
-
342
- Validates non-functional requirements:
343
-
344
- - **Core Four**: Security, Performance, Reliability, Maintainability
345
- - **Evidence-Based**: Looks for actual implementation proof
346
- - **Gate Integration**: NFR failures directly impact quality gates
347
-
348
- #### 5. Comprehensive Test Architecture Review (`*review`)
349
-
350
- **When:** After development complete, story marked "Ready for Review"
351
-
352
- When you run `@qa *review {story}`, Quinn performs:
353
-
354
- - **Requirements Traceability**: Maps every acceptance criterion to its validating tests
355
- - **Test Level Analysis**: Ensures appropriate testing at unit, integration, and E2E levels
356
- - **Coverage Assessment**: Identifies gaps and redundant test coverage
357
- - **Active Refactoring**: Improves code quality directly when safe
358
- - **Quality Gate Decision**: Issues PASS/CONCERNS/FAIL status based on findings
359
-
360
- #### 6. Quality Gates (`*gate`)
361
-
362
- **When:** After review fixes or when gate status needs updating
363
-
364
- Manages quality gate decisions:
365
-
366
- - **Deterministic Rules**: Clear criteria for PASS/CONCERNS/FAIL
367
- - **Parallel Authority**: QA owns gate files in `docs/qa/gates/`
368
- - **Advisory Nature**: Provides recommendations, not blocks
369
- - **Waiver Support**: Documents accepted risks when needed
370
-
371
- **Note:** Gates are advisory; teams choose their quality bar. WAIVED requires reason, approver, and expiry date. See `templates/qa-gate-tmpl.yaml` for schema and `tasks/review-story.md` (gate rules) and `tasks/risk-profile.md` for scoring.
372
-
373
- ### Working with the Test Architect
374
-
375
- #### Integration with BMad Workflow
376
-
377
- The Test Architect provides value throughout the entire development lifecycle. Here's when and how to leverage each capability:
378
-
379
- | **Stage** | **Command** | **When to Use** | **Value** | **Output** |
380
- | ------------------ | ----------- | ----------------------- | -------------------------- | -------------------------------------------------------------- |
381
- | **Story Drafting** | `*risk` | After SM drafts story | Identify pitfalls early | `docs/qa/assessments/{epic}.{story}-risk-{YYYYMMDD}.md` |
382
- | | `*design` | After risk assessment | Guide dev on test strategy | `docs/qa/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md` |
383
- | **Development** | `*trace` | Mid-implementation | Verify test coverage | `docs/qa/assessments/{epic}.{story}-trace-{YYYYMMDD}.md` |
384
- | | `*nfr` | While building features | Catch quality issues early | `docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md` |
385
- | **Review** | `*review` | Story marked complete | Full quality assessment | QA Results in story + gate file |
386
- | **Post-Review** | `*gate` | After fixing issues | Update quality decision | Updated `docs/qa/gates/{epic}.{story}-{slug}.yml` |
387
-
388
- #### Example Commands
389
-
390
- ```bash
391
- # Planning Stage - Run these BEFORE development starts
392
- @qa *risk {draft-story} # What could go wrong?
393
- @qa *design {draft-story} # What tests should we write?
394
-
395
- # Development Stage - Run these DURING coding
396
- @qa *trace {story} # Are we testing everything?
397
- @qa *nfr {story} # Are we meeting quality standards?
398
-
399
- # Review Stage - Run when development complete
400
- @qa *review {story} # Comprehensive assessment + refactoring
401
-
402
- # Post-Review - Run after addressing issues
403
- @qa *gate {story} # Update gate status
404
- ```
405
-
406
- ### Quality Standards Enforced
407
-
408
- Quinn enforces these test quality principles:
409
-
410
- - **No Flaky Tests**: Ensures reliability through proper async handling
411
- - **No Hard Waits**: Dynamic waiting strategies only
412
- - **Stateless & Parallel-Safe**: Tests run independently
413
- - **Self-Cleaning**: Tests manage their own test data
414
- - **Appropriate Test Levels**: Unit for logic, integration for interactions, E2E for journeys
415
- - **Explicit Assertions**: Keep assertions in tests, not helpers
416
-
417
- ### Gate Status Meanings
418
-
419
- - **PASS**: All critical requirements met, no blocking issues
420
- - **CONCERNS**: Non-critical issues found, team should review
421
- - **FAIL**: Critical issues that should be addressed (security risks, missing P0 tests)
422
- - **WAIVED**: Issues acknowledged but explicitly accepted by team
423
-
424
- ### Special Situations
425
-
426
- **High-Risk Stories:**
427
-
428
- - Always run `*risk` and `*design` before development starts
429
- - Consider mid-development `*trace` and `*nfr` checkpoints
430
-
431
- **Complex Integrations:**
432
-
433
- - Run `*trace` during development to ensure all integration points tested
434
- - Follow up with `*nfr` to validate performance across integrations
435
-
436
- **Performance-Critical:**
437
-
438
- - Run `*nfr` early and often during development
439
- - Don't wait until review to discover performance issues
440
-
441
- **Brownfield/Legacy Code:**
442
-
443
- - Start with `*risk` to identify regression dangers
444
- - Use `*review` with extra focus on backward compatibility
445
-
446
- ### Best Practices
447
-
448
- - **Early Engagement**: Run `*design` and `*risk` during story drafting
449
- - **Risk-Based Focus**: Let risk scores drive test prioritization
450
- - **Iterative Improvement**: Use QA feedback to improve future stories
451
- - **Gate Transparency**: Share gate decisions with the team
452
- - **Continuous Learning**: QA documents patterns for team knowledge sharing
453
- - **Brownfield Care**: Pay extra attention to regression risks in existing systems
454
-
455
- ### Output Paths Reference
456
-
457
- Quick reference for where Test Architect outputs are stored:
458
-
459
- ```text
460
- *risk-profile → docs/qa/assessments/{epic}.{story}-risk-{YYYYMMDD}.md
461
- *test-design → docs/qa/assessments/{epic}.{story}-test-design-{YYYYMMDD}.md
462
- *trace → docs/qa/assessments/{epic}.{story}-trace-{YYYYMMDD}.md
463
- *nfr-assess → docs/qa/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
464
- *review → QA Results section in story + gate file reference
465
- *gate → docs/qa/gates/{epic}.{story}-{slug}.yml
466
- ```
467
-
468
- ## Technical Preferences System
469
-
470
- BMad includes a personalization system through the `technical-preferences.md` file located in `.bmad-core/data/` - this can help bias the PM and Architect to recommend your preferences for design patterns, technology selection, or anything else you would like to put in here.
471
-
472
- ### Using with Web Bundles
473
-
474
- When creating custom web bundles or uploading to AI platforms, include your `technical-preferences.md` content to ensure agents have your preferences from the start of any conversation.
475
-
476
- ## Core Configuration
477
-
478
- The `bmad-core/core-config.yaml` file is a critical config that enables BMad to work seamlessly with differing project structures, more options will be made available in the future. Currently the most important is the devLoadAlwaysFiles list section in the yaml.
479
-
480
- ### Developer Context Files
481
-
482
- Define which files the dev agent should always load:
483
-
484
- ```yaml
485
- devLoadAlwaysFiles:
486
- - docs/architecture/coding-standards.md
487
- - docs/architecture/tech-stack.md
488
- - docs/architecture/project-structure.md
489
- ```
490
-
491
- You will want to verify from sharding your architecture that these documents exist, that they are as lean as possible, and contain exactly the information you want your dev agent to ALWAYS load into its context. These are the rules the agent will follow.
492
-
493
- As your project grows and the code starts to build consistent patterns, coding standards should be reduced to include only the standards the agent still needs enforced. The agent will look at surrounding code in files to infer the coding standards that are relevant to the current task.
494
-
495
- ## Getting Help
496
-
497
- - **Discord Community**: [Join Discord](https://discord.gg/gk8jAdXWmj)
498
- - **GitHub Issues**: [Report bugs](https://github.com/bmadcode/bmad-method/issues)
499
- - **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/docs)
500
- - **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
501
-
502
- ## Conclusion
503
-
504
- Remember: BMad is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
@@ -1,147 +0,0 @@
1
- # Versioning and Releases
2
-
3
- BMad Method uses a simplified release system with manual control and automatic release notes generation.
4
-
5
- ## 🚀 Release Workflow
6
-
7
- ### Command Line Release (Recommended)
8
-
9
- The fastest way to create a release with beautiful release notes:
10
-
11
- ```bash
12
- # Preview what will be in the release
13
- npm run preview:release
14
-
15
- # Create a release
16
- npm run release:patch # 5.1.0 → 5.1.1 (bug fixes)
17
- npm run release:minor # 5.1.0 → 5.2.0 (new features)
18
- npm run release:major # 5.1.0 → 6.0.0 (breaking changes)
19
-
20
- # Watch the release process
21
- npm run release:watch
22
- ```
23
-
24
- ### One-Liner Release
25
-
26
- ```bash
27
- npm run preview:release && npm run release:minor && npm run release:watch
28
- ```
29
-
30
- ## 📝 What Happens Automatically
31
-
32
- When you trigger a release, the GitHub Actions workflow automatically:
33
-
34
- 1. ✅ **Validates** - Runs tests, linting, and formatting checks
35
- 2. ✅ **Bumps Version** - Updates `package.json` and installer version
36
- 3. ✅ **Generates Release Notes** - Categorizes commits since last release:
37
- - ✨ **New Features** (`feat:`, `Feature:`)
38
- - 🐛 **Bug Fixes** (`fix:`, `Fix:`)
39
- - 🔧 **Maintenance** (`chore:`, `Chore:`)
40
- - 📦 **Other Changes** (everything else)
41
- 4. ✅ **Creates Git Tag** - Tags the release version
42
- 5. ✅ **Publishes to NPM** - With `@latest` tag for user installations
43
- 6. ✅ **Creates GitHub Release** - With formatted release notes
44
-
45
- ## 📋 Sample Release Notes
46
-
47
- The workflow automatically generates professional release notes like this:
48
-
49
- ````markdown
50
- ## 🚀 What's New in v5.2.0
51
-
52
- ### ✨ New Features
53
-
54
- - feat: add team collaboration mode
55
- - feat: enhance CLI with interactive prompts
56
-
57
- ### 🐛 Bug Fixes
58
-
59
- - fix: resolve installation path issues
60
- - fix: handle edge cases in agent loading
61
-
62
- ### 🔧 Maintenance
63
-
64
- - chore: update dependencies
65
- - chore: improve error messages
66
-
67
- ## 📦 Installation
68
-
69
- ```bash
70
- npx bmad-method install
71
- ```
72
- ````
73
-
74
- **Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.1.0...v5.2.0
75
-
76
- ````
77
-
78
- ## 🎯 User Installation
79
-
80
- After any release, users can immediately get the new version with:
81
-
82
- ```bash
83
- npx bmad-method install # Always gets latest release
84
- ```
85
-
86
- ## 📊 Preview Before Release
87
-
88
- Always preview what will be included in your release:
89
-
90
- ```bash
91
- npm run preview:release
92
- ```
93
-
94
- This shows:
95
-
96
- - Commits since last release
97
- - Categorized changes
98
- - Estimated next version
99
- - Release notes preview
100
-
101
- ## 🔧 Manual Release (GitHub UI)
102
-
103
- You can also trigger releases through GitHub Actions:
104
-
105
- 1. Go to **GitHub Actions** → **Manual Release**
106
- 2. Click **"Run workflow"**
107
- 3. Choose version bump type (patch/minor/major)
108
- 4. Everything else happens automatically
109
-
110
- ## 📈 Version Strategy
111
-
112
- - **Patch** (5.1.0 → 5.1.1): Bug fixes, minor improvements
113
- - **Minor** (5.1.0 → 5.2.0): New features, enhancements
114
- - **Major** (5.1.0 → 6.0.0): Breaking changes, major redesigns
115
-
116
- ## 🛠️ Development Workflow
117
-
118
- 1. **Develop Freely** - Merge PRs to main without triggering releases
119
- 2. **Test Unreleased Changes** - Clone repo to test latest main branch
120
- 3. **Release When Ready** - Use command line or GitHub Actions to cut releases
121
- 4. **Users Get Updates** - Via simple `npx bmad-method install` command
122
-
123
- This gives you complete control over when releases happen while automating all the tedious parts like version bumping, release notes, and publishing.
124
-
125
- ## 🔍 Troubleshooting
126
-
127
- ### Check Release Status
128
-
129
- ```bash
130
- gh run list --workflow="Manual Release"
131
- npm view bmad-method dist-tags
132
- git tag -l | sort -V | tail -5
133
- ```
134
-
135
- ### View Latest Release
136
-
137
- ```bash
138
- gh release view --web
139
- npm view bmad-method versions --json
140
- ```
141
-
142
- ### If Release Fails
143
-
144
- - Check GitHub Actions logs: `gh run view <run-id> --log-failed`
145
- - Verify NPM tokens are configured
146
- - Ensure branch protection allows workflow pushes
147
- ````