bmad-method 6.0.0-alpha.3 → 6.0.0-alpha.4
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.
- package/.claude/commands/bmad/bmm/agents/analyst.md +67 -0
- package/.claude/commands/bmad/bmm/agents/architect.md +73 -0
- package/.claude/commands/bmad/bmm/agents/dev.md +69 -0
- package/.claude/commands/bmad/bmm/agents/paige.md +82 -0
- package/.claude/commands/bmad/bmm/agents/pm.md +76 -0
- package/.claude/commands/bmad/bmm/agents/sm.md +85 -0
- package/.claude/commands/bmad/bmm/agents/tea.md +72 -0
- package/.claude/commands/bmad/bmm/agents/ux-designer.md +71 -0
- package/.claude/commands/bmad/bmm/workflows/README.md +132 -0
- package/.claude/commands/bmad/bmm/workflows/architecture.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/brainstorm-project.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/code-review.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/correct-course.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/create-epics-and-stories.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/create-story.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/create-ux-design.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/dev-story.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/document-project.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/narrative.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/prd.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/product-brief.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/research.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/retrospective.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/solutioning-gate-check.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/sprint-planning.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/story-context.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/story-done.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/story-ready.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/tech-spec-sm.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/tech-spec.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/workflow-init.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/workflow-status.md +15 -0
- package/.claude/commands/bmad/cis/agents/README.md +104 -0
- package/.claude/commands/bmad/cis/agents/brainstorming-coach.md +62 -0
- package/.claude/commands/bmad/cis/agents/creative-problem-solver.md +62 -0
- package/.claude/commands/bmad/cis/agents/design-thinking-coach.md +62 -0
- package/.claude/commands/bmad/cis/agents/innovation-strategist.md +62 -0
- package/.claude/commands/bmad/cis/agents/storyteller.md +59 -0
- package/.claude/commands/bmad/cis/workflows/README.md +37 -0
- package/.claude/commands/bmad/cis/workflows/design-thinking.md +15 -0
- package/.claude/commands/bmad/cis/workflows/innovation-strategy.md +15 -0
- package/.claude/commands/bmad/cis/workflows/problem-solving.md +15 -0
- package/.claude/commands/bmad/cis/workflows/storytelling.md +15 -0
- package/.claude/settings.local.json +10 -41
- package/CHANGELOG.md +239 -0
- package/README.md +219 -103
- package/bmad/_cfg/agent-manifest.csv +13 -4
- package/bmad/_cfg/agents/bmm-dev.customize.yaml +42 -0
- package/bmad/_cfg/agents/bmm-paige.customize.yaml +42 -0
- package/bmad/_cfg/agents/bmm-pm.customize.yaml +42 -0
- package/bmad/_cfg/agents/bmm-sm.customize.yaml +42 -0
- package/bmad/_cfg/agents/bmm-tea.customize.yaml +42 -0
- package/bmad/_cfg/agents/bmm-ux-designer.customize.yaml +42 -0
- package/bmad/_cfg/agents/cis-brainstorming-coach.customize.yaml +42 -0
- package/bmad/_cfg/agents/cis-creative-problem-solver.customize.yaml +42 -0
- package/bmad/_cfg/agents/cis-design-thinking-coach.customize.yaml +42 -0
- package/bmad/_cfg/agents/cis-innovation-strategist.customize.yaml +42 -0
- package/bmad/_cfg/agents/cis-storyteller.customize.yaml +42 -0
- package/bmad/_cfg/files-manifest.csv +289 -22
- package/bmad/_cfg/ides/claude-code.yaml +6 -0
- package/bmad/_cfg/manifest.yaml +5 -6
- package/bmad/_cfg/task-manifest.csv +2 -0
- package/bmad/_cfg/workflow-manifest.csv +35 -2
- package/bmad/bmb/README.md +135 -73
- package/bmad/bmb/agents/bmad-builder.md.bak +70 -0
- package/bmad/bmb/config.yaml +2 -2
- package/bmad/bmb/workflows/audit-workflow/workflow.yaml.bak +3 -1
- package/bmad/bmb/workflows/create-agent/README.md +126 -243
- package/bmad/bmb/workflows/create-agent/instructions.md +25 -12
- package/bmad/bmb/workflows/create-module/README.md +163 -154
- package/bmad/bmb/workflows/create-module/workflow.yaml.bak +2 -0
- package/bmad/bmb/workflows/create-workflow/instructions.md +16 -8
- package/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md +158 -0
- package/bmad/bmb/workflows/create-workflow/workflow.yaml.bak +2 -0
- package/bmad/bmb/workflows/edit-agent/workflow.yaml.bak +33 -0
- package/bmad/bmb/workflows/edit-module/workflow.yaml.bak +34 -0
- package/bmad/bmb/workflows/edit-workflow/workflow.yaml.bak +2 -0
- package/bmad/bmb/workflows/module-brief/workflow.yaml.bak +2 -0
- package/bmad/bmb/workflows/redoc/workflow.yaml.bak +1 -0
- package/bmad/bmm/README.md +169 -0
- package/bmad/bmm/agents/analyst.md +67 -0
- package/bmad/bmm/agents/architect.md +73 -0
- package/bmad/bmm/agents/dev.md +69 -0
- package/bmad/bmm/agents/paige.md +82 -0
- package/bmad/bmm/agents/pm.md +76 -0
- package/bmad/bmm/agents/sm.md +85 -0
- package/bmad/bmm/agents/tea.md +72 -0
- package/bmad/bmm/agents/ux-designer.md +71 -0
- package/bmad/bmm/config.yaml +17 -0
- package/bmad/bmm/docs/quick-spec-flow.md +645 -0
- package/bmad/bmm/docs/scale-adaptive-system.md +1045 -0
- package/bmad/bmm/tasks/daily-standup.xml +85 -0
- package/bmad/bmm/teams/team-fullstack.yaml +11 -0
- package/bmad/bmm/teams/team-gamedev.yaml +14 -0
- package/bmad/bmm/testarch/knowledge/ci-burn-in.md +675 -0
- package/bmad/bmm/testarch/knowledge/component-tdd.md +486 -0
- package/bmad/bmm/testarch/knowledge/contract-testing.md +957 -0
- package/bmad/bmm/testarch/knowledge/data-factories.md +500 -0
- package/bmad/bmm/testarch/knowledge/email-auth.md +721 -0
- package/bmad/bmm/testarch/knowledge/error-handling.md +725 -0
- package/bmad/bmm/testarch/knowledge/feature-flags.md +750 -0
- package/bmad/bmm/testarch/knowledge/fixture-architecture.md +401 -0
- package/bmad/bmm/testarch/knowledge/network-first.md +486 -0
- package/bmad/bmm/testarch/knowledge/nfr-criteria.md +670 -0
- package/bmad/bmm/testarch/knowledge/playwright-config.md +730 -0
- package/bmad/bmm/testarch/knowledge/probability-impact.md +601 -0
- package/bmad/bmm/testarch/knowledge/risk-governance.md +615 -0
- package/bmad/bmm/testarch/knowledge/selective-testing.md +732 -0
- package/bmad/bmm/testarch/knowledge/selector-resilience.md +527 -0
- package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
- package/bmad/bmm/testarch/knowledge/test-levels-framework.md +473 -0
- package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/bmad/bmm/testarch/knowledge/test-quality.md +664 -0
- package/bmad/bmm/testarch/knowledge/timing-debugging.md +372 -0
- package/bmad/bmm/testarch/knowledge/visual-debugging.md +524 -0
- package/bmad/bmm/testarch/tea-index.csv +22 -0
- package/bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md +110 -0
- package/bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md +25 -0
- package/bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +26 -0
- package/bmad/bmm/workflows/1-analysis/domain-research/instructions.md +423 -0
- package/bmad/bmm/workflows/1-analysis/domain-research/template.md +180 -0
- package/bmad/bmm/workflows/1-analysis/domain-research/workflow.yaml +36 -0
- package/bmad/bmm/workflows/1-analysis/product-brief/checklist.md +115 -0
- package/bmad/bmm/workflows/1-analysis/product-brief/instructions.md +524 -0
- package/bmad/bmm/workflows/1-analysis/product-brief/template.md +181 -0
- package/bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml +45 -0
- package/bmad/bmm/workflows/1-analysis/research/checklist-deep-prompt.md +144 -0
- package/bmad/bmm/workflows/1-analysis/research/checklist-technical.md +249 -0
- package/bmad/bmm/workflows/1-analysis/research/checklist.md +299 -0
- package/bmad/bmm/workflows/1-analysis/research/claude-code/injections.yaml +114 -0
- package/bmad/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +439 -0
- package/bmad/bmm/workflows/1-analysis/research/instructions-market.md +679 -0
- package/bmad/bmm/workflows/1-analysis/research/instructions-router.md +133 -0
- package/bmad/bmm/workflows/1-analysis/research/instructions-technical.md +538 -0
- package/bmad/bmm/workflows/1-analysis/research/template-deep-prompt.md +94 -0
- package/bmad/bmm/workflows/1-analysis/research/template-market.md +347 -0
- package/bmad/bmm/workflows/1-analysis/research/template-technical.md +245 -0
- package/bmad/bmm/workflows/1-analysis/research/workflow.yaml +44 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md +310 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1319 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +145 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +64 -0
- package/bmad/bmm/workflows/2-plan-workflows/narrative/checklist.md +139 -0
- package/bmad/bmm/workflows/2-plan-workflows/narrative/instructions-narrative.md +608 -0
- package/bmad/bmm/workflows/2-plan-workflows/narrative/narrative-template.md +195 -0
- package/bmad/bmm/workflows/2-plan-workflows/narrative/workflow.yaml +29 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/checklist.md +349 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +395 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +33 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +13 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/instructions.md +423 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +237 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +11 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml +46 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/checklist.md +214 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +58 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-level0-story.md +200 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-level1-stories.md +451 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1133 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md +181 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +87 -0
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +60 -0
- package/bmad/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml +347 -0
- package/bmad/bmm/workflows/3-solutioning/architecture/architecture-template.md +103 -0
- package/bmad/bmm/workflows/3-solutioning/architecture/checklist.md +244 -0
- package/bmad/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml +222 -0
- package/bmad/bmm/workflows/3-solutioning/architecture/instructions.md +715 -0
- package/bmad/bmm/workflows/3-solutioning/architecture/pattern-categories.csv +13 -0
- package/bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml +67 -0
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/checklist.md +175 -0
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +322 -0
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/template.md +146 -0
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/validation-criteria.yaml +189 -0
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +64 -0
- package/bmad/bmm/workflows/4-implementation/code-review/backlog_template.md +12 -0
- package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +22 -0
- package/bmad/bmm/workflows/4-implementation/code-review/instructions.md +420 -0
- package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +74 -0
- package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +279 -0
- package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +201 -0
- package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +43 -0
- package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +240 -0
- package/bmad/bmm/workflows/4-implementation/create-story/instructions.md +283 -0
- package/bmad/bmm/workflows/4-implementation/create-story/template.md +51 -0
- package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +74 -0
- package/bmad/bmm/workflows/4-implementation/dev-story/AUDIT-REPORT.md +367 -0
- package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +38 -0
- package/bmad/bmm/workflows/4-implementation/dev-story/instructions.md +262 -0
- package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +26 -0
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/checklist.md +17 -0
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/instructions.md +189 -0
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/template.md +76 -0
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +58 -0
- package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1460 -0
- package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +71 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +238 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +47 -0
- package/bmad/bmm/workflows/4-implementation/story-context/checklist.md +16 -0
- package/bmad/bmm/workflows/4-implementation/story-context/context-template.xml +34 -0
- package/bmad/bmm/workflows/4-implementation/story-context/instructions.md +234 -0
- package/bmad/bmm/workflows/4-implementation/story-context/workflow.yaml +57 -0
- package/bmad/bmm/workflows/4-implementation/story-done/instructions.md +111 -0
- package/bmad/bmm/workflows/4-implementation/story-done/workflow.yaml +25 -0
- package/bmad/bmm/workflows/4-implementation/story-ready/instructions.md +117 -0
- package/bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml +25 -0
- package/{src/modules → bmad}/bmm/workflows/README.md +41 -0
- package/bmad/bmm/workflows/document-project/checklist.md +245 -0
- package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -0
- package/bmad/bmm/workflows/document-project/instructions.md +222 -0
- package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
- package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -0
- package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
- package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
- package/bmad/bmm/workflows/document-project/workflow.yaml +34 -0
- package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
- package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
- package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
- package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
- package/bmad/bmm/workflows/techdoc/documentation-standards.md +238 -0
- package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +363 -0
- package/bmad/bmm/workflows/testarch/atdd/checklist.md +373 -0
- package/bmad/bmm/workflows/testarch/atdd/instructions.md +785 -0
- package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +52 -0
- package/bmad/bmm/workflows/testarch/automate/checklist.md +580 -0
- package/bmad/bmm/workflows/testarch/automate/instructions.md +1303 -0
- package/bmad/bmm/workflows/testarch/automate/workflow.yaml +61 -0
- package/bmad/bmm/workflows/testarch/ci/checklist.md +246 -0
- package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +165 -0
- package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +128 -0
- package/bmad/bmm/workflows/testarch/ci/instructions.md +517 -0
- package/bmad/bmm/workflows/testarch/ci/workflow.yaml +53 -0
- package/bmad/bmm/workflows/testarch/framework/checklist.md +321 -0
- package/bmad/bmm/workflows/testarch/framework/instructions.md +455 -0
- package/bmad/bmm/workflows/testarch/framework/workflow.yaml +53 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +405 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +722 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +443 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +56 -0
- package/bmad/bmm/workflows/testarch/test-design/checklist.md +234 -0
- package/bmad/bmm/workflows/testarch/test-design/instructions.md +621 -0
- package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +285 -0
- package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +52 -0
- package/bmad/bmm/workflows/testarch/test-review/checklist.md +470 -0
- package/bmad/bmm/workflows/testarch/test-review/instructions.md +608 -0
- package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +388 -0
- package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +53 -0
- package/bmad/bmm/workflows/testarch/trace/checklist.md +654 -0
- package/bmad/bmm/workflows/testarch/trace/instructions.md +1045 -0
- package/bmad/bmm/workflows/testarch/trace/trace-template.md +673 -0
- package/bmad/bmm/workflows/testarch/trace/workflow.yaml +66 -0
- package/bmad/bmm/workflows/workflow-status/init/instructions.md +390 -0
- package/bmad/bmm/workflows/workflow-status/init/workflow.yaml +27 -0
- package/bmad/bmm/workflows/workflow-status/instructions.md +386 -0
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +54 -0
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml +58 -0
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +76 -0
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml +95 -0
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +88 -0
- package/bmad/bmm/workflows/workflow-status/paths/game-design.yaml +75 -0
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +45 -0
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-1.yaml +49 -0
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml +78 -0
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +73 -0
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +75 -0
- package/bmad/bmm/workflows/workflow-status/project-levels.yaml +59 -0
- package/bmad/bmm/workflows/workflow-status/sample-level-3-workflow.yaml +49 -0
- package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +31 -0
- package/bmad/bmm/workflows/workflow-status/workflow.yaml +28 -0
- package/bmad/cis/README.md +153 -0
- package/bmad/cis/agents/README.md +104 -0
- package/bmad/cis/agents/brainstorming-coach.md +62 -0
- package/bmad/cis/agents/creative-problem-solver.md +62 -0
- package/bmad/cis/agents/design-thinking-coach.md +62 -0
- package/bmad/cis/agents/innovation-strategist.md +62 -0
- package/bmad/cis/agents/storyteller.md +59 -0
- package/bmad/{bmd → cis}/config.yaml +3 -3
- package/bmad/cis/teams/creative-squad.yaml +6 -0
- package/bmad/cis/workflows/README.md +139 -0
- package/bmad/cis/workflows/design-thinking/README.md +56 -0
- package/bmad/cis/workflows/design-thinking/design-methods.csv +31 -0
- package/bmad/cis/workflows/design-thinking/instructions.md +200 -0
- package/bmad/cis/workflows/design-thinking/template.md +111 -0
- package/bmad/cis/workflows/design-thinking/workflow.yaml +32 -0
- package/bmad/cis/workflows/innovation-strategy/README.md +56 -0
- package/bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv +31 -0
- package/bmad/cis/workflows/innovation-strategy/instructions.md +274 -0
- package/bmad/cis/workflows/innovation-strategy/template.md +189 -0
- package/bmad/cis/workflows/innovation-strategy/workflow.yaml +32 -0
- package/bmad/cis/workflows/problem-solving/README.md +56 -0
- package/bmad/cis/workflows/problem-solving/instructions.md +250 -0
- package/bmad/cis/workflows/problem-solving/solving-methods.csv +31 -0
- package/bmad/cis/workflows/problem-solving/template.md +165 -0
- package/bmad/cis/workflows/problem-solving/workflow.yaml +32 -0
- package/bmad/cis/workflows/storytelling/README.md +58 -0
- package/bmad/cis/workflows/storytelling/instructions.md +291 -0
- package/bmad/cis/workflows/storytelling/story-types.csv +26 -0
- package/bmad/cis/workflows/storytelling/template.md +113 -0
- package/bmad/cis/workflows/storytelling/workflow.yaml +32 -0
- package/bmad/core/agents/bmad-master.md.bak +69 -0
- package/bmad/core/config.yaml +2 -2
- package/bmad/core/tasks/workflow.xml +0 -8
- package/bmad/core/tools/shard-doc.xml +8 -43
- package/docs/document-sharding-guide.md +447 -0
- package/docs/index.md +37 -41
- package/package.json +1 -1
- package/src/core/tools/shard-doc.xml +8 -43
- package/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md +158 -0
- package/src/modules/bmm/README.md +79 -95
- package/src/modules/bmm/agents/game-designer.agent.yaml +2 -2
- package/src/modules/bmm/agents/paige.agent.yaml +69 -0
- package/src/modules/bmm/agents/pm.agent.yaml +11 -1
- package/src/modules/bmm/docs/README.md +235 -0
- package/src/modules/bmm/docs/agents-guide.md +1109 -0
- package/src/modules/bmm/docs/brownfield-guide.md +638 -0
- package/src/modules/bmm/docs/brownfield-guide.md.backup +1324 -0
- package/src/modules/bmm/docs/enterprise-agentic-development.md +1040 -0
- package/src/modules/bmm/docs/faq.md +589 -0
- package/src/modules/bmm/docs/glossary.md +327 -0
- package/src/modules/bmm/docs/party-mode.md +1236 -0
- package/src/modules/bmm/docs/quick-spec-flow.md +652 -0
- package/src/modules/bmm/docs/quick-start.md +366 -0
- package/src/modules/bmm/docs/scale-adaptive-system.md +749 -0
- package/src/modules/bmm/docs/troubleshooting.md +680 -0
- package/src/modules/bmm/docs/workflow-architecture-reference.md +371 -0
- package/src/modules/bmm/docs/workflow-document-project-reference.md +487 -0
- package/src/modules/bmm/docs/workflows-analysis.md +670 -0
- package/src/modules/bmm/docs/workflows-implementation.md +1759 -0
- package/src/modules/bmm/docs/workflows-planning.md +1086 -0
- package/src/modules/bmm/docs/workflows-solutioning.md +726 -0
- package/src/modules/bmm/docs/workflows-testing.md +1572 -0
- package/src/modules/bmm/workflows/1-analysis/domain-research/instructions.md +423 -0
- package/src/modules/bmm/workflows/1-analysis/domain-research/template.md +180 -0
- package/src/modules/bmm/workflows/1-analysis/domain-research/workflow.yaml +36 -0
- package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +405 -213
- package/src/modules/bmm/workflows/1-analysis/product-brief/template.md +93 -77
- package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +14 -0
- package/src/modules/bmm/workflows/1-analysis/research/checklist-deep-prompt.md +144 -0
- package/src/modules/bmm/workflows/1-analysis/research/checklist-technical.md +249 -0
- package/src/modules/bmm/workflows/1-analysis/research/checklist.md +154 -57
- package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +45 -29
- package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +181 -104
- package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +24 -32
- package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +94 -46
- package/src/modules/bmm/workflows/1-analysis/research/template-market.md +37 -1
- package/src/modules/bmm/workflows/1-analysis/research/template-technical.md +36 -1
- package/src/modules/bmm/workflows/1-analysis/research/workflow.yaml +13 -0
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +18 -0
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml +22 -0
- package/src/modules/bmm/workflows/2-plan-workflows/gdd/instructions-gdd.md +18 -0
- package/src/modules/bmm/workflows/2-plan-workflows/gdd/workflow.yaml +14 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/checklist.md +295 -63
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +63 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +395 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +43 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +13 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +283 -291
- package/src/modules/bmm/workflows/2-plan-workflows/prd/prd-template.md +198 -23
- package/src/modules/bmm/workflows/2-plan-workflows/prd/project-types.csv +11 -0
- package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +24 -6
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/checklist.md +138 -31
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +51 -4
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions-level0-story.md +50 -17
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions-level1-stories.md +199 -26
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +988 -108
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md +132 -6
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +36 -5
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +21 -0
- package/src/modules/bmm/workflows/3-solutioning/architecture/architecture-template.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +51 -32
- package/src/modules/bmm/workflows/3-solutioning/architecture/workflow.yaml +17 -4
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +18 -0
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +26 -0
- package/src/modules/bmm/workflows/4-implementation/code-review/instructions.md +29 -0
- package/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml +20 -0
- package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +29 -0
- package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +27 -0
- package/src/modules/bmm/workflows/4-implementation/epic-tech-context/instructions.md +29 -0
- package/src/modules/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +31 -5
- package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +1222 -241
- package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +28 -0
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/instructions.md +17 -0
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +8 -0
- package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +31 -1
- package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +27 -0
- package/src/modules/bmm/workflows/techdoc/documentation-standards.md +239 -0
- package/tools/cli/commands/install.js +1 -1
- package/.claude/commands/bmad/bmd/agents/cli-chief.md +0 -108
- package/.claude/commands/bmad/bmd/agents/doc-keeper.md +0 -115
- package/.claude/commands/bmad/bmd/agents/release-chief.md +0 -109
- package/.claude/hooks/bmad-tts-injector.sh +0 -415
- package/.claude/hooks/bmad-voice-manager.sh +0 -511
- package/.claude/hooks/check-output-style.sh +0 -112
- package/.claude/hooks/download-extra-voices.sh +0 -244
- package/.claude/hooks/github-star-reminder.sh +0 -154
- package/.claude/hooks/language-manager.sh +0 -392
- package/.claude/hooks/learn-manager.sh +0 -475
- package/.claude/hooks/personality-manager.sh +0 -438
- package/.claude/hooks/piper-download-voices.sh +0 -165
- package/.claude/hooks/piper-installer.sh +0 -178
- package/.claude/hooks/piper-multispeaker-registry.sh +0 -165
- package/.claude/hooks/piper-voice-manager.sh +0 -293
- package/.claude/hooks/play-tts-elevenlabs.sh +0 -404
- package/.claude/hooks/play-tts-piper.sh +0 -338
- package/.claude/hooks/play-tts.sh +0 -100
- package/.claude/hooks/provider-commands.sh +0 -540
- package/.claude/hooks/provider-manager.sh +0 -298
- package/.claude/hooks/replay-target-audio.sh +0 -95
- package/.claude/hooks/sentiment-manager.sh +0 -201
- package/.claude/hooks/speed-manager.sh +0 -291
- package/.claude/hooks/voice-manager.sh +0 -594
- package/.claude/hooks/voices-config.sh +0 -70
- package/bmad/_cfg/agents/bmd-cli-chief.customize.yaml +0 -32
- package/bmad/bmb/workflows/create-agent/agent-architecture.md.bak +0 -412
- package/bmad/bmb/workflows/create-agent/agent-command-patterns.md.bak +0 -759
- package/bmad/bmb/workflows/create-module/README.md.bak +0 -218
- package/bmad/bmb/workflows/create-module/checklist.md.bak +0 -245
- package/bmad/bmb/workflows/create-module/installer-templates/installer.js.bak +0 -231
- package/bmad/bmb/workflows/create-module/instructions.md.bak +0 -521
- package/bmad/bmb/workflows/create-module/module-structure.md.bak +0 -310
- package/bmad/bmd/README.md +0 -193
- package/bmad/bmd/README.md.bak +0 -193
- package/bmad/bmd/agents/cli-chief-sidecar/instructions.md +0 -102
- package/bmad/bmd/agents/cli-chief-sidecar/instructions.md.bak +0 -102
- package/bmad/bmd/agents/cli-chief-sidecar/knowledge/README.md +0 -68
- package/bmad/bmd/agents/cli-chief-sidecar/knowledge/README.md.bak +0 -68
- package/bmad/bmd/agents/cli-chief-sidecar/knowledge/cli-reference.md +0 -123
- package/bmad/bmd/agents/cli-chief-sidecar/knowledge/cli-reference.md.bak +0 -123
- package/bmad/bmd/agents/cli-chief-sidecar/memories.md +0 -53
- package/bmad/bmd/agents/cli-chief-sidecar/memories.md.bak +0 -53
- package/bmad/bmd/agents/cli-chief.md +0 -108
- package/bmad/bmd/agents/cli-chief.md.bak +0 -108
- package/bmad/bmd/agents/doc-keeper-sidecar/instructions.md +0 -177
- package/bmad/bmd/agents/doc-keeper-sidecar/instructions.md.bak +0 -177
- package/bmad/bmd/agents/doc-keeper-sidecar/knowledge/README.md +0 -81
- package/bmad/bmd/agents/doc-keeper-sidecar/knowledge/README.md.bak +0 -81
- package/bmad/bmd/agents/doc-keeper-sidecar/memories.md +0 -88
- package/bmad/bmd/agents/doc-keeper-sidecar/memories.md.bak +0 -88
- package/bmad/bmd/agents/doc-keeper.md +0 -115
- package/bmad/bmd/agents/doc-keeper.md.bak +0 -115
- package/bmad/bmd/agents/release-chief-sidecar/instructions.md +0 -164
- package/bmad/bmd/agents/release-chief-sidecar/instructions.md.bak +0 -164
- package/bmad/bmd/agents/release-chief-sidecar/knowledge/README.md +0 -82
- package/bmad/bmd/agents/release-chief-sidecar/knowledge/README.md.bak +0 -82
- package/bmad/bmd/agents/release-chief-sidecar/memories.md +0 -73
- package/bmad/bmd/agents/release-chief-sidecar/memories.md.bak +0 -73
- package/bmad/bmd/agents/release-chief.md +0 -109
- package/bmad/bmd/agents/release-chief.md.bak +0 -109
- package/bmad/docs/codex-instructions.md +0 -21
- package/docs/conversion-report-shard-doc-2025-10-26.md +0 -188
- package/src/modules/bmm/workflows/1-analysis/brainstorm-game/README.md +0 -38
- package/src/modules/bmm/workflows/1-analysis/game-brief/README.md +0 -221
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-competitor-analyzer.md +0 -259
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-data-analyst.md +0 -190
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-market-researcher.md +0 -337
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-trend-spotter.md +0 -107
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-user-researcher.md +0 -329
- package/src/modules/bmm/workflows/2-plan-workflows/gdd/README.md +0 -222
- /package/bmad/_cfg/agents/{bmd-doc-keeper.customize.yaml → bmm-analyst.customize.yaml} +0 -0
- /package/bmad/_cfg/agents/{bmd-release-chief.customize.yaml → bmm-architect.customize.yaml} +0 -0
- /package/{docs/bmad-brownfield-guide.md → bmad/bmm/docs/brownfield-guide.md} +0 -0
- /package/{docs/BMad-Method-V6-Quick-Start.md → bmad/bmm/docs/quick-start.md} +0 -0
- /package/{src/modules → bmad}/bmm/tasks/retrospective.xml +0 -0
- /package/{src/modules → bmad}/bmm/testarch/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/1-analysis/product-brief/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/1-analysis/research/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/2-plan-workflows/README.md +0 -0
- /package/{src/modules/bmm/workflows/2-plan-workflows/prd → bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories}/epics-template.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/3-solutioning/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/3-solutioning/architecture/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/code-review/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/correct-course/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/create-story/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/dev-story/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/retrospective/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/sprint-planning/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/4-implementation/story-context/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/document-project/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/document-project/templates/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/atdd/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/automate/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/ci/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/framework/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/nfr-assess/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/test-design/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/test-review/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/testarch/trace/README.md +0 -0
- /package/{src/modules → bmad}/bmm/workflows/workflow-status/README.md +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,245 @@
|
|
|
2
2
|
|
|
3
3
|
## [Unreleased]
|
|
4
4
|
|
|
5
|
+
## [6.0.0-alpha.4]
|
|
6
|
+
|
|
7
|
+
**Release: November 2, 2025**
|
|
8
|
+
|
|
9
|
+
This alpha release represents a major leap forward in documentation, workflow intelligence, and usability. The BMM module now features professional documentation, context-aware planning workflows, and universal document management capabilities.
|
|
10
|
+
|
|
11
|
+
### 📚 Complete Documentation Overhaul
|
|
12
|
+
|
|
13
|
+
**New Documentation Hub** (`src/modules/bmm/docs/`)
|
|
14
|
+
|
|
15
|
+
- Created centralized documentation system with 18 comprehensive guides (7000+ lines)
|
|
16
|
+
- Clear learning paths for greenfield, brownfield, and quick spec flows
|
|
17
|
+
- Professional technical writing standards throughout all documentation
|
|
18
|
+
- Reading time estimates and cross-referenced navigation
|
|
19
|
+
|
|
20
|
+
**New Documentation Files:**
|
|
21
|
+
|
|
22
|
+
- `README.md` - Complete documentation hub with topic navigation
|
|
23
|
+
- `quick-start.md` - 15-minute getting started guide
|
|
24
|
+
- `agents-guide.md` - Comprehensive 12-agent reference (45 min read)
|
|
25
|
+
- `party-mode.md` - Multi-agent collaboration guide (20 min read)
|
|
26
|
+
- `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read)
|
|
27
|
+
- `brownfield-guide.md` - Existing codebase development (53 min read)
|
|
28
|
+
- `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read)
|
|
29
|
+
- `workflows-analysis.md` - Phase 1 workflows deep-dive (12 min read)
|
|
30
|
+
- `workflows-planning.md` - Phase 2 workflows deep-dive (19 min read)
|
|
31
|
+
- `workflows-solutioning.md` - Phase 3 workflows deep-dive (13 min read)
|
|
32
|
+
- `workflows-implementation.md` - Phase 4 workflows deep-dive (33 min read)
|
|
33
|
+
- `workflows-testing.md` - Testing & QA workflows (29 min read)
|
|
34
|
+
- `workflow-architecture-reference.md` - Architecture workflow technical reference
|
|
35
|
+
- `workflow-document-project-reference.md` - Document-project workflow technical reference
|
|
36
|
+
- `enterprise-agentic-development.md` - Team collaboration patterns
|
|
37
|
+
- `faq.md` - Comprehensive Q&A covering all common questions
|
|
38
|
+
- `glossary.md` - Complete BMM terminology reference
|
|
39
|
+
- `troubleshooting.md` - Common issues and solutions guide
|
|
40
|
+
|
|
41
|
+
**Documentation Improvements:**
|
|
42
|
+
|
|
43
|
+
- Removed version/date footers (git handles versioning automatically)
|
|
44
|
+
- Agent customization docs now include full rebuild process
|
|
45
|
+
- Consistent professional formatting and structure across all docs
|
|
46
|
+
- Better separation of user documentation vs developer reference
|
|
47
|
+
|
|
48
|
+
### 🤖 New Agent: Paige (Documentation Guide)
|
|
49
|
+
|
|
50
|
+
Introduced Paige, a specialized technical documentation agent:
|
|
51
|
+
|
|
52
|
+
- **Expertise:** Professional technical writing, information architecture, documentation structure
|
|
53
|
+
- **Integration:** Available across all BMM phases for continuous documentation support
|
|
54
|
+
- **Customizable:** Like all BMM agents, can be customized via sidecar files
|
|
55
|
+
- **Status:** Work in progress - will evolve as documentation needs grow
|
|
56
|
+
|
|
57
|
+
### 🚀 Quick Spec Flow - Intelligent Level 0-1 Planning
|
|
58
|
+
|
|
59
|
+
**Major Tech-Spec Workflow Transformation:**
|
|
60
|
+
|
|
61
|
+
- Transformed from template-filling into context-aware intelligent planning system
|
|
62
|
+
- Ideal for bug fixes, single endpoint additions, and small isolated changes
|
|
63
|
+
- Auto-detects project stack (package.json, requirements.txt, etc.)
|
|
64
|
+
- Analyzes brownfield codebases for conventions and patterns
|
|
65
|
+
- Integrates WebSearch for current framework versions and best practices
|
|
66
|
+
|
|
67
|
+
**Context-Aware Intelligence:**
|
|
68
|
+
|
|
69
|
+
- Interactive level detection (Level 0 vs Level 1)
|
|
70
|
+
- Brownfield convention detection with user confirmation
|
|
71
|
+
- Comprehensive context discovery (stack, patterns, dependencies, test frameworks)
|
|
72
|
+
- Auto-validation with quality scoring (no manual checklist needed)
|
|
73
|
+
- UX/UI considerations capture for user-facing changes
|
|
74
|
+
|
|
75
|
+
**Enhanced Tech-Spec Template:**
|
|
76
|
+
|
|
77
|
+
- Expanded from 8 to 23 sections for complete planning context
|
|
78
|
+
- New sections: Development Context, UX/UI Considerations, Integration Points
|
|
79
|
+
- Developer Resources section with file paths and testing guidance
|
|
80
|
+
- All sections populated via template-output tags during workflow
|
|
81
|
+
|
|
82
|
+
**Story Generation Improvements:**
|
|
83
|
+
|
|
84
|
+
- Level 0: Extract single story from comprehensive tech-spec
|
|
85
|
+
- Level 1: Story sequence validation with acceptance criteria quality checks
|
|
86
|
+
- User Story Template includes Dev Agent Record sections for implementation tracking
|
|
87
|
+
- Complete epic template rewrite with proper variable structure
|
|
88
|
+
|
|
89
|
+
**Phase 4 Integration:**
|
|
90
|
+
|
|
91
|
+
- Story Context and Create Story workflows now recognize tech-spec as authoritative source
|
|
92
|
+
- Seamless integration between Quick Spec Flow and traditional BMM workflows
|
|
93
|
+
- Tech-spec provides brownfield analysis, framework details, and existing patterns
|
|
94
|
+
|
|
95
|
+
### 📦 Universal Document Sharding
|
|
96
|
+
|
|
97
|
+
**New Capability: Shard-Doc Workflow**
|
|
98
|
+
|
|
99
|
+
- Split large markdown documents into organized, smaller files based on sections
|
|
100
|
+
- Dual-strategy loading: include individual shards OR single large document
|
|
101
|
+
- Configurable section level (default: level 2 headings)
|
|
102
|
+
- Automatic index.md generation with navigation links
|
|
103
|
+
- Ideal for large guides, API documentation, and knowledge bases
|
|
104
|
+
|
|
105
|
+
**Use Cases:**
|
|
106
|
+
|
|
107
|
+
- Breaking down massive planning documents for better context management
|
|
108
|
+
- Creating navigable documentation hierarchies
|
|
109
|
+
- Managing agent knowledge bases efficiently
|
|
110
|
+
- Optimizing context window usage during development
|
|
111
|
+
|
|
112
|
+
**Integration:**
|
|
113
|
+
|
|
114
|
+
- Available as BMad Core workflow: `/bmad:core:tools:shard-doc`
|
|
115
|
+
- Works with any markdown document in your project
|
|
116
|
+
- Preserves original file with automatic backups
|
|
117
|
+
- Generated shards maintain formatting and structure
|
|
118
|
+
|
|
119
|
+
### 🔧 Planning Workflow Enhancements
|
|
120
|
+
|
|
121
|
+
**Intent-Driven Discovery (Product Brief & PRD):**
|
|
122
|
+
|
|
123
|
+
- Transformed from rigid template-filling to natural conversational discovery
|
|
124
|
+
- Adaptive questioning based on project context (hobby/startup/enterprise)
|
|
125
|
+
- Real-time document building instead of end-of-session generation
|
|
126
|
+
- Skill-level aware facilitation (expert/intermediate/beginner)
|
|
127
|
+
- Context detection from user responses to guide exploration depth
|
|
128
|
+
|
|
129
|
+
**Product Brief Workflow (96% BMAD v6 compliance):**
|
|
130
|
+
|
|
131
|
+
- Intent-driven facilitation with context-appropriate probing
|
|
132
|
+
- Living document approach with continuous template updates
|
|
133
|
+
- Enhanced discovery areas: problem exploration, solution vision, user understanding
|
|
134
|
+
- Ruthless MVP scope management with feature prioritization
|
|
135
|
+
- Template improvements with context-aware conditional sections
|
|
136
|
+
|
|
137
|
+
**PRD Workflow (improved from 65% to 85%+ compliance):**
|
|
138
|
+
|
|
139
|
+
- Fixed critical config issues (missing date variable, status file extension mismatch)
|
|
140
|
+
- Scale-adaptive intelligence with project type detection (API/Web App/Mobile/SaaS)
|
|
141
|
+
- Domain complexity mapping (14 domain types with specialized considerations)
|
|
142
|
+
- Enhanced requirements coverage: project-type specific sections, domain considerations
|
|
143
|
+
- Separated epic planning into dedicated create-epics-and-stories child workflow
|
|
144
|
+
|
|
145
|
+
**Architecture Workflow:**
|
|
146
|
+
|
|
147
|
+
- Better integration with PRD outputs
|
|
148
|
+
- Domain complexity context support
|
|
149
|
+
- Enhanced technical decision capture framework
|
|
150
|
+
|
|
151
|
+
### 🛠️ Research Workflow Improvements
|
|
152
|
+
|
|
153
|
+
**Enhanced Research Capabilities:**
|
|
154
|
+
|
|
155
|
+
- Updated to use web search more frequently for current information
|
|
156
|
+
- Better understanding of current date context for finding latest documentation
|
|
157
|
+
- Improved deep research prompt generation options
|
|
158
|
+
- More accurate and up-to-date research results
|
|
159
|
+
|
|
160
|
+
### 🎨 User Experience Improvements
|
|
161
|
+
|
|
162
|
+
**Installer Updates:**
|
|
163
|
+
|
|
164
|
+
- Improved installation notes and guidance
|
|
165
|
+
- Better command examples (shard-doc uses npx command pattern)
|
|
166
|
+
|
|
167
|
+
**Workflow Cleanup:**
|
|
168
|
+
|
|
169
|
+
- Removed unused voice hooks functionality
|
|
170
|
+
- Cleaned up backup and temporary files
|
|
171
|
+
- Better workflow naming consistency
|
|
172
|
+
|
|
173
|
+
### 📋 Infrastructure & Quality
|
|
174
|
+
|
|
175
|
+
**Agent & Workflow Manifests:**
|
|
176
|
+
|
|
177
|
+
- Added Paige to agent manifest
|
|
178
|
+
- Updated workflow manifest with new and restructured workflows
|
|
179
|
+
- Better workflow-to-agent mappings across all documentation
|
|
180
|
+
- Updated files manifest with all new documentation
|
|
181
|
+
|
|
182
|
+
**Module Organization:**
|
|
183
|
+
|
|
184
|
+
- Streamlined BMM README to lean signpost format
|
|
185
|
+
- Polished root README with better hierarchy and clear CTAs
|
|
186
|
+
- Moved documentation from root `docs/` to module-specific locations
|
|
187
|
+
- Better separation of user docs vs developer reference
|
|
188
|
+
|
|
189
|
+
**Data Infrastructure:**
|
|
190
|
+
|
|
191
|
+
- New CSV data files for project types and domain complexity
|
|
192
|
+
- Enhanced workflow configuration with runtime variables
|
|
193
|
+
- Better template variable mapping and tracking
|
|
194
|
+
|
|
195
|
+
### 🔄 Breaking Changes
|
|
196
|
+
|
|
197
|
+
**File Removals:**
|
|
198
|
+
|
|
199
|
+
- Removed `src/modules/bmm/workflows/2-plan-workflows/prd/epics-template.md` (replaced by create-epics-and-stories child workflow)
|
|
200
|
+
|
|
201
|
+
**Workflow Trigger Changes:**
|
|
202
|
+
|
|
203
|
+
- PM agent: `prd` → `create-prd`
|
|
204
|
+
- New workflow triggers: `create-epics-and-stories`, `validate-prd`
|
|
205
|
+
- Game Designer agent triggers renamed for consistency
|
|
206
|
+
|
|
207
|
+
### 📖 What's Next (Beta Roadmap)
|
|
208
|
+
|
|
209
|
+
- Knowledge base integration for enhanced context management
|
|
210
|
+
- Web bundle functionality completion
|
|
211
|
+
- Additional specialized agents based on community feedback
|
|
212
|
+
- Enhanced multi-agent collaboration patterns
|
|
213
|
+
- Performance optimizations for large projects
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
### Installation
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
npx bmad-method@6.0.0-alpha.4 install
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
For upgrading from alpha.3:
|
|
224
|
+
|
|
225
|
+
```bash
|
|
226
|
+
# Backup your customizations first
|
|
227
|
+
npx bmad-method@6.0.0-alpha.4 install
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Migration Notes
|
|
231
|
+
|
|
232
|
+
If upgrading from v6.0.0-alpha.3:
|
|
233
|
+
|
|
234
|
+
1. New documentation is available in `bmad/bmm/docs/` - review the README.md for navigation
|
|
235
|
+
2. Tech-spec workflow now has enhanced capabilities - review `docs/quick-spec-flow.md`
|
|
236
|
+
3. Product Brief and PRD workflows have new conversational approaches
|
|
237
|
+
4. Paige agent is now available for documentation tasks
|
|
238
|
+
5. No breaking changes to existing project structures
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
## [6.0.0-alpha.3]
|
|
243
|
+
|
|
5
244
|
### Codex Installer
|
|
6
245
|
|
|
7
246
|
- Codex installer uses custom prompts in `.codex/prompts/`, instead of `AGENTS.md`
|
package/README.md
CHANGED
|
@@ -5,204 +5,320 @@
|
|
|
5
5
|
[](https://nodejs.org)
|
|
6
6
|
[](https://discord.gg/gk8jAdXWmj)
|
|
7
7
|
|
|
8
|
-
> **🚨
|
|
8
|
+
> **🚨 Alpha Version Notice**
|
|
9
|
+
>
|
|
10
|
+
> v6-alpha is near-beta quality—stable and vastly improved over v4, but documentation is still being refined. New videos coming soon to the [BMadCode YouTube channel](https://www.youtube.com/@BMadCode)—subscribe for updates!
|
|
11
|
+
>
|
|
12
|
+
> **Getting Started:**
|
|
9
13
|
>
|
|
10
14
|
> - **Install v6 Alpha:** `npx bmad-method@alpha install`
|
|
11
15
|
> - **Install stable v4:** `npx bmad-method install`
|
|
12
|
-
> - **
|
|
16
|
+
> - **Not sure what to do?** Load any agent and run `*workflow-init` for guided setup
|
|
17
|
+
> - **v4 Users:** [View v4 documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4) or [upgrade guide](./docs/v4-to-v6-upgrade.md)
|
|
13
18
|
|
|
14
19
|
## Universal Human-AI Collaboration Platform
|
|
15
20
|
|
|
16
|
-
BMad-CORE (**C**ollaboration **O**ptimized **R**eflection **E**ngine) amplifies human potential through specialized AI agents. Unlike tools that replace thinking, BMad-CORE guides reflective workflows that bring out your best ideas and AI's full capabilities.
|
|
21
|
+
**BMad-CORE** (**C**ollaboration **O**ptimized **R**eflection **E**ngine) amplifies human potential through specialized AI agents. Unlike tools that replace thinking, BMad-CORE guides reflective workflows that bring out your best ideas and AI's full capabilities.
|
|
22
|
+
|
|
23
|
+
The **BMad-CORE** powers the **BMad Method** (probably why you're here!), but you can also use **BMad Builder** to create custom agents, workflows, and modules for any domain—software development, business strategy, creativity, learning, and more.
|
|
17
24
|
|
|
18
25
|
**🎯 Human Amplification** • **🎨 Domain Agnostic** • **⚡ Agent-Powered**
|
|
19
26
|
|
|
20
27
|
## Table of Contents
|
|
21
28
|
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
- [
|
|
25
|
-
- [
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
- [
|
|
29
|
-
- [
|
|
30
|
-
- [
|
|
31
|
-
- [
|
|
32
|
-
|
|
33
|
-
|
|
29
|
+
- [BMad CORE + BMad Method](#bmad-core--bmad-method)
|
|
30
|
+
- [Universal Human-AI Collaboration Platform](#universal-human-ai-collaboration-platform)
|
|
31
|
+
- [Table of Contents](#table-of-contents)
|
|
32
|
+
- [What is BMad-CORE?](#what-is-bmad-core)
|
|
33
|
+
- [v6 Core Enhancements](#v6-core-enhancements)
|
|
34
|
+
- [C.O.R.E. Philosophy](#core-philosophy)
|
|
35
|
+
- [Modules](#modules)
|
|
36
|
+
- [BMad Method (BMM) - Agile AI Development](#bmad-method-bmm---agile-ai-development)
|
|
37
|
+
- [v6 Highlights](#v6-highlights)
|
|
38
|
+
- [Quick Start](#quick-start)
|
|
39
|
+
- [⚡ NEW: Quick Spec Flow for Rapid Development](#-new-quick-spec-flow-for-rapid-development)
|
|
40
|
+
- [BMad Builder (BMB) - Create Custom Solutions](#bmad-builder-bmb---create-custom-solutions)
|
|
41
|
+
- [Creative Intelligence Suite (CIS) - Innovation \& Creativity](#creative-intelligence-suite-cis---innovation--creativity)
|
|
42
|
+
- [Installation](#installation)
|
|
43
|
+
- [Project Structure](#project-structure)
|
|
44
|
+
- [Getting Started](#getting-started)
|
|
45
|
+
- [Key Features](#key-features)
|
|
46
|
+
- [🎨 Update-Safe Customization](#-update-safe-customization)
|
|
47
|
+
- [🚀 Intelligent Installation](#-intelligent-installation)
|
|
48
|
+
- [📁 Unified Architecture](#-unified-architecture)
|
|
49
|
+
- [📄 Document Sharding](#-document-sharding)
|
|
50
|
+
- [Documentation](#documentation)
|
|
51
|
+
- [Community \& Support](#community--support)
|
|
52
|
+
- [Contributing](#contributing)
|
|
53
|
+
- [License](#license)
|
|
34
54
|
|
|
35
|
-
|
|
36
|
-
- **Upgrading?** [→ v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)
|
|
55
|
+
---
|
|
37
56
|
|
|
38
57
|
## What is BMad-CORE?
|
|
39
58
|
|
|
40
59
|
Foundation framework powering all BMad modules:
|
|
41
60
|
|
|
42
|
-
- **Agent Orchestration** - Specialized AI personas with
|
|
43
|
-
- **Workflow Engine** - Guided multi-step processes
|
|
44
|
-
- **Modular Architecture** -
|
|
45
|
-
- **IDE Integration** - Works
|
|
46
|
-
- **Update-Safe Customization** -
|
|
61
|
+
- **Agent Orchestration** - Specialized AI personas with domain expertise
|
|
62
|
+
- **Workflow Engine** - Guided multi-step processes with built-in best practices
|
|
63
|
+
- **Modular Architecture** - Extend with domain-specific modules (BMM, BMB, CIS, custom)
|
|
64
|
+
- **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code, and more
|
|
65
|
+
- **Update-Safe Customization** - Your configs persist through all updates
|
|
47
66
|
|
|
48
67
|
### v6 Core Enhancements
|
|
49
68
|
|
|
50
69
|
- **🎨 Agent Customization** - Modify names, roles, personalities via `bmad/_cfg/agents/`
|
|
51
70
|
- **🌐 Multi-Language** - Independent language settings for communication and output
|
|
52
|
-
- **👤 Personalization** - Agents adapt to your name,
|
|
53
|
-
- **🔄 Persistent Config** - Customizations survive
|
|
54
|
-
- **⚙️ Flexible Settings** -
|
|
71
|
+
- **👤 Personalization** - Agents adapt to your name, skill level, and preferences
|
|
72
|
+
- **🔄 Persistent Config** - Customizations survive module updates
|
|
73
|
+
- **⚙️ Flexible Settings** - Configure per-module or globally
|
|
55
74
|
|
|
56
75
|
### C.O.R.E. Philosophy
|
|
57
76
|
|
|
58
|
-
- **C**ollaboration: Human-AI partnership leveraging
|
|
59
|
-
- **O**ptimized:
|
|
60
|
-
- **R**eflection:
|
|
61
|
-
- **E**ngine: Framework orchestrating specialized agents and workflows
|
|
77
|
+
- **C**ollaboration: Human-AI partnership leveraging complementary strengths
|
|
78
|
+
- **O**ptimized: Battle-tested processes for maximum effectiveness
|
|
79
|
+
- **R**eflection: Strategic questioning that unlocks breakthrough solutions
|
|
80
|
+
- **E**ngine: Framework orchestrating 19+ specialized agents and 50+ workflows
|
|
62
81
|
|
|
63
|
-
BMad-CORE helps you **discover better solutions** through
|
|
82
|
+
BMad-CORE doesn't give you answers—it helps you **discover better solutions** through guided reflection.
|
|
64
83
|
|
|
65
84
|
## Modules
|
|
66
85
|
|
|
67
|
-
### BMad Method (BMM) - Agile
|
|
86
|
+
### BMad Method (BMM) - AI-Driven Agile Development
|
|
68
87
|
|
|
69
|
-
AI-driven agile framework
|
|
88
|
+
Revolutionary AI-driven agile framework for software and game development. Automatically adapts from single bug fixes to enterprise-scale systems.
|
|
70
89
|
|
|
71
90
|
#### v6 Highlights
|
|
72
91
|
|
|
73
|
-
**🎯 Scale-Adaptive
|
|
92
|
+
**🎯 Scale-Adaptive Intelligence (Levels 0-4)**
|
|
93
|
+
|
|
94
|
+
Automatically adjusts planning depth and documentation based on project complexity:
|
|
95
|
+
|
|
96
|
+
- **Level 0:** Bug fixes (hours)
|
|
97
|
+
- **Level 1:** Small features (1-10 stories)
|
|
98
|
+
- **Level 2:** Medium projects (5-15 stories)
|
|
99
|
+
- **Level 3:** Complex integration (12-40 stories)
|
|
100
|
+
- **Level 4:** Enterprise scale (40+ stories)
|
|
74
101
|
|
|
75
|
-
-
|
|
76
|
-
- Greenfield & brownfield support with smart context engine
|
|
102
|
+
**🏗️ Four-Phase Methodology**
|
|
77
103
|
|
|
78
|
-
|
|
104
|
+
1. **Phase 1: Analysis** (Optional) - Brainstorming, research, product briefs
|
|
105
|
+
2. **Phase 2: Planning** (Required) - Scale-adaptive PRD/tech-spec/GDD
|
|
106
|
+
3. **Phase 3: Solutioning** (Level 3-4) - Architecture and design decisions
|
|
107
|
+
4. **Phase 4: Implementation** (Iterative) - Story-centric development with just-in-time context
|
|
79
108
|
|
|
80
|
-
|
|
81
|
-
- Engine-specific game development (Unity, Phaser, Godot, Unreal)
|
|
109
|
+
**🤖 12 Specialized Agents**
|
|
82
110
|
|
|
83
|
-
|
|
111
|
+
PM • Analyst • Architect • Scrum Master • Developer • Test Architect (TEA) • UX Designer • Paige (Documentation) • Game Designer • Game Developer • Game Architect • BMad Master (Orchestrator)
|
|
84
112
|
|
|
85
|
-
|
|
86
|
-
2. **Planning** - Scale-adaptive PRD/GDD
|
|
87
|
-
3. **Solutioning** - Architecture and tech specs
|
|
88
|
-
4. **Implementation** - Stories, development, review
|
|
113
|
+
**📚 Documentation**
|
|
89
114
|
|
|
90
|
-
**
|
|
115
|
+
- **[Complete Documentation Hub](./src/modules/bmm/docs/README.md)** - Start here for all BMM guides
|
|
116
|
+
- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - Get building in 15 minutes
|
|
117
|
+
- **[Agents Guide](./src/modules/bmm/docs/agents-guide.md)** - Meet all 12 agents (45 min read)
|
|
118
|
+
- **[34 Workflow Guides](./src/modules/bmm/docs/README.md#-workflow-guides)** - Complete phase-by-phase reference
|
|
119
|
+
- **[BMM Module Overview](./src/modules/bmm/README.md)** - Module structure and quick links
|
|
91
120
|
|
|
92
|
-
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## 🚀 Quick Start
|
|
124
|
+
|
|
125
|
+
**First Time?**
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
npx bmad-method@alpha install
|
|
129
|
+
# Load Analyst agent → *workflow-init
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**Three Paths to Choose From:**
|
|
133
|
+
|
|
134
|
+
1. **⚡ Quick Spec Flow** - Bug fixes and small features (Level 0-1)
|
|
135
|
+
- 🐛 Bug fixes in minutes
|
|
136
|
+
- ✨ Small features (2-3 related changes)
|
|
137
|
+
- 🚀 Rapid prototyping
|
|
138
|
+
- **[→ Quick Spec Flow Guide](./src/modules/bmm/docs/quick-spec-flow.md)**
|
|
139
|
+
|
|
140
|
+
2. **📋 Full BMM Flow** - Medium to enterprise projects (Level 2-4)
|
|
141
|
+
- Complete planning (PRD/GDD)
|
|
142
|
+
- Architecture decisions
|
|
143
|
+
- Story-centric implementation
|
|
144
|
+
- **[→ Complete Quick Start Guide](./src/modules/bmm/docs/quick-start.md)**
|
|
145
|
+
|
|
146
|
+
3. **🏢 Brownfield Projects** - Add to existing codebases
|
|
147
|
+
- Document existing code first
|
|
148
|
+
- Then choose Quick Spec or Full BMM
|
|
149
|
+
- **[→ Brownfield Guide](./src/modules/bmm/docs/brownfield-guide.md)**
|
|
150
|
+
|
|
151
|
+
**Not sure which path?** Run `*workflow-init` and let BMM analyze your project goal and recommend the right approach.
|
|
152
|
+
|
|
153
|
+
**[📚 Learn More: Scale Adaptive System](./src/modules/bmm/docs/scale-adaptive-system.md)** - How BMM adapts from Level 0 to Level 4
|
|
154
|
+
|
|
155
|
+
---
|
|
93
156
|
|
|
94
157
|
### BMad Builder (BMB) - Create Custom Solutions
|
|
95
158
|
|
|
96
|
-
Build
|
|
159
|
+
Build your own agents, workflows, and modules using the BMad-CORE framework.
|
|
160
|
+
|
|
161
|
+
**What You Can Build:**
|
|
162
|
+
|
|
163
|
+
- **Custom Agents** - Domain experts with specialized knowledge
|
|
164
|
+
- **Guided Workflows** - Multi-step processes for any task
|
|
165
|
+
- **Complete Modules** - Full solutions for specific domains
|
|
166
|
+
- **Three Agent Types** - Full module, hybrid, or standalone
|
|
97
167
|
|
|
98
|
-
|
|
99
|
-
- **Workflow Design** - Structured multi-step processes
|
|
100
|
-
- **Module Development** - Complete domain solutions
|
|
101
|
-
- **Three Agent Types** - Full module, hybrid, standalone
|
|
168
|
+
**Perfect For:** Creating domain-specific solutions (legal, medical, finance, education, creative, etc.) or extending BMM with custom development workflows.
|
|
102
169
|
|
|
103
|
-
**Documentation
|
|
170
|
+
**Documentation:**
|
|
104
171
|
|
|
105
|
-
- [
|
|
106
|
-
- [
|
|
107
|
-
- [
|
|
108
|
-
- [
|
|
172
|
+
- **[BMB Module Overview](./src/modules/bmb/README.md)** - Complete reference
|
|
173
|
+
- **[Create Agent Workflow](./src/modules/bmb/workflows/create-agent/README.md)** - Build custom agents
|
|
174
|
+
- **[Create Workflow](./src/modules/bmb/workflows/create-workflow/README.md)** - Design guided processes
|
|
175
|
+
- **[Create Module](./src/modules/bmb/workflows/create-module/README.md)** - Package complete solutions
|
|
109
176
|
|
|
110
177
|
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
|
111
178
|
|
|
112
|
-
AI-powered creative facilitation
|
|
179
|
+
AI-powered creative facilitation using proven methodologies and techniques.
|
|
180
|
+
|
|
181
|
+
**5 Interactive Workflows:**
|
|
182
|
+
|
|
183
|
+
- **Brainstorming** - Generate and refine ideas with 30+ techniques
|
|
184
|
+
- **Design Thinking** - Human-centered problem solving
|
|
185
|
+
- **Problem Solving** - Systematic breakthrough techniques
|
|
186
|
+
- **Innovation Strategy** - Disruptive business model thinking
|
|
187
|
+
- **Storytelling** - Compelling narrative frameworks
|
|
188
|
+
|
|
189
|
+
**5 Specialized Agents:** Each with unique facilitation styles and domain expertise
|
|
113
190
|
|
|
114
|
-
|
|
115
|
-
- **150+ Creative Techniques** - Proven frameworks and methodologies
|
|
116
|
-
- **5 Specialized Agents** - Unique personas and facilitation styles
|
|
117
|
-
- **Shared Resource** - Powers creative workflows in other modules
|
|
191
|
+
**Shared Resource:** CIS workflows are used by other modules (BMM's `brainstorm-project` uses CIS brainstorming)
|
|
118
192
|
|
|
119
|
-
**Documentation
|
|
193
|
+
**Documentation:**
|
|
194
|
+
|
|
195
|
+
- **[CIS Module Overview](./src/modules/cis/README.md)** - Complete reference
|
|
196
|
+
- **[CIS Workflows Guide](./src/modules/cis/workflows/README.md)** - All 5 creative workflows
|
|
197
|
+
|
|
198
|
+
---
|
|
120
199
|
|
|
121
200
|
## Installation
|
|
122
201
|
|
|
123
|
-
**Prerequisites
|
|
202
|
+
**Prerequisites:** Node.js v20+ ([Download](https://nodejs.org))
|
|
124
203
|
|
|
125
204
|
```bash
|
|
126
|
-
#
|
|
205
|
+
# v6 Alpha (recommended for new projects)
|
|
127
206
|
npx bmad-method@alpha install
|
|
128
207
|
|
|
129
|
-
#
|
|
208
|
+
# Stable v4 (production)
|
|
130
209
|
npx bmad-method install
|
|
131
210
|
```
|
|
132
211
|
|
|
133
|
-
Interactive installer
|
|
212
|
+
**Interactive Setup:** The installer walks you through:
|
|
134
213
|
|
|
135
|
-
1. **Project
|
|
136
|
-
2. **Module
|
|
137
|
-
3. **Configuration** -
|
|
138
|
-
4. **IDE
|
|
214
|
+
1. **Project Location** - Where to install (defaults to current directory)
|
|
215
|
+
2. **Module Selection** - Choose BMM, BMB, CIS (or all)
|
|
216
|
+
3. **Configuration** - Your name, language, game dev options
|
|
217
|
+
4. **IDE Integration** - Automatic environment setup
|
|
139
218
|
|
|
140
|
-
|
|
219
|
+
**Result:** Clean, unified `bmad/` folder structure:
|
|
141
220
|
|
|
142
221
|
```
|
|
143
222
|
your-project/
|
|
144
223
|
└── bmad/
|
|
145
|
-
├── core/ # Core framework
|
|
146
|
-
├── bmm/ # BMad Method
|
|
147
|
-
├── bmb/ # BMad Builder
|
|
148
|
-
├── cis/ # Creative Intelligence
|
|
149
|
-
└── _cfg/ # Your customizations
|
|
150
|
-
└── agents/ # Agent
|
|
224
|
+
├── core/ # Core framework + BMad Master agent
|
|
225
|
+
├── bmm/ # BMad Method (12 agents, 34 workflows)
|
|
226
|
+
├── bmb/ # BMad Builder (1 agent, 7 workflows)
|
|
227
|
+
├── cis/ # Creative Intelligence (5 agents, 5 workflows)
|
|
228
|
+
└── _cfg/ # Your customizations (survives updates)
|
|
229
|
+
└── agents/ # Agent customization files
|
|
151
230
|
```
|
|
152
231
|
|
|
153
|
-
|
|
232
|
+
**First Steps After Install:**
|
|
154
233
|
|
|
155
|
-
|
|
234
|
+
Load any agent in your IDE and run `*workflow-init` to set up your project workflow path.
|
|
156
235
|
|
|
157
|
-
|
|
158
|
-
/workflow-init
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
This initializes the workflow system and helps choose your starting point.
|
|
236
|
+
---
|
|
162
237
|
|
|
163
238
|
## Key Features
|
|
164
239
|
|
|
165
240
|
### 🎨 Update-Safe Customization
|
|
166
241
|
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
-
|
|
170
|
-
-
|
|
242
|
+
Modify agents without touching core files:
|
|
243
|
+
|
|
244
|
+
- Override agent names, personalities, expertise via `bmad/_cfg/agents/`
|
|
245
|
+
- Customizations persist through all updates
|
|
246
|
+
- Multi-language support (communication + output)
|
|
247
|
+
- Module-level or global configuration
|
|
171
248
|
|
|
172
249
|
### 🚀 Intelligent Installation
|
|
173
250
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
-
|
|
177
|
-
-
|
|
251
|
+
Smart setup that adapts to your environment:
|
|
252
|
+
|
|
253
|
+
- Auto-detects v4 installations for smooth upgrades
|
|
254
|
+
- Configures IDE integrations (Claude Code, Cursor, Windsurf, VS Code)
|
|
255
|
+
- Resolves cross-module dependencies
|
|
256
|
+
- Generates unified agent/workflow manifests
|
|
257
|
+
|
|
258
|
+
### 📁 Clean Architecture
|
|
259
|
+
|
|
260
|
+
Everything in one place:
|
|
261
|
+
|
|
262
|
+
- Single `bmad/` folder (no scattered files)
|
|
263
|
+
- Modules live side-by-side (core, bmm, bmb, cis)
|
|
264
|
+
- Your configs in `_cfg/` (survives updates)
|
|
265
|
+
- Easy to version control or exclude
|
|
266
|
+
|
|
267
|
+
### 📄 Document Sharding (Advanced)
|
|
178
268
|
|
|
179
|
-
|
|
269
|
+
Optional optimization for large projects (Level 3-4):
|
|
180
270
|
|
|
181
|
-
|
|
271
|
+
- **Massive Token Savings** - Phase 4 workflows load only needed sections (90%+ reduction)
|
|
272
|
+
- **Automatic Support** - All workflows handle whole or sharded documents seamlessly
|
|
273
|
+
- **Easy Setup** - Built-in tool splits documents by headings
|
|
274
|
+
- **Smart Discovery** - Workflows auto-detect format
|
|
275
|
+
|
|
276
|
+
**[→ Document Sharding Guide](./docs/document-sharding-guide.md)**
|
|
277
|
+
|
|
278
|
+
---
|
|
182
279
|
|
|
183
280
|
## Documentation
|
|
184
281
|
|
|
185
|
-
|
|
282
|
+
**Module Documentation:**
|
|
283
|
+
|
|
284
|
+
- **[BMM Complete Documentation Hub](./src/modules/bmm/docs/README.md)** - All BMM guides, FAQs, troubleshooting
|
|
285
|
+
- **[BMB Module Reference](./src/modules/bmb/README.md)** - Build custom agents and workflows
|
|
286
|
+
- **[CIS Workflows Guide](./src/modules/cis/workflows/README.md)** - Creative facilitation workflows
|
|
287
|
+
|
|
288
|
+
**Additional Resources:**
|
|
289
|
+
|
|
290
|
+
- **[Documentation Index](./docs/index.md)** - All project documentation
|
|
186
291
|
- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)** - Migration instructions
|
|
187
|
-
- **[CLI Tool Guide](./tools/cli/README.md)** - Installer reference
|
|
188
|
-
- **[Contributing Guide](./CONTRIBUTING.md)** -
|
|
292
|
+
- **[CLI Tool Guide](./tools/cli/README.md)** - Installer and build tool reference
|
|
293
|
+
- **[Contributing Guide](./CONTRIBUTING.md)** - How to contribute
|
|
294
|
+
|
|
295
|
+
---
|
|
189
296
|
|
|
190
297
|
## Community & Support
|
|
191
298
|
|
|
192
|
-
- 💬 **[Discord](https://discord.gg/gk8jAdXWmj)** -
|
|
193
|
-
- 🐛 **[Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** -
|
|
194
|
-
- 🎥 **[YouTube](https://www.youtube.com/@BMadCode)** -
|
|
195
|
-
- ⭐ **[Star this repo](https://github.com/bmad-code-org/BMAD-METHOD)** -
|
|
299
|
+
- 💬 **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects (#general-dev, #bugs-issues)
|
|
300
|
+
- 🐛 **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
|
301
|
+
- 🎥 **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
|
302
|
+
- ⭐ **[Star this repo](https://github.com/bmad-code-org/BMAD-METHOD)** - Stay updated on releases
|
|
303
|
+
|
|
304
|
+
---
|
|
196
305
|
|
|
197
306
|
## Contributing
|
|
198
307
|
|
|
199
|
-
See **[CONTRIBUTING.md](CONTRIBUTING.md)** for
|
|
308
|
+
We welcome contributions! See **[CONTRIBUTING.md](CONTRIBUTING.md)** for:
|
|
309
|
+
|
|
310
|
+
- Code contribution guidelines
|
|
311
|
+
- Documentation improvements
|
|
312
|
+
- Module development
|
|
313
|
+
- Issue reporting
|
|
314
|
+
|
|
315
|
+
---
|
|
200
316
|
|
|
201
317
|
## License
|
|
202
318
|
|
|
203
|
-
MIT License - See [LICENSE](LICENSE)
|
|
319
|
+
**MIT License** - See [LICENSE](LICENSE) for details
|
|
204
320
|
|
|
205
|
-
**
|
|
321
|
+
**Trademarks:** BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
|
|
206
322
|
|
|
207
323
|
---
|
|
208
324
|
|