bmad-method 6.0.0-alpha.13 → 6.0.0-alpha.14

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 (335) hide show
  1. package/.github/ISSUE_TEMPLATE/idea_submission.md +1 -1
  2. package/.github/scripts/discord-helpers.sh +15 -0
  3. package/.github/workflows/discord.yaml +278 -8
  4. package/.github/workflows/quality.yaml +19 -0
  5. package/.markdownlint-cli2.yaml +42 -0
  6. package/.prettierignore +3 -0
  7. package/CHANGELOG.md +95 -0
  8. package/CODE_OF_CONDUCT.md +128 -0
  9. package/bmad-method-6.0.0-alpha.14.tgz +0 -0
  10. package/docs/agent-customization-guide.md +2 -2
  11. package/docs/custom-agent-installation.md +56 -102
  12. package/docs/document-sharding-guide.md +1 -1
  13. package/eslint.config.mjs +14 -0
  14. package/example-custom-content/README.md +4 -0
  15. package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/instructions.md +4 -4
  16. package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/memories.md +1 -1
  17. package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith.agent.yaml +17 -16
  18. package/example-custom-content/custom.yaml +3 -0
  19. package/example-custom-content/workflows/quiz-master/steps/step-01-init.md +168 -0
  20. package/example-custom-content/workflows/quiz-master/steps/step-02-q1.md +155 -0
  21. package/example-custom-content/workflows/quiz-master/steps/step-03-q2.md +89 -0
  22. package/example-custom-content/workflows/quiz-master/steps/step-04-q3.md +36 -0
  23. package/example-custom-content/workflows/quiz-master/steps/step-05-q4.md +36 -0
  24. package/example-custom-content/workflows/quiz-master/steps/step-06-q5.md +36 -0
  25. package/example-custom-content/workflows/quiz-master/steps/step-07-q6.md +36 -0
  26. package/example-custom-content/workflows/quiz-master/steps/step-08-q7.md +36 -0
  27. package/example-custom-content/workflows/quiz-master/steps/step-09-q8.md +36 -0
  28. package/example-custom-content/workflows/quiz-master/steps/step-10-q9.md +36 -0
  29. package/example-custom-content/workflows/quiz-master/steps/step-11-q10.md +36 -0
  30. package/example-custom-content/workflows/quiz-master/steps/step-12-results.md +150 -0
  31. package/example-custom-content/workflows/quiz-master/templates/csv-headers.template +1 -0
  32. package/example-custom-content/workflows/quiz-master/workflow-plan-quiz-master.md +269 -0
  33. package/example-custom-content/workflows/quiz-master/workflow.md +54 -0
  34. package/example-custom-content/workflows/wassup/workflow.md +26 -0
  35. package/example-custom-module/mwm/README.md +4 -0
  36. package/example-custom-module/mwm/_module-installer/install-config.yaml +27 -0
  37. package/example-custom-module/mwm/agents/cbt-coach/cbt-coach-sidecar/cognitive-distortions.md +47 -0
  38. package/example-custom-module/mwm/agents/cbt-coach/cbt-coach-sidecar/thought-records.md +17 -0
  39. package/example-custom-module/mwm/agents/cbt-coach/cbt-coach.agent.yaml +150 -0
  40. package/example-custom-module/mwm/agents/crisis-navigator.agent.yaml +137 -0
  41. package/example-custom-module/mwm/agents/meditation-guide.agent.yaml +137 -0
  42. package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/insights.md +13 -0
  43. package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/instructions.md +30 -0
  44. package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/memories.md +13 -0
  45. package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/patterns.md +17 -0
  46. package/example-custom-module/mwm/agents/wellness-companion/wellness-companion.agent.yaml +124 -0
  47. package/example-custom-module/mwm/workflows/cbt-thought-record/README.md +31 -0
  48. package/example-custom-module/mwm/workflows/cbt-thought-record/workflow.md +45 -0
  49. package/example-custom-module/mwm/workflows/crisis-support/README.md +31 -0
  50. package/example-custom-module/mwm/workflows/crisis-support/workflow.md +45 -0
  51. package/example-custom-module/mwm/workflows/daily-checkin/README.md +32 -0
  52. package/example-custom-module/mwm/workflows/daily-checkin/workflow.md +45 -0
  53. package/example-custom-module/mwm/workflows/guided-meditation/README.md +31 -0
  54. package/example-custom-module/mwm/workflows/guided-meditation/workflow.md +45 -0
  55. package/example-custom-module/mwm/workflows/wellness-journal/README.md +31 -0
  56. package/example-custom-module/mwm/workflows/wellness-journal/workflow.md +45 -0
  57. package/package.json +9 -4
  58. package/src/core/_module-installer/install-config.yaml +5 -1
  59. package/src/core/resources/excalidraw/library-loader.md +2 -2
  60. package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +1 -1
  61. package/src/core/workflows/brainstorming/workflow.md +1 -1
  62. package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +0 -1
  63. package/src/core/workflows/party-mode/workflow.md +2 -3
  64. package/src/modules/bmb/README.md +1 -1
  65. package/src/modules/bmb/_module-installer/install-config.yaml +4 -9
  66. package/src/modules/bmb/_module-installer/installer.js +76 -0
  67. package/src/modules/bmb/agents/bmad-builder.agent.yaml +32 -9
  68. package/src/modules/bmb/docs/agents/agent-menu-patterns.md +5 -5
  69. package/src/modules/bmb/docs/agents/expert-agent-architecture.md +20 -20
  70. package/src/modules/bmb/docs/agents/module-agent-architecture.md +45 -45
  71. package/src/modules/bmb/docs/agents/simple-agent-architecture.md +7 -3
  72. package/src/modules/bmb/docs/workflows/architecture.md +1 -1
  73. package/src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md +241 -0
  74. package/src/modules/bmb/docs/workflows/templates/step-1b-template.md +223 -0
  75. package/src/modules/bmb/{workflows/create-workflow → docs/workflows}/templates/step-file.md +4 -4
  76. package/src/modules/bmb/docs/workflows/{step-template.md → templates/step-template.md} +40 -33
  77. package/src/modules/bmb/docs/workflows/templates/workflow-template.md +104 -0
  78. package/src/modules/bmb/{workflows/create-workflow → docs/workflows}/templates/workflow.md +1 -1
  79. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/README.md +4 -4
  80. package/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml +8 -8
  81. package/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml +6 -6
  82. package/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml +7 -7
  83. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +2 -3
  84. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +10 -40
  85. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +1 -1
  86. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +1 -0
  87. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +2 -2
  88. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +2 -2
  89. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +2 -2
  90. package/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md +2 -2
  91. package/src/modules/bmb/workflows/create-agent/data/info-and-installation-guide.md +16 -4
  92. package/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/README.md +4 -4
  93. package/src/modules/bmb/workflows/create-agent/data/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml +7 -7
  94. package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +1 -1
  95. package/src/modules/bmb/workflows/create-agent/data/validation-complete.md +3 -3
  96. package/src/modules/bmb/workflows/create-agent/steps/step-01-brainstorm.md +3 -3
  97. package/src/modules/bmb/workflows/create-agent/steps/step-02-discover.md +3 -3
  98. package/src/modules/bmb/workflows/create-agent/steps/step-03-persona.md +3 -3
  99. package/src/modules/bmb/workflows/create-agent/steps/step-04-commands.md +6 -6
  100. package/src/modules/bmb/workflows/create-agent/steps/step-05-name.md +2 -2
  101. package/src/modules/bmb/workflows/create-agent/steps/step-06-build.md +3 -3
  102. package/src/modules/bmb/workflows/create-agent/steps/step-07-validate.md +3 -3
  103. package/src/modules/bmb/workflows/create-agent/steps/step-08-setup.md +2 -2
  104. package/src/modules/bmb/workflows/create-agent/steps/step-09-customize.md +3 -3
  105. package/src/modules/bmb/workflows/create-agent/steps/step-10-build-tools.md +2 -2
  106. package/src/modules/bmb/workflows/create-agent/steps/step-11-celebrate.md +2 -2
  107. package/src/modules/bmb/workflows/create-agent/workflow.md +11 -11
  108. package/src/modules/bmb/workflows/create-module/steps/step-01-init.md +155 -0
  109. package/src/modules/bmb/workflows/create-module/steps/step-01b-continue.md +169 -0
  110. package/src/modules/bmb/workflows/create-module/steps/step-02-concept.md +217 -0
  111. package/src/modules/bmb/workflows/create-module/steps/step-03-components.md +267 -0
  112. package/src/modules/bmb/workflows/create-module/steps/step-04-structure.md +228 -0
  113. package/src/modules/bmb/workflows/create-module/steps/step-05-config.md +233 -0
  114. package/src/modules/bmb/workflows/create-module/steps/step-06-agents.md +296 -0
  115. package/src/modules/bmb/workflows/create-module/steps/step-07-workflows.md +228 -0
  116. package/src/modules/bmb/workflows/create-module/steps/step-08-installer.md +186 -0
  117. package/src/modules/bmb/workflows/create-module/steps/step-09-documentation.md +308 -0
  118. package/src/modules/bmb/workflows/create-module/steps/step-10-roadmap.md +336 -0
  119. package/src/modules/bmb/workflows/create-module/steps/step-11-validate.md +335 -0
  120. package/src/modules/bmb/workflows/create-module/templates/agent.template.md +317 -0
  121. package/src/modules/bmb/workflows/create-module/templates/install-config.template.yaml +53 -0
  122. package/src/modules/bmb/workflows/create-module/templates/installer.template.js +47 -0
  123. package/src/modules/bmb/workflows/create-module/templates/module-plan.template.md +5 -0
  124. package/src/modules/bmb/workflows/create-module/templates/workflow-plan-template.md +23 -0
  125. package/src/modules/bmb/workflows/create-module/validation.md +126 -0
  126. package/src/modules/bmb/workflows/create-module/workflow.md +55 -0
  127. package/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md +45 -56
  128. package/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md +9 -31
  129. package/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +250 -0
  130. package/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md +216 -0
  131. package/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +289 -0
  132. package/src/modules/bmb/workflows/create-workflow/steps/{step-09-design.md → step-06-design.md} +76 -44
  133. package/src/modules/bmb/workflows/create-workflow/steps/{step-11-build.md → step-07-build.md} +70 -24
  134. package/src/modules/bmb/workflows/create-workflow/steps/{step-12-review.md → step-08-review.md} +30 -16
  135. package/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md +187 -0
  136. package/src/modules/bmb/workflows/create-workflow/workflow.md +2 -2
  137. package/src/modules/bmb/workflows/edit-agent/steps/step-01-discover-intent.md +2 -2
  138. package/src/modules/bmb/workflows/edit-agent/steps/step-02-analyze-agent.md +14 -14
  139. package/src/modules/bmb/workflows/edit-agent/steps/step-03-propose-changes.md +4 -4
  140. package/src/modules/bmb/workflows/edit-agent/steps/step-04-apply-changes.md +2 -2
  141. package/src/modules/bmb/workflows/edit-agent/steps/step-05-validate.md +4 -4
  142. package/src/modules/bmb/workflows/edit-agent/workflow.md +1 -1
  143. package/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md +2 -6
  144. package/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md +2 -2
  145. package/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md +1 -1
  146. package/src/modules/bmb/workflows/edit-workflow/workflow.md +1 -1
  147. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +2 -2
  148. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +5 -5
  149. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +7 -7
  150. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +3 -3
  151. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +3 -3
  152. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +3 -3
  153. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +3 -3
  154. package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +2 -2
  155. package/src/modules/bmb/workflows/workflow-compliance-check/workflow.md +1 -1
  156. package/src/modules/bmb/workflows-legacy/edit-module/checklist.md +0 -1
  157. package/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md +8 -8
  158. package/src/modules/bmm/_module-installer/install-config.yaml +1 -1
  159. package/src/modules/bmm/agents/analyst.agent.yaml +11 -8
  160. package/src/modules/bmm/agents/architect.agent.yaml +1 -5
  161. package/src/modules/bmm/agents/pm.agent.yaml +5 -5
  162. package/src/modules/bmm/docs/README.md +23 -1
  163. package/src/modules/bmm/docs/agents-guide.md +16 -35
  164. package/src/modules/bmm/docs/brownfield-guide.md +17 -30
  165. package/src/modules/bmm/docs/enterprise-agentic-development.md +2 -2
  166. package/src/modules/bmm/docs/faq.md +6 -39
  167. package/src/modules/bmm/docs/glossary.md +11 -24
  168. package/src/modules/bmm/docs/images/README.md +37 -0
  169. package/src/modules/bmm/docs/images/workflow-method-greenfield.excalidraw +62 -202
  170. package/src/modules/bmm/docs/images/workflow-method-greenfield.svg +3 -1
  171. package/src/modules/bmm/docs/quick-spec-flow.md +652 -0
  172. package/src/modules/bmm/docs/quick-start.md +9 -25
  173. package/src/modules/bmm/docs/test-architecture.md +6 -6
  174. package/src/modules/bmm/docs/troubleshooting.md +680 -0
  175. package/src/modules/bmm/docs/workflow-document-project-reference.md +1 -1
  176. package/src/modules/bmm/docs/workflows-implementation.md +143 -3
  177. package/src/modules/bmm/docs/workflows-solutioning.md +2 -2
  178. package/src/modules/bmm/tasks/daily-standup.xml +85 -0
  179. package/src/modules/bmm/testarch/knowledge/ci-burn-in.md +1 -1
  180. package/src/modules/bmm/testarch/knowledge/overview.md +1 -1
  181. package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-02-vision.md +2 -2
  182. package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-03-users.md +2 -2
  183. package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-04-metrics.md +2 -2
  184. package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-05-scope.md +2 -2
  185. package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.md +1 -1
  186. package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +8 -8
  187. package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +18 -18
  188. package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +18 -18
  189. package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +18 -18
  190. package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +17 -17
  191. package/src/modules/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +35 -36
  192. package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +5 -6
  193. package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +20 -19
  194. package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +21 -20
  195. package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +20 -19
  196. package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +21 -20
  197. package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +16 -15
  198. package/src/modules/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +36 -37
  199. package/src/modules/bmm/workflows/1-analysis/research/research.template.md +0 -1
  200. package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +8 -8
  201. package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +19 -18
  202. package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +20 -19
  203. package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +21 -20
  204. package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +19 -18
  205. package/src/modules/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +38 -39
  206. package/src/modules/bmm/workflows/1-analysis/research/workflow.md +14 -8
  207. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +6 -0
  208. package/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md +7 -0
  209. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +138 -56
  210. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +93 -51
  211. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +223 -78
  212. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +20 -2
  213. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +18 -0
  214. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +21 -0
  215. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +21 -0
  216. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +21 -0
  217. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +18 -0
  218. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +18 -0
  219. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +18 -0
  220. package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +13 -0
  221. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md +2 -2
  222. package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-03-starter.md +14 -14
  223. package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-04-decisions.md +7 -7
  224. package/src/modules/bmm/workflows/3-solutioning/architecture/workflow.md +2 -1
  225. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +258 -0
  226. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +232 -0
  227. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +271 -0
  228. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +144 -0
  229. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
  230. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -0
  231. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-01-document-discovery.md +189 -0
  232. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-02-prd-analysis.md +177 -0
  233. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-03-epic-coverage-validation.md +178 -0
  234. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-04-ux-alignment.md +138 -0
  235. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-05-epic-quality-review.md +251 -0
  236. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-06-final-assessment.md +132 -0
  237. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/templates/readiness-report-template.md +4 -0
  238. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/workflow.md +54 -0
  239. package/src/modules/{bmgd/workflows/4-production → bmm/workflows/4-implementation}/code-review/checklist.md +2 -1
  240. package/src/modules/bmm/workflows/4-implementation/code-review/instructions.xml +51 -3
  241. package/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml +1 -1
  242. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml +32 -2
  243. package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +3 -3
  244. package/src/modules/bmm/workflows/4-implementation/sprint-planning/instructions.md +19 -21
  245. package/src/modules/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +10 -10
  246. package/src/modules/bmm/workflows/4-implementation/sprint-status/instructions.md +174 -0
  247. package/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml +35 -0
  248. package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/instructions.md +104 -7
  249. package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml +4 -0
  250. package/src/modules/bmm/workflows/document-project/instructions.md +1 -1
  251. package/src/modules/bmm/workflows/document-project/workflows/deep-dive-instructions.md +2 -2
  252. package/src/modules/bmm/workflows/generate-project-context/workflow.md +1 -1
  253. package/src/modules/bmm/workflows/testarch/atdd/atdd-checklist-template.md +1 -1
  254. package/src/modules/bmm/workflows/testarch/ci/checklist.md +1 -1
  255. package/src/modules/bmm/workflows/testarch/ci/github-actions-template.yaml +36 -3
  256. package/src/modules/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +25 -4
  257. package/src/modules/bmm/workflows/testarch/ci/instructions.md +2 -2
  258. package/src/modules/bmm/workflows/testarch/test-review/instructions.md +1 -1
  259. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +1 -6
  260. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +1 -6
  261. package/src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml +1 -6
  262. package/src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml +1 -7
  263. package/tools/cli/README.md +3 -3
  264. package/tools/cli/commands/build.js +9 -184
  265. package/tools/cli/commands/install.js +1 -6
  266. package/tools/cli/installers/lib/core/config-collector.js +70 -10
  267. package/tools/cli/installers/lib/core/installer.js +153 -388
  268. package/tools/cli/installers/lib/core/manifest-generator.js +91 -30
  269. package/tools/cli/installers/lib/core/post-install-sidecar-replacement.js +79 -0
  270. package/tools/cli/installers/lib/custom/handler.js +266 -0
  271. package/tools/cli/installers/lib/ide/_base-ide.js +10 -0
  272. package/tools/cli/installers/lib/ide/auggie.js +19 -7
  273. package/tools/cli/installers/lib/ide/crush.js +19 -6
  274. package/tools/cli/installers/lib/ide/cursor.js +29 -13
  275. package/tools/cli/installers/lib/ide/gemini.js +49 -1
  276. package/tools/cli/installers/lib/ide/iflow.js +20 -1
  277. package/tools/cli/installers/lib/ide/kiro-cli.js +327 -0
  278. package/tools/cli/installers/lib/ide/opencode.js +3 -3
  279. package/tools/cli/installers/lib/ide/roo.js +120 -184
  280. package/tools/cli/installers/lib/ide/rovo-dev.js +1 -1
  281. package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +8 -2
  282. package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +34 -19
  283. package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +18 -14
  284. package/tools/cli/installers/lib/ide/templates/agent-command-template.md +1 -1
  285. package/tools/cli/installers/lib/ide/templates/workflow-commander.md +5 -0
  286. package/tools/cli/installers/lib/modules/manager.js +486 -53
  287. package/tools/cli/lib/agent/compiler.js +54 -5
  288. package/tools/cli/lib/agent/installer.js +127 -27
  289. package/tools/cli/lib/config.js +2 -1
  290. package/tools/cli/lib/ui.js +65 -4
  291. package/tools/cli/lib/yaml-xml-builder.js +0 -15
  292. package/tools/schema/agent.js +149 -89
  293. package/tools/validate-svg-changes.sh +356 -0
  294. package/custom/src/agents/commit-poet/installation-guide.md +0 -36
  295. package/custom/src/agents/toolsmith/installation-guide.md +0 -36
  296. package/src/modules/bmb/docs/workflows/workflow-template.md +0 -152
  297. package/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-overview.md +0 -127
  298. package/src/modules/bmb/workflows/create-workflow/steps/step-04-core-tools.md +0 -145
  299. package/src/modules/bmb/workflows/create-workflow/steps/step-05-memory-requirements.md +0 -136
  300. package/src/modules/bmb/workflows/create-workflow/steps/step-06-external-tools.md +0 -154
  301. package/src/modules/bmb/workflows/create-workflow/steps/step-07-installation-guidance.md +0 -159
  302. package/src/modules/bmb/workflows/create-workflow/steps/step-08-tools-summary.md +0 -167
  303. package/src/modules/bmb/workflows/create-workflow/steps/step-10-plan-review.md +0 -215
  304. package/src/modules/bmb/workflows/create-workflow/templates/build-summary.md +0 -36
  305. package/src/modules/bmb/workflows/create-workflow/templates/completion-section.md +0 -39
  306. package/src/modules/bmb/workflows/create-workflow/templates/content-template.md +0 -21
  307. package/src/modules/bmb/workflows/create-workflow/templates/design-section.md +0 -53
  308. package/src/modules/bmb/workflows/create-workflow/templates/project-info.md +0 -18
  309. package/src/modules/bmb/workflows/create-workflow/templates/requirements-section.md +0 -47
  310. package/src/modules/bmb/workflows/create-workflow/templates/review-section.md +0 -56
  311. package/src/modules/bmb/workflows/create-workflow/templates/workflow-plan.md +0 -54
  312. package/src/modules/bmb/workflows-legacy/create-module/README.md +0 -229
  313. package/src/modules/bmb/workflows-legacy/create-module/brainstorm-context.md +0 -137
  314. package/src/modules/bmb/workflows-legacy/create-module/checklist.md +0 -235
  315. package/src/modules/bmb/workflows-legacy/create-module/installer-templates/install-config.yaml +0 -92
  316. package/src/modules/bmb/workflows-legacy/create-module/installer-templates/installer.js +0 -231
  317. package/src/modules/bmb/workflows-legacy/create-module/instructions.md +0 -577
  318. package/src/modules/bmb/workflows-legacy/create-module/module-structure.md +0 -400
  319. package/src/modules/bmb/workflows-legacy/create-module/workflow.yaml +0 -52
  320. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/epics-template.md +0 -80
  321. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/instructions.md +0 -387
  322. package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.yaml +0 -53
  323. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/checklist.md +0 -169
  324. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/instructions.md +0 -332
  325. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/template.md +0 -146
  326. package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml +0 -64
  327. package/tools/cli/commands/agent-install.js +0 -409
  328. package/tools/cli/commands/cleanup.js +0 -141
  329. /package/{custom/src → example-custom-content}/agents/commit-poet/commit-poet.agent.yaml +0 -0
  330. /package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/bundlers.md +0 -0
  331. /package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/deploy.md +0 -0
  332. /package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md +0 -0
  333. /package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md +0 -0
  334. /package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md +0 -0
  335. /package/{custom/src → example-custom-content}/agents/toolsmith/toolsmith-sidecar/knowledge/tests.md +0 -0
@@ -0,0 +1,223 @@
1
+ # BMAD Workflow Step 1B Continuation Template
2
+
3
+ This template provides the standard structure for workflow continuation steps. It handles resuming workflows that were started but not completed, ensuring seamless continuation across multiple sessions.
4
+
5
+ Use this template alongside **step-01-init-continuable-template.md** to create workflows that can be paused and resumed. The init template handles the detection and routing logic, while this template handles the resumption logic.
6
+
7
+ <!-- TEMPLATE START -->
8
+
9
+ ---
10
+
11
+ name: 'step-01b-continue'
12
+ description: 'Handle workflow continuation from previous session'
13
+
14
+ <!-- Path Definitions -->
15
+
16
+ workflow*path: '{project-root}/{\_bmad_folder*}/[module-path]/workflows/[workflow-name]'
17
+
18
+ # File References (all use {variable} format in file)
19
+
20
+ thisStepFile: '{workflow_path}/steps/step-01b-continue.md'
21
+ outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
22
+ workflowFile: '{workflow_path}/workflow.md'
23
+
24
+ # Template References (if needed for analysis)
25
+
26
+ ## analysisTemplate: '{workflow_path}/templates/[some-template].md'
27
+
28
+ # Step 1B: Workflow Continuation
29
+
30
+ ## STEP GOAL:
31
+
32
+ To resume the [workflow-type] workflow from where it was left off, ensuring smooth continuation without loss of context or progress.
33
+
34
+ ## MANDATORY EXECUTION RULES (READ FIRST):
35
+
36
+ ### Universal Rules:
37
+
38
+ - 🛑 NEVER generate content without user input
39
+ - 📖 CRITICAL: Read the complete step file before taking any action
40
+ - 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
41
+ - 📋 YOU ARE A FACILITATOR, not a content generator
42
+
43
+ ### Role Reinforcement:
44
+
45
+ - ✅ You are a [specific role, e.g., "business analyst" or "technical architect"]
46
+ - ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
47
+ - ✅ We engage in collaborative dialogue, not command-response
48
+ - ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than we could on our own
49
+ - ✅ Maintain collaborative [adjective] tone throughout
50
+
51
+ ### Step-Specific Rules:
52
+
53
+ - 🎯 Focus ONLY on analyzing and resuming workflow state
54
+ - 🚫 FORBIDDEN to modify content completed in previous steps
55
+ - 💬 Maintain continuity with previous sessions
56
+ - 🚪 DETECT exact continuation point from frontmatter of incomplete file {outputFile}
57
+
58
+ ## EXECUTION PROTOCOLS:
59
+
60
+ - 🎯 Show your analysis of current state before taking action
61
+ - 💾 Keep existing frontmatter `stepsCompleted` values intact
62
+ - 📖 Review the template content already generated in {outputFile}
63
+ - 🚫 FORBIDDEN to modify content that was completed in previous steps
64
+ - 📝 Update frontmatter with continuation timestamp when resuming
65
+
66
+ ## CONTEXT BOUNDARIES:
67
+
68
+ - Current [output-file-name] document is already loaded
69
+ - Previous context = complete template + existing frontmatter
70
+ - [Key data collected] already gathered in previous sessions
71
+ - Last completed step = last value in `stepsCompleted` array from frontmatter
72
+
73
+ ## CONTINUATION SEQUENCE:
74
+
75
+ ### 1. Analyze Current State
76
+
77
+ Review the frontmatter of {outputFile} to understand:
78
+
79
+ - `stepsCompleted`: Which steps are already done (the rightmost value is the last step completed)
80
+ - `lastStep`: Name/description of last completed step (if exists)
81
+ - `date`: Original workflow start date
82
+ - `inputDocuments`: Any documents loaded during initialization
83
+ - [Other relevant frontmatter fields]
84
+
85
+ Example: If `stepsCompleted: [1, 2, 3, 4]`, then step 4 was the last completed step.
86
+
87
+ ### 2. Read All Completed Step Files
88
+
89
+ For each step number in `stepsCompleted` array (excluding step 1, which is init):
90
+
91
+ 1. **Construct step filename**: `step-[N]-[name].md`
92
+ 2. **Read the complete step file** to understand:
93
+ - What that step accomplished
94
+ - What the next step should be (from nextStep references)
95
+ - Any specific context or decisions made
96
+
97
+ Example: If `stepsCompleted: [1, 2, 3]`:
98
+
99
+ - Read `step-02-[name].md`
100
+ - Read `step-03-[name].md`
101
+ - The last file will tell you what step-04 should be
102
+
103
+ ### 3. Review Previous Output
104
+
105
+ Read the complete {outputFile} to understand:
106
+
107
+ - Content generated so far
108
+ - Sections completed vs pending
109
+ - User decisions and preferences
110
+ - Current state of the deliverable
111
+
112
+ ### 4. Determine Next Step
113
+
114
+ Based on the last completed step file:
115
+
116
+ 1. **Find the nextStep reference** in the last completed step file
117
+ 2. **Validate the file exists** at the referenced path
118
+ 3. **Confirm the workflow is incomplete** (not all steps finished)
119
+
120
+ ### 5. Welcome Back Dialog
121
+
122
+ Present a warm, context-aware welcome:
123
+
124
+ "Welcome back! I see we've completed [X] steps of your [workflow-type].
125
+
126
+ We last worked on [brief description of last step].
127
+
128
+ Based on our progress, we're ready to continue with [next step description].
129
+
130
+ Are you ready to continue where we left off?"
131
+
132
+ ### 6. Validate Continuation Intent
133
+
134
+ Ask confirmation questions if needed:
135
+
136
+ "Has anything changed since our last session that might affect our approach?"
137
+ "Are you still aligned with the goals and decisions we made earlier?"
138
+ "Would you like to review what we've accomplished so far?"
139
+
140
+ ### 7. Present MENU OPTIONS
141
+
142
+ Display: "**Resuming workflow - Select an Option:** [C] Continue to [Next Step Name]"
143
+
144
+ #### EXECUTION RULES:
145
+
146
+ - ALWAYS halt and wait for user input after presenting menu
147
+ - ONLY proceed to next step when user selects 'C'
148
+ - User can chat or ask questions - always respond and then end with display again of the menu options
149
+ - Update frontmatter with continuation timestamp when 'C' is selected
150
+
151
+ #### Menu Handling Logic:
152
+
153
+ - IF C:
154
+ 1. Update frontmatter: add `lastContinued: [current date]`
155
+ 2. Load, read entire file, then execute the appropriate next step file (determined in section 4)
156
+ - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
157
+
158
+ ## CRITICAL STEP COMPLETION NOTE
159
+
160
+ ONLY WHEN C is selected and continuation analysis is complete, will you then:
161
+
162
+ 1. Update frontmatter in {outputFile} with continuation timestamp
163
+ 2. Load, read entire file, then execute the next step file determined from the analysis
164
+
165
+ Do NOT modify any other content in the output document during this continuation step.
166
+
167
+ ## 🚨 SYSTEM SUCCESS/FAILURE METRICS
168
+
169
+ ### ✅ SUCCESS:
170
+
171
+ - Correctly identified last completed step from `stepsCompleted` array
172
+ - Read and understood all previous step contexts
173
+ - User confirmed readiness to continue
174
+ - Frontmatter updated with continuation timestamp
175
+ - Workflow resumed at appropriate next step
176
+
177
+ ### ❌ SYSTEM FAILURE:
178
+
179
+ - Skipping analysis of existing state
180
+ - Modifying content from previous steps
181
+ - Loading wrong next step file
182
+ - Not updating frontmatter with continuation info
183
+ - Proceeding without user confirmation
184
+
185
+ **Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
186
+
187
+ <!-- TEMPLATE END -->
188
+
189
+ ## Customization Guidelines
190
+
191
+ When adapting this template for your specific workflow:
192
+
193
+ ### 1. Update Placeholders
194
+
195
+ Replace bracketed placeholders with your specific values:
196
+
197
+ - `[module-path]` - e.g., "bmb/reference" or "custom"
198
+ - `[workflow-name]` - your workflow directory name
199
+ - `[workflow-type]` - e.g., "nutrition planning", "project requirements"
200
+ - `[output-file-name]` - base name for output document
201
+ - `[specific role]` - the role this workflow plays
202
+ - `[your expertise]` - what expertise you bring
203
+ - `[their expertise]` - what expertise user brings
204
+
205
+ ### 2. Add Workflow-Specific Context
206
+
207
+ Add any workflow-specific fields to section 1 (Analyze Current State) if your workflow uses additional frontmatter fields for tracking.
208
+
209
+ ### 3. Customize Welcome Message
210
+
211
+ Adapt the welcome dialog in section 5 to match your workflow's tone and context.
212
+
213
+ ### 4. Add Continuation-Specific Validations
214
+
215
+ If your workflow has specific checkpoints or validation requirements, add them to section 6.
216
+
217
+ ## Implementation Notes
218
+
219
+ 1. **This step should NEVER modify the output content** - only analyze and prepare for continuation
220
+ 2. **Always preserve the `stepsCompleted` array** - don't modify it in this step
221
+ 3. **Timestamp tracking** - helps users understand when workflows were resumed
222
+ 4. **Context preservation** - the key is maintaining all previous work and decisions
223
+ 5. **Seamless experience** - user should feel like they never left the workflow
@@ -3,7 +3,7 @@ name: "step-{{stepNumber}}-{{stepName}}"
3
3
  description: "{{stepDescription}}"
4
4
 
5
5
  # Path Definitions
6
- workflow_path: "{project-root}/{bmad_folder}/{{targetModule}}/workflows/{{workflowName}}"
6
+ workflow_path: "{project-root}/{*bmad_folder*}/{{targetModule}}/workflows/{{workflowName}}"
7
7
 
8
8
  # File References
9
9
  thisStepFile: "{workflow_path}/steps/step-{{stepNumber}}-{{stepName}}.md"
@@ -15,9 +15,9 @@ workflowFile: "{workflow_path}/workflow.md"
15
15
  outputFile: "{output_folder}/{{outputFileName}}-{project_name}.md"
16
16
  {{/hasOutput}}
17
17
 
18
- # Task References
19
- advancedElicitationTask: "{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml"
20
- partyModeWorkflow: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md"
18
+ # Task References (list only if used in THIS step file instance and only the ones used, there might be others)
19
+ advancedElicitationTask: "{project-root}/{*bmad_folder*}/core/tasks/advanced-elicitation.xml"
20
+ partyModeWorkflow: "{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.md"
21
21
 
22
22
  {{#hasTemplates}}
23
23
  # Template References
@@ -2,33 +2,43 @@
2
2
 
3
3
  This template provides the standard structure for all BMAD workflow step files. Copy and modify this template for each new step you create.
4
4
 
5
- ---
5
+ <!-- TEMPLATE START -->
6
6
 
7
- ```yaml
8
7
  ---
8
+
9
9
  name: 'step-[N]-[short-name]'
10
10
  description: '[Brief description of what this step accomplishes]'
11
11
 
12
- # Path Definitions
13
- workflow_path: '{project-root}/{bmad_folder}/bmb/reference/workflows/[workflow-name]'
12
+ <!-- Path Definitions -->
13
+
14
+ workflow*path: '{project-root}/{\_bmad_folder*}/bmb/reference/workflows/[workflow-name]' # the folder the workflow.md file is in
14
15
 
15
16
  # File References (all use {variable} format in file)
17
+
16
18
  thisStepFile: '{workflow_path}/steps/step-[N]-[short-name].md'
17
- nextStepFile: '{workflow_path}/steps/step-[N+1]-[next-short-name].md' # Remove for final step
19
+ nextStep{N+1}: '{workflow_path}/steps/step-[N+1]-[next-short-name].md' # Remove for final step or no next step
20
+ altStep{Y}: '{workflow_path}/steps/step-[Y]-[some-other-step].md' # if there is an alternate next story depending on logic
18
21
  workflowFile: '{workflow_path}/workflow.md'
19
22
  outputFile: '{output_folder}/[output-file-name]-{project_name}.md'
20
23
 
21
- # Task References
22
- advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
23
- partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
24
+ # Task References (IF THE workflow uses and it makes sense in this step to have these )
25
+
26
+ advancedElicitationTask: '{project-root}/{_bmad_folder_}/core/tasks/advanced-elicitation.xml'
27
+ partyModeWorkflow: '{project-root}/{_bmad_folder_}/core/workflows/party-mode/workflow.md'
28
+
29
+ # Template References (if this step uses a specific templates)
24
30
 
25
- # Template References (if this step uses templates)
26
31
  profileTemplate: '{workflow_path}/templates/profile-section.md'
27
32
  assessmentTemplate: '{workflow_path}/templates/assessment-section.md'
28
33
  strategyTemplate: '{workflow_path}/templates/strategy-section.md'
29
- # Add more as needed
34
+
35
+ # Data (CSV for example) References (if used in this step)
36
+
37
+ someData: '{workflow_path}/data/foo.csv'
38
+
39
+ # Add more as needed - but ONLY what is used in this specific step file!
40
+
30
41
  ---
31
- ```
32
42
 
33
43
  # Step [N]: [Step Name]
34
44
 
@@ -52,7 +62,7 @@ Example: "To analyze user requirements and document functional specifications th
52
62
  - ✅ You are a [specific role, e.g., "business analyst" or "technical architect"]
53
63
  - ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
54
64
  - ✅ We engage in collaborative dialogue, not command-response
55
- - ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than the sum of our own parts
65
+ - ✅ You bring [your expertise], user brings [their expertise], and together we produce something better than we could on our own
56
66
  - ✅ Maintain collaborative [adjective] tone throughout
57
67
 
58
68
  ### Step-Specific Rules:
@@ -88,15 +98,10 @@ Example: "To analyze user requirements and document functional specifications th
88
98
 
89
99
  [Specific instructions for second part of the work]
90
100
 
91
- #### Content to Append (if applicable):
101
+ ### N. Title (as many as needed)
92
102
 
93
- ```markdown
94
- ## [Section Title]
95
-
96
- [Content template or instructions for what to append]
97
- ```
98
-
99
- ### N. (Continue as needed)
103
+ <!-- not ever step will include advanced elicitation or party mode, in which case generally will just have the C option -->
104
+ <!-- for example an init step 1 that loads data, or step 1b continues a workflow would not need advanced elicitation or party mode - but any step where the user and the llm work together on content, thats where it makes sense to include them -->
100
105
 
101
106
  ### N. Present MENU OPTIONS
102
107
 
@@ -105,7 +110,7 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont
105
110
  #### Menu Handling Logic:
106
111
 
107
112
  - IF A: Execute {advancedElicitationTask} # Or custom action
108
- - IF P: Execute {partyModeWorkflow}
113
+ - IF P: Execute {partyModeWorkflow} # Or custom action
109
114
  - IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
110
115
  - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
111
116
 
@@ -113,8 +118,8 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont
113
118
 
114
119
  - ALWAYS halt and wait for user input after presenting menu
115
120
  - ONLY proceed to next step when user selects 'C'
116
- - After other menu items execution, return to this menu
117
- - User can chat or ask questions - always respond and then end with display again of the menu options
121
+ - After other menu items execution completes, redisplay the menu
122
+ - User can chat or ask questions - always respond when conversation ends, redisplay the menu
118
123
 
119
124
  ## CRITICAL STEP COMPLETION NOTE
120
125
 
@@ -122,8 +127,6 @@ Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Cont
122
127
 
123
128
  ONLY WHEN [C continue option] is selected and [completion requirements], will you then load and read fully `[installed_path]/step-[next-number]-[name].md` to execute and begin [next step description].
124
129
 
125
- ---
126
-
127
130
  ## 🚨 SYSTEM SUCCESS/FAILURE METRICS
128
131
 
129
132
  ### ✅ SUCCESS:
@@ -140,15 +143,19 @@ ONLY WHEN [C continue option] is selected and [completion requirements], will yo
140
143
  - [Step-specific failure mode 2]
141
144
  - Proceeding without user input/selection
142
145
  - Not updating required documents/frontmatter
143
- - [General failure modes]
146
+ - [Step-specific failure mode N]
144
147
 
145
148
  **Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
146
149
 
147
- ---
150
+ <!-- TEMPLATE END-->
151
+
152
+ ## Common Menu Patterns to use in the final sequence item in a step file
153
+
154
+ FYI Again - party mode is useful for the user to reach out and get opinions from other agents.
148
155
 
149
- ## Common Menu Patterns
156
+ Advanced elicitation is use to direct you to think of alternative outputs of a sequence you just performed.
150
157
 
151
- ### Standard Menu (A/P/C)
158
+ ### Standard Menu - when a sequence in a step results in content produced by the agent or human that could be improved before proceeding
152
159
 
153
160
  ```markdown
154
161
  ### N. Present MENU OPTIONS
@@ -170,7 +177,7 @@ Display: "**Select an Option:** [A] [Advanced Elicitation] [P] Party Mode [C] Co
170
177
  - User can chat or ask questions - always respond and then end with display again of the menu options
171
178
  ```
172
179
 
173
- ### Auto-Proceed Menu (No User Choice)
180
+ ### Optional Menu - Auto-Proceed Menu (No User Choice or confirm, just flow right to the next step once completed)
174
181
 
175
182
  ```markdown
176
183
  ### N. Present MENU OPTIONS
@@ -196,8 +203,8 @@ Display: "**Select an Option:** [A] [Custom Action 1] [B] [Custom Action 2] [C]
196
203
 
197
204
  #### Menu Handling Logic:
198
205
 
199
- - IF A: [Custom handler for option A]
200
- - IF B: [Custom handler for option B]
206
+ - IF A: [Custom handler route for option A]
207
+ - IF B: [Custom handler route for option B]
201
208
  - IF C: Save content to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
202
209
  - IF Any other comments or queries: help user respond then [Redisplay Menu Options](#n-present-menu-options)
203
210
 
@@ -214,7 +221,7 @@ Display: "**Select an Option:** [A] [Custom Action 1] [B] [Custom Action 2] [C]
214
221
  ```markdown
215
222
  ### N. Present MENU OPTIONS
216
223
 
217
- Display: "**Select an Option:** [A] [Custom Label] [C] Continue"
224
+ Display: "**Select an Option:** [A] [Continue to Step Foo] [A] [Continue to Step Bar]"
218
225
 
219
226
  #### Menu Handling Logic:
220
227
 
@@ -0,0 +1,104 @@
1
+ # BMAD Workflow Template
2
+
3
+ This template provides the standard structure for all BMAD workflow files. Copy and modify this template for each new workflow you create.
4
+
5
+ <!-- TEMPLATE START -->
6
+
7
+ ---
8
+
9
+ name: [WORKFLOW_DISPLAY_NAME]
10
+ description: [Brief description of what this workflow accomplishes]
11
+ web_bundle: [true/false] # Set to true for inclusion in web bundle builds
12
+
13
+ ---
14
+
15
+ # [WORKFLOW_DISPLAY_NAME]
16
+
17
+ **Goal:** [State the primary goal of this workflow in one clear sentence]
18
+
19
+ **Your Role:** In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals.
20
+
21
+ ## WORKFLOW ARCHITECTURE
22
+
23
+ ### Core Principles
24
+
25
+ - **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
26
+ - **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - never load future step files until told to do so
27
+ - **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
28
+ - **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
29
+ - **Append-Only Building**: Build documents by appending content as directed to the output file
30
+
31
+ ### Step Processing Rules
32
+
33
+ 1. **READ COMPLETELY**: Always read the entire step file before taking any action
34
+ 2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
35
+ 3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
36
+ 4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
37
+ 5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
38
+ 6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
39
+
40
+ ### Critical Rules (NO EXCEPTIONS)
41
+
42
+ - 🛑 **NEVER** load multiple step files simultaneously
43
+ - 📖 **ALWAYS** read entire step file before execution
44
+ - 🚫 **NEVER** skip steps or optimize the sequence
45
+ - 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
46
+ - 🎯 **ALWAYS** follow the exact instructions in the step file
47
+ - ⏸️ **ALWAYS** halt at menus and wait for user input
48
+ - 📋 **NEVER** create mental todo lists from future steps
49
+
50
+ ---
51
+
52
+ ## INITIALIZATION SEQUENCE
53
+
54
+ ### 1. Module Configuration Loading
55
+
56
+ Load and read full config from {project-root}/{_bmad_folder_}/[MODULE FOLDER]/config.yaml and resolve:
57
+
58
+ - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [MODULE VARS]
59
+
60
+ ### 2. First Step EXECUTION
61
+
62
+ Load, read the full file and then execute [FIRST STEP FILE PATH] to begin the workflow.
63
+
64
+ <!-- TEMPLATE END -->
65
+
66
+ ## How to Use This Template
67
+
68
+ ### Step 1: Copy and Replace Placeholders
69
+
70
+ Copy the template above and replace:
71
+
72
+ - `[WORKFLOW_DISPLAY_NAME]` → Your workflow's display name
73
+ - `[MODULE FOLDER]` → Default is `core` unless this is for another module (such as bmm, cis, or another as directed by user)
74
+ - `[Brief description]` → One-sentence description
75
+ - `[true/false]` → Whether to include in web bundle
76
+ - `[role]` → AI's role in this workflow
77
+ - `[user type]` → Who the user is
78
+ - `[CONFIG_PATH]` → Path to config file (usually `bmm/config.yaml` or `bmb/config.yaml`)
79
+ - `[WORKFLOW_PATH]` → Path to your workflow folder
80
+ - `[MODULE VARS]` → Extra config variables available in a module configuration that the workflow would need to use
81
+
82
+ ### Step 2: Create the Folder Structure
83
+
84
+ ```
85
+ [workflow-folder]/
86
+ ├── workflow.md # This file
87
+ ├── data/ # (Optional csv or other data files)
88
+ ├── templates/ # template files for output
89
+ └── steps/
90
+ ├── step-01-init.md
91
+ ├── step-02-[name].md
92
+ └── ...
93
+
94
+ ```
95
+
96
+ ### Step 3: Configure the Initialization Path
97
+
98
+ Update the last line of the workflow.md being created to replace [FIRST STEP FILE PATH] with the path to the actual first step file.
99
+
100
+ Example: Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
101
+
102
+ ### NOTE: You can View a real example of a perfect workflow.md file that was created from this template
103
+
104
+ `{project-root}/{bmad_folder}/bmb/reference/workflows/meal-prep-nutrition/workflow.md`
@@ -49,7 +49,7 @@ This uses **step-file architecture** for disciplined execution:
49
49
 
50
50
  ### 1. Configuration Loading
51
51
 
52
- Load and read full config from {project-root}/{bmad_folder}/{{targetModule}}/config.yaml and resolve:
52
+ Load and read full config from {project-root}/{_bmad_folder_}/{{targetModule}}/config.yaml and resolve:
53
53
 
54
54
  - `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
55
55
 
@@ -51,7 +51,7 @@ menu:
51
51
 
52
52
  # Direct sidecar file action
53
53
  - trigger: 'insight'
54
- action: 'Document this breakthrough in {agent-folder}/journal-keeper-sidecar/breakthroughs.md'
54
+ action: 'Document this breakthrough in ./journal-keeper-sidecar/breakthroughs.md'
55
55
  description: 'Record a meaningful insight'
56
56
  ```
57
57
 
@@ -63,9 +63,9 @@ Expert Agents MUST load sidecar files explicitly:
63
63
 
64
64
  ```yaml
65
65
  critical_actions:
66
- - 'Load COMPLETE file {agent-folder}/journal-keeper-sidecar/memories.md'
67
- - 'Load COMPLETE file {agent-folder}/journal-keeper-sidecar/instructions.md'
68
- - 'ONLY read/write files in {agent-folder}/journal-keeper-sidecar/'
66
+ - 'Load COMPLETE file ./journal-keeper-sidecar/memories.md'
67
+ - 'Load COMPLETE file ./journal-keeper-sidecar/instructions.md'
68
+ - 'ONLY read/write files in ./journal-keeper-sidecar/'
69
69
  ```
70
70
 
71
71
  **Key points:**
@@ -20,9 +20,9 @@ agent:
20
20
  - Reflection transforms experience into wisdom
21
21
 
22
22
  critical_actions:
23
- - "Load COMPLETE file {agent-folder}/journal-keeper-sidecar/memories.md and remember all past insights"
24
- - "Load COMPLETE file {agent-folder}/journal-keeper-sidecar/instructions.md and follow ALL journaling protocols"
25
- - "ONLY read/write files in {agent-folder}/journal-keeper-sidecar/ - this is our private space"
23
+ - "Load COMPLETE file {agent_sidecar_folder}/journal-keeper-sidecar/memories.md and remember all past insights"
24
+ - "Load COMPLETE file {agent_sidecar_folder}/journal-keeper-sidecar/instructions.md and follow ALL journaling protocols"
25
+ - "ONLY read/write files in {agent_sidecar_folder}/journal-keeper-sidecar/ - this is our private space"
26
26
  - "Track mood patterns, recurring themes, and breakthrough moments"
27
27
  - "Reference past entries naturally to show continuity"
28
28
 
@@ -120,7 +120,7 @@ agent:
120
120
  description: "Write today's journal entry"
121
121
 
122
122
  - trigger: quick
123
- action: "Save a quick, unstructured entry to {agent-folder}/journal-keeper-sidecar/entries/entry-{date}.md with timestamp and any patterns noticed"
123
+ action: "Save a quick, unstructured entry to {agent_sidecar_folder}/journal-keeper-sidecar/entries/entry-{date}.md with timestamp and any patterns noticed"
124
124
  description: "Quick capture without prompts"
125
125
 
126
126
  - trigger: mood
@@ -133,20 +133,20 @@ agent:
133
133
 
134
134
  - trigger: gratitude
135
135
  action: "#gratitude-moment"
136
- description: "Capture today's gratitudes"
136
+ description: "Capture today's gratitude"
137
137
 
138
138
  - trigger: weekly
139
139
  action: "#weekly-reflection"
140
140
  description: "Reflect on the past week"
141
141
 
142
142
  - trigger: insight
143
- action: "Document this breakthrough in {agent-folder}/journal-keeper-sidecar/breakthroughs.md with date and significance"
143
+ action: "Document this breakthrough in {agent_sidecar_folder}/journal-keeper-sidecar/breakthroughs.md with date and significance"
144
144
  description: "Record a meaningful insight"
145
145
 
146
146
  - trigger: read-back
147
- action: "Load and share entries from {agent-folder}/journal-keeper-sidecar/entries/ for requested timeframe, highlighting themes and growth"
147
+ action: "Load and share entries from {agent_sidecar_folder}/journal-keeper-sidecar/entries/ for requested timeframe, highlighting themes and growth"
148
148
  description: "Review past entries"
149
149
 
150
150
  - trigger: save
151
- action: "Update {agent-folder}/journal-keeper-sidecar/memories.md with today's session insights and emotional markers"
151
+ action: "Update {agent_sidecar_folder}/journal-keeper-sidecar/memories.md with today's session insights and emotional markers"
152
152
  description: "Save what we discussed today"
@@ -10,7 +10,7 @@
10
10
 
11
11
  agent:
12
12
  metadata:
13
- id: "{bmad_folder}/bmm/agents/security-engineer.md"
13
+ id: "{*bmad_folder*}/bmm/agents/security-engineer.md"
14
14
  name: "Sam"
15
15
  title: "Security Engineer"
16
16
  icon: "🔐"
@@ -32,22 +32,22 @@ agent:
32
32
  menu:
33
33
  # NOTE: These workflows are hypothetical examples assuming add to a module called bmm - not implemented
34
34
  - trigger: threat-model
35
- workflow: "{project-root}/{bmad_folder}/bmm/workflows/threat-model/workflow.yaml"
35
+ exec: "{project-root}/{*bmad_folder*}/bmm/workflows/threat-model/workflow.md"
36
36
  description: "Create STRIDE threat model for architecture"
37
37
 
38
38
  - trigger: security-review
39
- workflow: "{project-root}/{bmad_folder}/bmm/workflows/security-review/workflow.yaml"
39
+ exec: "{project-root}/{*bmad_folder*}/bmm/workflows/security-review/workflow.md"
40
40
  description: "Review code/design for security issues"
41
41
 
42
42
  - trigger: owasp-check
43
- exec: "{project-root}/{bmad_folder}/bmm/tasks/owasp-top-10.xml"
43
+ TODO: true
44
44
  description: "Check against OWASP Top 10"
45
45
 
46
46
  - trigger: compliance
47
- workflow: "{project-root}/{bmad_folder}/bmm/workflows/compliance-check/workflow.yaml"
47
+ exec: "{project-root}/{*bmad_folder*}/bmm/workflows/compliance-check/workflow.md"
48
48
  description: "Verify compliance requirements (SOC2, GDPR, etc.)"
49
49
 
50
50
  # Core workflow that exists
51
51
  - trigger: party-mode
52
- exec: "{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md"
52
+ exec: "{project-root}/{*bmad_folder*}/core/workflows/party-mode/workflow.md"
53
53
  description: "Multi-agent security discussion"