bmad-method 6.0.0-alpha.14 → 6.0.0-alpha.16
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/.coderabbit.yaml +36 -0
- package/{CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md} +4 -4
- package/CHANGELOG.md +168 -409
- package/README.md +4 -1
- package/docs/agent-customization-guide.md +7 -7
- package/docs/custom-content-installation.md +245 -0
- package/docs/ide-info/crush.md +1 -1
- package/docs/ide-info/cursor.md +7 -7
- package/docs/ide-info/iflow.md +3 -3
- package/docs/ide-info/opencode.md +1 -1
- package/docs/index.md +2 -2
- package/docs/installers-bundlers/ide-injections.md +2 -2
- package/docs/installers-bundlers/installers-modules-platforms-reference.md +29 -28
- package/docs/v4-to-v6-upgrade.md +10 -10
- package/docs/web-bundles-gemini-gpt-guide.md +2 -2
- package/package.json +1 -1
- package/src/core/_module-installer/installer.js +1 -1
- package/src/core/agents/bmad-master.agent.yaml +5 -5
- package/src/core/agents/bmad-web-orchestrator.agent.xml +6 -6
- package/src/core/{_module-installer/install-config.yaml → module.yaml} +0 -7
- package/src/core/resources/excalidraw/README.md +4 -4
- package/src/core/tasks/advanced-elicitation.xml +3 -3
- package/src/core/tasks/index-docs.xml +1 -1
- package/src/core/tasks/validate-workflow.xml +1 -1
- package/src/core/tasks/workflow.xml +4 -4
- package/src/core/tools/shard-doc.xml +1 -1
- package/src/core/workflows/brainstorming/workflow.md +2 -2
- package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +2 -2
- package/src/core/workflows/party-mode/workflow.md +4 -4
- package/src/modules/bmb/README.md +2 -2
- package/src/modules/bmb/_module-installer/installer.js +1 -1
- package/src/modules/bmb/agents/bmad-builder.agent.yaml +15 -15
- package/src/modules/bmb/docs/agents/agent-compilation.md +2 -2
- package/src/modules/bmb/docs/agents/agent-menu-patterns.md +22 -22
- package/src/modules/bmb/docs/agents/expert-agent-architecture.md +1 -1
- package/src/modules/bmb/docs/agents/index.md +2 -2
- package/src/modules/bmb/docs/agents/module-agent-architecture.md +50 -51
- package/src/modules/bmb/docs/agents/understanding-agent-types.md +3 -3
- package/src/modules/bmb/docs/workflows/architecture.md +1 -1
- package/src/modules/bmb/docs/workflows/common-workflow-tools.csv +3 -3
- package/src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md +1 -1
- package/src/modules/bmb/docs/workflows/templates/step-1b-template.md +1 -1
- package/src/modules/bmb/docs/workflows/templates/step-file.md +3 -3
- package/src/modules/bmb/docs/workflows/templates/step-template.md +3 -3
- package/src/modules/bmb/docs/workflows/templates/workflow-template.md +2 -2
- package/src/modules/bmb/docs/workflows/templates/workflow.md +1 -1
- package/src/modules/bmb/{_module-installer/install-config.yaml → module.yaml} +0 -1
- package/src/modules/bmb/reference/agents/module-examples/README.md +1 -1
- package/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml +5 -5
- package/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml +7 -7
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +1 -1
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +1 -1
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +3 -3
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +3 -3
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +5 -5
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +5 -5
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +5 -5
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md +2 -2
- package/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/README.md +1 -1
- package/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/security-engineer.agent.yaml +6 -6
- package/src/modules/bmb/workflows/create-agent/data/reference/agents/module-examples/trend-analyst.agent.yaml +7 -7
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +1 -1
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +1 -1
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +3 -3
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +3 -3
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +5 -5
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +5 -5
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +5 -5
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/workflow.md +2 -2
- package/src/modules/bmb/workflows/create-agent/data/validation-complete.md +5 -5
- package/src/modules/bmb/workflows/create-agent/steps/step-01-brainstorm.md +4 -4
- package/src/modules/bmb/workflows/create-agent/steps/step-02-discover.md +4 -4
- package/src/modules/bmb/workflows/create-agent/steps/step-03-persona.md +4 -4
- package/src/modules/bmb/workflows/create-agent/steps/step-04-commands.md +7 -7
- package/src/modules/bmb/workflows/create-agent/steps/step-05-name.md +3 -3
- package/src/modules/bmb/workflows/create-agent/steps/step-06-build.md +4 -4
- package/src/modules/bmb/workflows/create-agent/steps/step-07-validate.md +4 -4
- package/src/modules/bmb/workflows/create-agent/steps/step-08-setup.md +3 -3
- package/src/modules/bmb/workflows/create-agent/steps/step-09-customize.md +4 -4
- package/src/modules/bmb/workflows/create-agent/steps/step-10-build-tools.md +3 -3
- package/src/modules/bmb/workflows/create-agent/steps/step-11-celebrate.md +3 -3
- package/src/modules/bmb/workflows/create-agent/workflow.md +13 -13
- package/src/modules/bmb/workflows/create-module/steps/step-01-init.md +2 -2
- package/src/modules/bmb/workflows/create-module/steps/step-02-concept.md +4 -4
- package/src/modules/bmb/workflows/create-module/steps/step-03-components.md +4 -4
- package/src/modules/bmb/workflows/create-module/steps/step-04-structure.md +6 -6
- package/src/modules/bmb/workflows/create-module/steps/step-05-config.md +5 -5
- package/src/modules/bmb/workflows/create-module/steps/step-06-agents.md +6 -6
- package/src/modules/bmb/workflows/create-module/steps/step-07-workflows.md +3 -3
- package/src/modules/bmb/workflows/create-module/steps/step-08-installer.md +12 -12
- package/src/modules/bmb/workflows/create-module/steps/step-09-documentation.md +6 -5
- package/src/modules/bmb/workflows/create-module/steps/step-10-roadmap.md +6 -5
- package/src/modules/bmb/workflows/create-module/steps/step-11-validate.md +7 -7
- package/src/modules/bmb/workflows/create-module/templates/agent.template.md +7 -7
- package/src/modules/bmb/workflows/create-module/templates/installer.template.js +1 -1
- package/src/modules/bmb/workflows/create-module/templates/{install-config.template.yaml → module.template.yaml} +1 -1
- package/src/modules/bmb/workflows/create-module/validation.md +3 -3
- package/src/modules/bmb/workflows/create-module/workflow.md +2 -2
- package/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md +3 -3
- package/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md +5 -5
- package/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +4 -4
- package/src/modules/bmb/workflows/create-workflow/steps/step-04-plan-review.md +3 -3
- package/src/modules/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +3 -3
- package/src/modules/bmb/workflows/create-workflow/steps/step-06-design.md +10 -10
- package/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md +13 -13
- package/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md +3 -3
- package/src/modules/bmb/workflows/create-workflow/steps/step-09-complete.md +1 -1
- package/src/modules/bmb/workflows/create-workflow/workflow.md +1 -1
- package/src/modules/bmb/workflows/edit-agent/steps/step-01-discover-intent.md +3 -3
- package/src/modules/bmb/workflows/edit-agent/steps/step-02-analyze-agent.md +13 -13
- package/src/modules/bmb/workflows/edit-agent/steps/step-03-propose-changes.md +5 -5
- package/src/modules/bmb/workflows/edit-agent/steps/step-04-apply-changes.md +3 -3
- package/src/modules/bmb/workflows/edit-agent/steps/step-05-validate.md +5 -5
- package/src/modules/bmb/workflows/edit-agent/workflow.md +1 -1
- package/src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md +4 -4
- package/src/modules/bmb/workflows/edit-workflow/steps/step-02-discover.md +3 -3
- package/src/modules/bmb/workflows/edit-workflow/steps/step-03-improve.md +6 -6
- package/src/modules/bmb/workflows/edit-workflow/steps/step-04-validate.md +3 -3
- package/src/modules/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +3 -3
- package/src/modules/bmb/workflows/edit-workflow/workflow.md +1 -1
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +3 -3
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +5 -5
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +6 -6
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +4 -4
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +4 -4
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +4 -4
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +4 -4
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +3 -3
- package/src/modules/bmb/workflows/workflow-compliance-check/workflow.md +1 -1
- package/src/modules/bmb/workflows-legacy/edit-module/README.md +2 -2
- package/src/modules/bmb/workflows-legacy/edit-module/checklist.md +2 -2
- package/src/modules/bmb/workflows-legacy/edit-module/instructions.md +4 -4
- package/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml +10 -10
- package/src/modules/bmb/workflows-legacy/module-brief/README.md +2 -2
- package/src/modules/bmb/workflows-legacy/module-brief/instructions.md +2 -2
- package/src/modules/bmb/workflows-legacy/module-brief/workflow.yaml +4 -4
- package/src/modules/bmgd/README.md +3 -2
- package/src/modules/bmgd/agents/game-architect.agent.yaml +6 -6
- package/src/modules/bmgd/agents/game-designer.agent.yaml +7 -7
- package/src/modules/bmgd/agents/game-dev.agent.yaml +9 -9
- package/src/modules/bmgd/agents/game-scrum-master.agent.yaml +21 -21
- package/src/modules/bmgd/{_module-installer/install-config.yaml → module.yaml} +0 -1
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md +1 -1
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/workflow.yaml +9 -9
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/instructions.md +1 -1
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/workflow.yaml +8 -8
- package/src/modules/bmgd/workflows/2-design/gdd/instructions-gdd.md +4 -4
- package/src/modules/bmgd/workflows/2-design/gdd/workflow.yaml +30 -30
- package/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md +1 -1
- package/src/modules/bmgd/workflows/2-design/narrative/workflow.yaml +5 -5
- package/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md +1 -1
- package/src/modules/bmgd/workflows/3-technical/game-architecture/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/code-review/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/correct-course/checklist.md +1 -1
- package/src/modules/bmgd/workflows/4-production/correct-course/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/correct-course/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/create-story/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/create-story/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/dev-story/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/epic-tech-context/checklist.md +1 -1
- package/src/modules/bmgd/workflows/4-production/epic-tech-context/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/epic-tech-context/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/retrospective/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/4-production/sprint-planning/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/story-context/checklist.md +1 -1
- package/src/modules/bmgd/workflows/4-production/story-context/context-template.xml +1 -1
- package/src/modules/bmgd/workflows/4-production/story-context/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/story-context/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/story-done/instructions.md +1 -1
- package/src/modules/bmgd/workflows/4-production/story-done/workflow.yaml +2 -2
- package/src/modules/bmgd/workflows/4-production/story-ready/instructions.md +1 -1
- package/src/modules/bmgd/workflows/4-production/story-ready/workflow.yaml +2 -2
- package/src/modules/bmm/_module-installer/installer.js +1 -1
- package/src/modules/bmm/_module-installer/platform-specifics/claude-code.js +1 -1
- package/src/modules/bmm/_module-installer/platform-specifics/windsurf.js +1 -1
- package/src/modules/bmm/agents/analyst.agent.yaml +8 -8
- package/src/modules/bmm/agents/architect.agent.yaml +8 -8
- package/src/modules/bmm/agents/dev.agent.yaml +3 -3
- package/src/modules/bmm/agents/pm.agent.yaml +8 -8
- package/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml +5 -5
- package/src/modules/bmm/agents/sm.agent.yaml +9 -9
- package/src/modules/bmm/agents/tea.agent.yaml +13 -13
- package/src/modules/bmm/agents/tech-writer.agent.yaml +9 -9
- package/src/modules/bmm/agents/ux-designer.agent.yaml +6 -6
- package/src/modules/bmm/docs/README.md +0 -25
- package/src/modules/bmm/docs/agents-guide.md +4 -4
- package/src/modules/bmm/docs/brownfield-guide.md +4 -4
- package/src/modules/bmm/docs/enterprise-agentic-development.md +3 -3
- package/src/modules/bmm/docs/faq.md +1 -1
- package/src/modules/bmm/docs/party-mode.md +3 -3
- package/src/modules/bmm/docs/quick-start.md +1 -1
- package/src/modules/bmm/docs/test-architecture.md +3 -3
- package/src/modules/bmm/docs/workflow-document-project-reference.md +1 -1
- package/src/modules/bmm/docs/workflows-implementation.md +0 -100
- package/src/modules/bmm/{_module-installer/install-config.yaml → module.yaml} +1 -2
- package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01-init.md +1 -1
- package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-01b-continue.md +1 -1
- package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-02-vision.md +3 -3
- package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-03-users.md +3 -3
- package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-04-metrics.md +3 -3
- package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-05-scope.md +3 -3
- package/src/modules/bmm/workflows/1-analysis/product-brief/steps/step-06-complete.md +5 -3
- package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/research/workflow.md +2 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +2 -2
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +1 -1
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +1 -1
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +3 -3
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +7 -7
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +8 -8
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +12 -12
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +12 -12
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +10 -10
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +7 -7
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +9 -9
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +9 -9
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +1 -1
- package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-02-context.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-03-starter.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-04-decisions.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-05-patterns.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-06-structure.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-07-validation.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/architecture/steps/step-08-complete.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/architecture/workflow.md +2 -2
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +2 -2
- package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-01-document-discovery.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-02-prd-analysis.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-03-epic-coverage-validation.md +6 -6
- package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-04-ux-alignment.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-05-epic-quality-review.md +2 -2
- package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/steps/step-06-final-assessment.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/implementation-readiness/workflow.md +1 -1
- package/src/modules/bmm/workflows/4-implementation/code-review/instructions.xml +1 -1
- package/src/modules/bmm/workflows/4-implementation/code-review/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/4-implementation/correct-course/checklist.md +1 -1
- package/src/modules/bmm/workflows/4-implementation/correct-course/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml +2 -2
- package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml +1 -1
- package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +3 -3
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/4-implementation/sprint-status/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml +5 -5
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml +7 -7
- package/src/modules/bmm/workflows/diagrams/create-dataflow/instructions.md +1 -1
- package/src/modules/bmm/workflows/diagrams/create-dataflow/workflow.yaml +5 -5
- package/src/modules/bmm/workflows/diagrams/create-diagram/instructions.md +2 -2
- package/src/modules/bmm/workflows/diagrams/create-diagram/workflow.yaml +5 -5
- package/src/modules/bmm/workflows/diagrams/create-flowchart/instructions.md +2 -2
- package/src/modules/bmm/workflows/diagrams/create-flowchart/workflow.yaml +5 -5
- package/src/modules/bmm/workflows/diagrams/create-wireframe/instructions.md +1 -1
- package/src/modules/bmm/workflows/diagrams/create-wireframe/workflow.yaml +5 -5
- package/src/modules/bmm/workflows/document-project/instructions.md +5 -5
- package/src/modules/bmm/workflows/document-project/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/document-project/workflows/deep-dive.yaml +5 -5
- package/src/modules/bmm/workflows/document-project/workflows/full-scan.yaml +5 -5
- package/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md +2 -2
- package/src/modules/bmm/workflows/generate-project-context/workflow.md +2 -2
- package/src/modules/bmm/workflows/testarch/atdd/instructions.md +2 -2
- package/src/modules/bmm/workflows/testarch/atdd/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/testarch/automate/instructions.md +2 -2
- package/src/modules/bmm/workflows/testarch/automate/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/testarch/ci/instructions.md +1 -1
- package/src/modules/bmm/workflows/testarch/ci/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/testarch/framework/instructions.md +3 -3
- package/src/modules/bmm/workflows/testarch/framework/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/testarch/nfr-assess/instructions.md +1 -1
- package/src/modules/bmm/workflows/testarch/nfr-assess/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/testarch/test-design/instructions.md +3 -3
- package/src/modules/bmm/workflows/testarch/test-design/test-design-template.md +1 -1
- package/src/modules/bmm/workflows/testarch/test-design/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/testarch/test-review/instructions.md +1 -1
- package/src/modules/bmm/workflows/testarch/test-review/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/testarch/trace/instructions.md +6 -6
- package/src/modules/bmm/workflows/testarch/trace/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +1 -1
- package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +4 -4
- package/src/modules/bmm/workflows/workflow-status/instructions.md +3 -3
- package/src/modules/bmm/workflows/workflow-status/project-levels.yaml +1 -1
- package/src/modules/bmm/workflows/workflow-status/workflow.yaml +2 -2
- package/src/modules/cis/README.md +1 -1
- package/src/modules/cis/_module-installer/installer.js +1 -1
- package/src/modules/cis/agents/README.md +1 -1
- package/src/modules/cis/agents/brainstorming-coach.agent.yaml +4 -4
- package/src/modules/cis/agents/creative-problem-solver.agent.yaml +4 -4
- package/src/modules/cis/agents/design-thinking-coach.agent.yaml +4 -4
- package/src/modules/cis/agents/innovation-strategist.agent.yaml +4 -4
- package/src/modules/cis/agents/presentation-master.agent.yaml +3 -3
- package/src/modules/cis/agents/storyteller.agent.yaml +4 -4
- package/src/modules/cis/{_module-installer/install-config.yaml → module.yaml} +0 -1
- package/src/modules/cis/workflows/README.md +1 -1
- package/src/modules/cis/workflows/design-thinking/instructions.md +2 -2
- package/src/modules/cis/workflows/design-thinking/workflow.yaml +7 -7
- package/src/modules/cis/workflows/innovation-strategy/instructions.md +2 -2
- package/src/modules/cis/workflows/innovation-strategy/workflow.yaml +7 -7
- package/src/modules/cis/workflows/problem-solving/instructions.md +2 -2
- package/src/modules/cis/workflows/problem-solving/workflow.yaml +7 -7
- package/src/modules/cis/workflows/storytelling/instructions.md +2 -2
- package/src/modules/cis/workflows/storytelling/workflow.yaml +7 -7
- package/src/utility/models/agent-activation-ide.xml +3 -3
- package/src/utility/models/agent-activation-web.xml +3 -3
- package/src/utility/models/fragments/activation-steps.xml +1 -1
- package/src/utility/models/fragments/handler-validate-workflow.xml +1 -1
- package/src/utility/models/fragments/handler-workflow.xml +1 -1
- package/src/utility/models/fragments/web-bundle-activation-steps.xml +3 -3
- package/tools/cli/README.md +23 -23
- package/tools/cli/bundlers/web-bundler.js +23 -33
- package/tools/cli/commands/build.js +5 -5
- package/tools/cli/installers/lib/core/config-collector.js +33 -20
- package/tools/cli/installers/lib/core/custom-module-cache.js +251 -0
- package/tools/cli/installers/lib/core/detector.js +8 -4
- package/tools/cli/installers/lib/core/installer.js +885 -98
- package/tools/cli/installers/lib/core/manifest-generator.js +177 -14
- package/tools/cli/installers/lib/core/manifest.js +47 -0
- package/tools/cli/installers/lib/custom/handler.js +147 -20
- package/tools/cli/installers/lib/ide/_base-ide.js +14 -14
- package/tools/cli/installers/lib/ide/gemini.js +4 -4
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +2 -2
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +3 -3
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +1 -1
- package/tools/cli/installers/lib/ide/templates/gemini-agent-command.toml +3 -3
- package/tools/cli/installers/lib/ide/templates/gemini-task-command.toml +3 -3
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +1 -1
- package/tools/cli/installers/lib/modules/manager.js +99 -53
- package/tools/cli/lib/agent/compiler.js +6 -14
- package/tools/cli/lib/agent/installer.js +4 -3
- package/tools/cli/lib/cli-utils.js +21 -4
- package/tools/cli/lib/ui.js +496 -12
- package/tools/cli/regenerate-manifests.js +3 -4
- package/tools/maintainer/review-pr-README.md +55 -0
- package/tools/maintainer/review-pr.md +242 -0
- package/tools/migrate-custom-module-paths.js +124 -0
- package/bmad-method-6.0.0-alpha.14.tgz +0 -0
- package/docs/custom-agent-installation.md +0 -137
- package/example-custom-content/README.md +0 -4
- package/example-custom-content/agents/commit-poet/commit-poet.agent.yaml +0 -129
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/instructions.md +0 -70
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/bundlers.md +0 -111
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/deploy.md +0 -70
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md +0 -114
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md +0 -134
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md +0 -161
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/knowledge/tests.md +0 -103
- package/example-custom-content/agents/toolsmith/toolsmith-sidecar/memories.md +0 -17
- package/example-custom-content/agents/toolsmith/toolsmith.agent.yaml +0 -109
- package/example-custom-content/custom.yaml +0 -3
- package/example-custom-content/workflows/quiz-master/steps/step-01-init.md +0 -168
- package/example-custom-content/workflows/quiz-master/steps/step-02-q1.md +0 -155
- package/example-custom-content/workflows/quiz-master/steps/step-03-q2.md +0 -89
- package/example-custom-content/workflows/quiz-master/steps/step-04-q3.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-05-q4.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-06-q5.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-07-q6.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-08-q7.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-09-q8.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-10-q9.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-11-q10.md +0 -36
- package/example-custom-content/workflows/quiz-master/steps/step-12-results.md +0 -150
- package/example-custom-content/workflows/quiz-master/templates/csv-headers.template +0 -1
- package/example-custom-content/workflows/quiz-master/workflow-plan-quiz-master.md +0 -269
- package/example-custom-content/workflows/quiz-master/workflow.md +0 -54
- package/example-custom-content/workflows/wassup/workflow.md +0 -26
- package/example-custom-module/mwm/README.md +0 -4
- package/example-custom-module/mwm/_module-installer/install-config.yaml +0 -27
- package/example-custom-module/mwm/agents/cbt-coach/cbt-coach-sidecar/cognitive-distortions.md +0 -47
- package/example-custom-module/mwm/agents/cbt-coach/cbt-coach-sidecar/thought-records.md +0 -17
- package/example-custom-module/mwm/agents/cbt-coach/cbt-coach.agent.yaml +0 -150
- package/example-custom-module/mwm/agents/crisis-navigator.agent.yaml +0 -137
- package/example-custom-module/mwm/agents/meditation-guide.agent.yaml +0 -137
- package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/insights.md +0 -13
- package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/instructions.md +0 -30
- package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/memories.md +0 -13
- package/example-custom-module/mwm/agents/wellness-companion/wellness-companion-sidecar/patterns.md +0 -17
- package/example-custom-module/mwm/agents/wellness-companion/wellness-companion.agent.yaml +0 -124
- package/example-custom-module/mwm/workflows/cbt-thought-record/README.md +0 -31
- package/example-custom-module/mwm/workflows/cbt-thought-record/workflow.md +0 -45
- package/example-custom-module/mwm/workflows/crisis-support/README.md +0 -31
- package/example-custom-module/mwm/workflows/crisis-support/workflow.md +0 -45
- package/example-custom-module/mwm/workflows/daily-checkin/README.md +0 -32
- package/example-custom-module/mwm/workflows/daily-checkin/workflow.md +0 -45
- package/example-custom-module/mwm/workflows/guided-meditation/README.md +0 -31
- package/example-custom-module/mwm/workflows/guided-meditation/workflow.md +0 -45
- package/example-custom-module/mwm/workflows/wellness-journal/README.md +0 -31
- package/example-custom-module/mwm/workflows/wellness-journal/workflow.md +0 -45
package/README.md
CHANGED
|
@@ -8,7 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
|
|
10
10
|
|
|
11
|
-
**Build More, Architect Dreams** (BMAD) with **
|
|
11
|
+
**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
|
|
12
|
+
|
|
13
|
+
Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits!
|
|
12
14
|
|
|
13
15
|
> **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6)
|
|
14
16
|
|
|
@@ -154,6 +156,7 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
|
|
154
156
|
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
|
155
157
|
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
|
156
158
|
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles
|
|
159
|
+
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
|
157
160
|
|
|
158
161
|
## 🛠️ Development
|
|
159
162
|
|
|
@@ -9,7 +9,7 @@ Customize BMad agents without modifying core files. All customizations persist t
|
|
|
9
9
|
After installation, find agent customization files in:
|
|
10
10
|
|
|
11
11
|
```
|
|
12
|
-
|
|
12
|
+
.bmad/_cfg/agents/
|
|
13
13
|
├── core-bmad-master.customize.yaml
|
|
14
14
|
├── bmm-dev.customize.yaml
|
|
15
15
|
├── bmm-pm.customize.yaml
|
|
@@ -119,7 +119,7 @@ prompts:
|
|
|
119
119
|
**Example 1: Customize Developer Agent for TDD**
|
|
120
120
|
|
|
121
121
|
```yaml
|
|
122
|
-
#
|
|
122
|
+
# .bmad/_cfg/agents/bmm-dev.customize.yaml
|
|
123
123
|
agent:
|
|
124
124
|
metadata:
|
|
125
125
|
name: 'TDD Developer'
|
|
@@ -135,20 +135,20 @@ critical_actions:
|
|
|
135
135
|
**Example 2: Add Custom Deployment Workflow**
|
|
136
136
|
|
|
137
137
|
```yaml
|
|
138
|
-
#
|
|
138
|
+
# .bmad/_cfg/agents/bmm-dev.customize.yaml
|
|
139
139
|
menu:
|
|
140
140
|
- trigger: deploy-staging
|
|
141
|
-
workflow: '{project-root}/
|
|
141
|
+
workflow: '{project-root}/.bmad/deploy-staging.yaml'
|
|
142
142
|
description: Deploy to staging environment
|
|
143
143
|
- trigger: deploy-prod
|
|
144
|
-
workflow: '{project-root}/
|
|
144
|
+
workflow: '{project-root}/.bmad/deploy-prod.yaml'
|
|
145
145
|
description: Deploy to production (with approval)
|
|
146
146
|
```
|
|
147
147
|
|
|
148
148
|
**Example 3: Multilingual Product Manager**
|
|
149
149
|
|
|
150
150
|
```yaml
|
|
151
|
-
#
|
|
151
|
+
# .bmad/_cfg/agents/bmm-pm.customize.yaml
|
|
152
152
|
persona:
|
|
153
153
|
role: 'Bilingual Product Manager'
|
|
154
154
|
identity: 'Expert in US and LATAM markets'
|
|
@@ -174,7 +174,7 @@ memories:
|
|
|
174
174
|
|
|
175
175
|
**Module-Level (Recommended):**
|
|
176
176
|
|
|
177
|
-
- Customize agents per-project in
|
|
177
|
+
- Customize agents per-project in `.bmad/_cfg/agents/`
|
|
178
178
|
- Different projects can have different agent behaviors
|
|
179
179
|
|
|
180
180
|
**Global Config (Coming Soon):**
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
# Custom Content Installation
|
|
2
|
+
|
|
3
|
+
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content allows you to extend BMAD's functionality with your own specialized tools and workflows that can be shared across projects or teams.
|
|
4
|
+
|
|
5
|
+
## Types of Custom Content
|
|
6
|
+
|
|
7
|
+
### 1. Custom Agents and Workflows (Standalone)
|
|
8
|
+
|
|
9
|
+
Custom agents and workflows are standalone content packages that can be installed without being part of a full module. These are perfect for:
|
|
10
|
+
|
|
11
|
+
- Sharing specialized agents across projects
|
|
12
|
+
- Building a personal Agent powered Notebook vault
|
|
13
|
+
- Distributing workflow templates
|
|
14
|
+
- Creating agent libraries for specific domains
|
|
15
|
+
|
|
16
|
+
#### Structure
|
|
17
|
+
|
|
18
|
+
A custom agents and workflows package follows this structure:
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
my-custom-agents/
|
|
22
|
+
├── module.yaml # Package configuration
|
|
23
|
+
├── agents/ # Agent definitions
|
|
24
|
+
│ └── my-agent/
|
|
25
|
+
│ └── agent.md
|
|
26
|
+
└── workflows/ # Workflow definitions
|
|
27
|
+
└── my-workflow/
|
|
28
|
+
└── workflow.md
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
#### Configuration
|
|
32
|
+
|
|
33
|
+
Create a `module.yaml` file in your package root:
|
|
34
|
+
|
|
35
|
+
```yaml
|
|
36
|
+
code: my-custom-agents
|
|
37
|
+
name: 'My Custom Agents and Workflows'
|
|
38
|
+
default_selected: true
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
#### Example
|
|
42
|
+
|
|
43
|
+
See `/example-custom-content` for a working example of a folder with multiple random custom agents and workflows. Technically its also just a module, but you will be able to further pick and choose from this folders contents of what you do and do not want to include in a destination folder. This way, you can store all custom content source in one location and easily install it to different locations.
|
|
44
|
+
|
|
45
|
+
### 2. Custom Modules
|
|
46
|
+
|
|
47
|
+
Custom modules are complete BMAD modules that can include their own configuration, documentation, along with agents and workflows that all compliment each other. Additionally they will have their own installation scripts, data, and potentially other tools. Modules can be used for:
|
|
48
|
+
|
|
49
|
+
- Domain-specific functionality (e.g., industry-specific workflows, entertainment, education and training, medical, etc...)
|
|
50
|
+
- Integration with external systems
|
|
51
|
+
- Specialized agent collections
|
|
52
|
+
- Custom tooling and utilities
|
|
53
|
+
|
|
54
|
+
#### Structure
|
|
55
|
+
|
|
56
|
+
A custom module follows this structure:
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
my-module/
|
|
60
|
+
├── _module-installer/
|
|
61
|
+
│ ├── installer.js # optional, when it exists it will run with module installation
|
|
62
|
+
├── module.yaml # Module installation configuration with custom question and answer capture
|
|
63
|
+
├── docs/ # Module documentation
|
|
64
|
+
├── agents/ # Module-specific agents
|
|
65
|
+
├── workflows/ # Module-specific workflows
|
|
66
|
+
├── data/ # csv or other content to power agent intelligence or workflows
|
|
67
|
+
├── tools/ # Custom tools, hooks, mcp
|
|
68
|
+
└── sub-modules/ # IDE-specific customizations
|
|
69
|
+
├── vscode/
|
|
70
|
+
└── cursor/
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
#### Module Configuration
|
|
74
|
+
|
|
75
|
+
The `module.yaml` file defines how your module is installed:
|
|
76
|
+
|
|
77
|
+
```yaml
|
|
78
|
+
# Module metadata
|
|
79
|
+
code: my-module
|
|
80
|
+
name: 'My Custom Module'
|
|
81
|
+
default_selected: false
|
|
82
|
+
|
|
83
|
+
header: 'My Custom Module'
|
|
84
|
+
subheader: 'Description of what this module does'
|
|
85
|
+
|
|
86
|
+
# Configuration prompts
|
|
87
|
+
my_setting:
|
|
88
|
+
prompt: 'Configure your module setting'
|
|
89
|
+
default: 'default-value'
|
|
90
|
+
result: '{value}'
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
#### Example
|
|
94
|
+
|
|
95
|
+
See `/example-custom-module` for a complete example:
|
|
96
|
+
|
|
97
|
+
## Installation Process
|
|
98
|
+
|
|
99
|
+
### Step 1: Running the Installer
|
|
100
|
+
|
|
101
|
+
When you run the existing normal BMAD installer - either from the cloned repo, OR via NPX, it will ask about custom content:
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
? Do you have custom content to install?
|
|
105
|
+
❯ No (skip custom content)
|
|
106
|
+
Enter a directory path
|
|
107
|
+
Enter a URL [Coming soon]
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Step 2: Providing Custom Content Path
|
|
111
|
+
|
|
112
|
+
If you select "Enter a directory path", the installer will prompt for the location:
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
? Enter the path to your custom content directory: /path/to/folder/containing/content/folder
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
The installer will:
|
|
119
|
+
|
|
120
|
+
- Scan for `module.yaml` files (modules)
|
|
121
|
+
- Display an indication of how many installable folders it has found. Note that a project with stand along agents and workflows all under a single folder like the example will just list the count as 1 for that directory.
|
|
122
|
+
|
|
123
|
+
### Step 3: Selecting Content
|
|
124
|
+
|
|
125
|
+
The installer presents a unified selection interface:
|
|
126
|
+
|
|
127
|
+
```
|
|
128
|
+
? Select modules and custom content to install:
|
|
129
|
+
[── Custom Content ──]
|
|
130
|
+
◉ My Custom Agents and Workflows (/path/to/custom)
|
|
131
|
+
[── Official Content ──]
|
|
132
|
+
◯ BMM: Business Method & Management
|
|
133
|
+
◯ CIS: Creativity & Innovation Suite
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Agent Sidecar Support
|
|
137
|
+
|
|
138
|
+
Agents with sidecar content can store personal data, memories, and working files outside of the `.bmad` directory. This separation keeps personal content separate from BMAD's core files.
|
|
139
|
+
|
|
140
|
+
### What is Sidecar Content?
|
|
141
|
+
|
|
142
|
+
Sidecar content includes:
|
|
143
|
+
|
|
144
|
+
- Agent memories and learning data
|
|
145
|
+
- Personal working files
|
|
146
|
+
- Temporary data
|
|
147
|
+
- User-specific configurations
|
|
148
|
+
|
|
149
|
+
### Sidecar Configuration
|
|
150
|
+
|
|
151
|
+
The sidecar folder location is configured during BMAD core installation:
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
? Where should users' agent sidecar memory folders be stored?
|
|
155
|
+
❯ .bmad-user-memory
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### How It Works
|
|
159
|
+
|
|
160
|
+
1. **Agent Declaration**: Agents declare `hasSidecar: true` in their metadata
|
|
161
|
+
2. **Sidecar Detection**: The installer automatically detects folders with "sidecar" in the name
|
|
162
|
+
3. **Installation**: Sidecar content is copied to the configured location
|
|
163
|
+
4. **Path Replacement**: The `{agent_sidecar_folder}` placeholder in agent configurations is replaced with the actual path to the installed instance of the sidecar folder. Now when you use the agent, depending on its design, will use the content in sidecar to record interactions, remember things you tell it, or serve a host of many other issues.
|
|
164
|
+
|
|
165
|
+
### Example Structure
|
|
166
|
+
|
|
167
|
+
```
|
|
168
|
+
my-agent/
|
|
169
|
+
├── agent.md # Agent definition
|
|
170
|
+
└── my-agent-sidecar/ # Sidecar content folder
|
|
171
|
+
├── memories/
|
|
172
|
+
├── working/
|
|
173
|
+
└── config/
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Git Integration
|
|
177
|
+
|
|
178
|
+
Since sidecar content is stored outside the `.bmad` directory (and typically outside version control), users can:
|
|
179
|
+
|
|
180
|
+
- Add the sidecar folder to `.gitignore` to exclude personal data
|
|
181
|
+
- Share agent definitions without exposing personal content
|
|
182
|
+
- Maintain separate configurations for different projects
|
|
183
|
+
|
|
184
|
+
Example `.gitignore` entry:
|
|
185
|
+
|
|
186
|
+
```
|
|
187
|
+
# Exclude agent personal data
|
|
188
|
+
.bmad-user-memory/
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## Creating Custom Content with BMAD Builder
|
|
192
|
+
|
|
193
|
+
The BMAD Builder provides workflows that will guide you to produce your own custom content:
|
|
194
|
+
|
|
195
|
+
1. **Agent Templates**: Use standardized agent templates with proper structure
|
|
196
|
+
2. **Workflow Templates**: Create workflows using proven patterns
|
|
197
|
+
3. **Validation Tools**: Validate your content before distribution
|
|
198
|
+
4. **Package Generation**: Generate properly structured packages
|
|
199
|
+
|
|
200
|
+
### Best Practices
|
|
201
|
+
|
|
202
|
+
1. **Use Clear Naming**: Make your content codes and names descriptive
|
|
203
|
+
2. **Provide Documentation**: Include clear setup and usage instructions
|
|
204
|
+
3. **Test Installation**: Test your content in a clean environment
|
|
205
|
+
4. **Version Management**: Use semantic versioning for updates
|
|
206
|
+
5. **Respect User Privacy**: Keep personal data in sidecar folders
|
|
207
|
+
|
|
208
|
+
## Distribution
|
|
209
|
+
|
|
210
|
+
Custom content can be distributed:
|
|
211
|
+
|
|
212
|
+
1. **File System**: Copy folders directly to users
|
|
213
|
+
2. **Git Repositories**: Clone or download from version control
|
|
214
|
+
3. **Package Managers**: [Coming soon] npm package support
|
|
215
|
+
4. **URL Installation**: [Coming soon] Direct URL installation, including an official community vetted module forge
|
|
216
|
+
|
|
217
|
+
## Troubleshooting
|
|
218
|
+
|
|
219
|
+
### No Custom Content Found
|
|
220
|
+
|
|
221
|
+
- Ensure your `module.yaml` files are properly named
|
|
222
|
+
- Check file permissions
|
|
223
|
+
- Verify the directory path is correct
|
|
224
|
+
|
|
225
|
+
### Installation Errors
|
|
226
|
+
|
|
227
|
+
- Run the installer with verbose logging
|
|
228
|
+
- Check for syntax errors in YAML configuration files
|
|
229
|
+
- Verify all required files are present
|
|
230
|
+
|
|
231
|
+
### Sidecar Issues
|
|
232
|
+
|
|
233
|
+
- Ensure the agent has `hasSidecar: true` in metadata
|
|
234
|
+
- Check that sidecar folders contain "sidecar" in the name
|
|
235
|
+
- Verify the agent_sidecar_folder configuration
|
|
236
|
+
- Ensure the custom agent has proper language in it to actually use the sidecar content, including loading memories on agent load.
|
|
237
|
+
|
|
238
|
+
## Support
|
|
239
|
+
|
|
240
|
+
For help with custom content creation or installation:
|
|
241
|
+
|
|
242
|
+
1. Check the examples in `/example-custom-content` and `/example-custom-module`
|
|
243
|
+
2. Review the BMAD documentation
|
|
244
|
+
3. Create an issue in the BMAD repository
|
|
245
|
+
4. Join the BMAD community discussions on discord
|
package/docs/ide-info/crush.md
CHANGED
|
@@ -7,7 +7,7 @@ BMAD agents are installed as commands in `.crush/commands/bmad/`.
|
|
|
7
7
|
### How to Use
|
|
8
8
|
|
|
9
9
|
1. **Open Command Palette**: Use Crush command interface
|
|
10
|
-
2. **Navigate**: Browse to
|
|
10
|
+
2. **Navigate**: Browse to `.bmad/{module}/agents/`
|
|
11
11
|
3. **Select Agent**: Choose the agent command
|
|
12
12
|
4. **Execute**: Run to activate agent persona
|
|
13
13
|
|
package/docs/ide-info/cursor.md
CHANGED
|
@@ -6,20 +6,20 @@ BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules.
|
|
|
6
6
|
|
|
7
7
|
### How to Use
|
|
8
8
|
|
|
9
|
-
1. **Reference in Chat**: Use
|
|
10
|
-
2. **Include Entire Module**: Use
|
|
11
|
-
3. **Reference Index**: Use
|
|
9
|
+
1. **Reference in Chat**: Use `@.bmad/{module}/agents/{agent-name}`
|
|
10
|
+
2. **Include Entire Module**: Use `@.bmad/{module}`
|
|
11
|
+
3. **Reference Index**: Use `@.bmad/index` for all available agents
|
|
12
12
|
|
|
13
13
|
### Examples
|
|
14
14
|
|
|
15
15
|
```
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
@.bmad/core/agents/dev - Activate dev agent
|
|
17
|
+
@.bmad/bmm/agents/architect - Activate architect agent
|
|
18
|
+
@.bmad/core - Include all core agents/tasks
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
### Notes
|
|
22
22
|
|
|
23
23
|
- Rules are Manual type - only loaded when explicitly referenced
|
|
24
24
|
- No automatic context pollution
|
|
25
|
-
- Can combine multiple agents:
|
|
25
|
+
- Can combine multiple agents: `@.bmad/core/agents/dev @.bmad/core/agents/test`
|
package/docs/ide-info/iflow.md
CHANGED
|
@@ -7,7 +7,7 @@ BMAD agents are installed as commands in `.iflow/commands/bmad/`.
|
|
|
7
7
|
### How to Use
|
|
8
8
|
|
|
9
9
|
1. **Access Commands**: Use iFlow command interface
|
|
10
|
-
2. **Navigate**: Browse to
|
|
10
|
+
2. **Navigate**: Browse to `.bmad/agents/` or `.bmad/tasks/`
|
|
11
11
|
3. **Select**: Choose the agent or task command
|
|
12
12
|
4. **Execute**: Run to activate
|
|
13
13
|
|
|
@@ -22,8 +22,8 @@ BMAD agents are installed as commands in `.iflow/commands/bmad/`.
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
24
24
|
```
|
|
25
|
-
/
|
|
26
|
-
/
|
|
25
|
+
/.bmad/agents/core-dev - Activate dev agent
|
|
26
|
+
/.bmad/tasks/core-setup - Execute setup task
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
### Notes
|
|
@@ -14,7 +14,7 @@ BMAD agents are installed as OpenCode agents in `.opencode/agent/BMAD/{module_na
|
|
|
14
14
|
|
|
15
15
|
```
|
|
16
16
|
/agents - to see a list of agents and switch between them
|
|
17
|
-
/
|
|
17
|
+
/.bmad/bmm/workflows/workflow-init - Activate the workflow-init command
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
### Notes
|
package/docs/index.md
CHANGED
|
@@ -96,9 +96,9 @@ Instructions for loading agents and running workflows in your development enviro
|
|
|
96
96
|
|
|
97
97
|
## 🔧 Advanced Topics
|
|
98
98
|
|
|
99
|
-
### Custom Agents
|
|
99
|
+
### Custom Agents, Workflow and Modules
|
|
100
100
|
|
|
101
|
-
- **[Custom
|
|
101
|
+
- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
|
|
102
102
|
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
|
|
103
103
|
|
|
104
104
|
### Installation & Bundling
|
|
@@ -158,7 +158,7 @@ src/modules/bmm/
|
|
|
158
158
|
|
|
159
159
|
```yaml
|
|
160
160
|
injections:
|
|
161
|
-
- file: '
|
|
161
|
+
- file: '.bmad/bmm/agents/pm.md'
|
|
162
162
|
point: 'pm-agent-instructions'
|
|
163
163
|
requires: 'any' # Injected if ANY subagent is selected
|
|
164
164
|
content: |
|
|
@@ -166,7 +166,7 @@ injections:
|
|
|
166
166
|
<i>Use 'market-researcher' subagent for analysis</i>
|
|
167
167
|
</llm>
|
|
168
168
|
|
|
169
|
-
- file: '
|
|
169
|
+
- file: '.bmad/bmm/templates/prd.md'
|
|
170
170
|
point: 'prd-goals-context-delegation'
|
|
171
171
|
requires: 'market-researcher' # Only if this specific subagent selected
|
|
172
172
|
content: |
|
|
@@ -19,7 +19,7 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
|
|
|
19
19
|
|
|
20
20
|
- **Modular Design**: Core + optional modules (BMB, BMM, CIS)
|
|
21
21
|
- **Smart Installation**: Interactive configuration with dependency resolution
|
|
22
|
-
- **Clean Architecture**: Centralized `
|
|
22
|
+
- **Clean Architecture**: Centralized `.bmad` directory add to project, no source pollution with multiple folders added
|
|
23
23
|
|
|
24
24
|
## Architecture
|
|
25
25
|
|
|
@@ -27,7 +27,7 @@ BMad Core is a modular AI agent framework with intelligent installation, platfor
|
|
|
27
27
|
|
|
28
28
|
```
|
|
29
29
|
project-root/
|
|
30
|
-
├──
|
|
30
|
+
├── .bmad/ # Centralized installation
|
|
31
31
|
│ ├── _cfg/ # Configuration
|
|
32
32
|
│ │ ├── agents/ # Agent configs
|
|
33
33
|
│ │ └── agent-manifest.csv # Agent manifest
|
|
@@ -59,6 +59,7 @@ project-root/
|
|
|
59
59
|
### Key Exclusions
|
|
60
60
|
|
|
61
61
|
- `_module-installer/` directories are never copied to destination
|
|
62
|
+
- module.yaml
|
|
62
63
|
- `localskip="true"` agents are filtered out
|
|
63
64
|
- Source `config.yaml` templates are replaced with generated configs
|
|
64
65
|
|
|
@@ -92,8 +93,8 @@ Creative Innovation Studio for design workflows
|
|
|
92
93
|
```
|
|
93
94
|
src/modules/{module}/
|
|
94
95
|
├── _module-installer/ # Not copied to destination
|
|
95
|
-
│ ├── installer.js
|
|
96
|
-
|
|
96
|
+
│ ├── installer.js # Post-install logic
|
|
97
|
+
├── module.yaml
|
|
97
98
|
├── agents/
|
|
98
99
|
├── tasks/
|
|
99
100
|
├── templates/
|
|
@@ -107,7 +108,7 @@ src/modules/{module}/
|
|
|
107
108
|
|
|
108
109
|
### Collection Process
|
|
109
110
|
|
|
110
|
-
Modules define prompts in `
|
|
111
|
+
Modules define prompts in `module.yaml`:
|
|
111
112
|
|
|
112
113
|
```yaml
|
|
113
114
|
project_name:
|
|
@@ -184,7 +185,7 @@ Cline, Roo, Rovo Dev,Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Cr
|
|
|
184
185
|
|
|
185
186
|
```yaml
|
|
186
187
|
injections:
|
|
187
|
-
- file: '
|
|
188
|
+
- file: '.bmad/bmm/agents/pm.md'
|
|
188
189
|
point: 'pm-agent-instructions'
|
|
189
190
|
content: |
|
|
190
191
|
<i>Platform-specific instruction</i>
|
|
@@ -218,12 +219,12 @@ Platform-specific content without source modification:
|
|
|
218
219
|
src/modules/mymod/
|
|
219
220
|
├── _module-installer/
|
|
220
221
|
│ ├── installer.js
|
|
221
|
-
|
|
222
|
+
├── module.yaml
|
|
222
223
|
├── agents/
|
|
223
224
|
└── tasks/
|
|
224
225
|
```
|
|
225
226
|
|
|
226
|
-
2. **Configuration** (`
|
|
227
|
+
2. **Configuration** (`module.yaml`)
|
|
227
228
|
|
|
228
229
|
```yaml
|
|
229
230
|
code: mymod
|
|
@@ -270,14 +271,14 @@ Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
|
|
|
270
271
|
|
|
271
272
|
### Common Issues
|
|
272
273
|
|
|
273
|
-
| Issue | Solution
|
|
274
|
-
| ----------------------- |
|
|
275
|
-
| Existing installation | Use `bmad update` or remove
|
|
276
|
-
| Module not found | Check `src/modules/` exists
|
|
277
|
-
| Config not applied | Verify
|
|
278
|
-
| Missing config.yaml | Fixed: All modules now get configs
|
|
279
|
-
| Agent unavailable | Check for `localskip="true"`
|
|
280
|
-
| module-installer copied | Fixed: Now excluded from copy
|
|
274
|
+
| Issue | Solution |
|
|
275
|
+
| ----------------------- | ------------------------------------ |
|
|
276
|
+
| Existing installation | Use `bmad update` or remove `.bmad/` |
|
|
277
|
+
| Module not found | Check `src/modules/` exists |
|
|
278
|
+
| Config not applied | Verify `.bmad/{module}/config.yaml` |
|
|
279
|
+
| Missing config.yaml | Fixed: All modules now get configs |
|
|
280
|
+
| Agent unavailable | Check for `localskip="true"` |
|
|
281
|
+
| module-installer copied | Fixed: Now excluded from copy |
|
|
281
282
|
|
|
282
283
|
### Debug Commands
|
|
283
284
|
|
|
@@ -289,19 +290,19 @@ bmad status -v # Detailed status
|
|
|
289
290
|
### Best Practices
|
|
290
291
|
|
|
291
292
|
1. Run from project root
|
|
292
|
-
2. Backup
|
|
293
|
+
2. Backup `.bmad/_cfg/` before updates
|
|
293
294
|
3. Use interactive mode for guidance
|
|
294
295
|
4. Review generated configs post-install
|
|
295
296
|
|
|
296
297
|
## Migration from v4
|
|
297
298
|
|
|
298
|
-
| v4 | v6
|
|
299
|
-
| ------------------- |
|
|
300
|
-
| Scattered files | Centralized
|
|
301
|
-
| Monolithic | Modular
|
|
302
|
-
| Manual config | Interactive setup
|
|
303
|
-
| Limited IDE support | 15+ platforms
|
|
304
|
-
| Source modification | Clean injection
|
|
299
|
+
| v4 | v6 |
|
|
300
|
+
| ------------------- | -------------------- |
|
|
301
|
+
| Scattered files | Centralized `.bmad/` |
|
|
302
|
+
| Monolithic | Modular |
|
|
303
|
+
| Manual config | Interactive setup |
|
|
304
|
+
| Limited IDE support | 15+ platforms |
|
|
305
|
+
| Source modification | Clean injection |
|
|
305
306
|
|
|
306
307
|
## Technical Notes
|
|
307
308
|
|
|
@@ -326,8 +327,8 @@ Agents can specify both `workflow` (source location) and `workflow-install` (des
|
|
|
326
327
|
```yaml
|
|
327
328
|
menu:
|
|
328
329
|
- trigger: create-story
|
|
329
|
-
workflow: '{project-root}/
|
|
330
|
-
workflow-install: '{project-root}/
|
|
330
|
+
workflow: '{project-root}/.bmad/bmm/workflows/4-implementation/create-story/workflow.yaml'
|
|
331
|
+
workflow-install: '{project-root}/.bmad/bmgd/workflows/4-production/create-story/workflow.yaml'
|
|
331
332
|
description: 'Create a game feature story'
|
|
332
333
|
```
|
|
333
334
|
|
|
@@ -347,10 +348,10 @@ menu:
|
|
|
347
348
|
|
|
348
349
|
```yaml
|
|
349
350
|
# Source workflow (in bmm):
|
|
350
|
-
config_source: "{project-root}/
|
|
351
|
+
config_source: "{project-root}/.bmad/bmm/config.yaml"
|
|
351
352
|
|
|
352
353
|
# Vendored workflow (in bmgd):
|
|
353
|
-
config_source: "{project-root}/
|
|
354
|
+
config_source: "{project-root}/.bmad/bmgd/config.yaml"
|
|
354
355
|
```
|
|
355
356
|
|
|
356
357
|
**Result**: Modules become completely standalone with their own copies of needed workflows, configured for their specific use case.
|
package/docs/v4-to-v6-upgrade.md
CHANGED
|
@@ -63,7 +63,7 @@ your-project/
|
|
|
63
63
|
|
|
64
64
|
```
|
|
65
65
|
your-project/
|
|
66
|
-
└──
|
|
66
|
+
└── .bmad/ # Single installation folder, default .bmad
|
|
67
67
|
├── core/ # Real core framework (applies to all modules)
|
|
68
68
|
├── bmm/ # BMad Method (software/game dev)
|
|
69
69
|
├── bmb/ # BMad Builder (create agents/workflows)
|
|
@@ -75,8 +75,8 @@ your-project/
|
|
|
75
75
|
### Key Concept Changes
|
|
76
76
|
|
|
77
77
|
- **v4 `.bmad-core`**: Was actually the BMad Method
|
|
78
|
-
- **v6
|
|
79
|
-
- **v6
|
|
78
|
+
- **v6 `.bmad/core/`**: Is the real universal core framework
|
|
79
|
+
- **v6 `.bmad/bmm/`**: Is the BMad Method module
|
|
80
80
|
- **Module identification**: All modules now have a `config.yaml` file
|
|
81
81
|
|
|
82
82
|
---
|
|
@@ -114,11 +114,11 @@ In v4, you may have modified agent files directly in `.bmad-*` folders.
|
|
|
114
114
|
|
|
115
115
|
### v6 Agent Customization
|
|
116
116
|
|
|
117
|
-
**All customizations** now go in
|
|
117
|
+
**All customizations** now go in `.bmad/_cfg/agents/` using customize files:
|
|
118
118
|
|
|
119
119
|
**Example: Renaming an agent and changing communication style**
|
|
120
120
|
|
|
121
|
-
File:
|
|
121
|
+
File: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
|
|
122
122
|
|
|
123
123
|
```yaml
|
|
124
124
|
# Customize the PM agent
|
|
@@ -133,8 +133,8 @@ persona:
|
|
|
133
133
|
|
|
134
134
|
**How it works:**
|
|
135
135
|
|
|
136
|
-
- Base agent:
|
|
137
|
-
- Customization:
|
|
136
|
+
- Base agent: `.bmad/bmm/agents/pm.md`
|
|
137
|
+
- Customization: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
|
|
138
138
|
- Result: Agent uses your custom name and style, but updates don't overwrite your changes
|
|
139
139
|
|
|
140
140
|
---
|
|
@@ -212,9 +212,9 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
|
|
|
212
212
|
## Post-Migration Checklist
|
|
213
213
|
|
|
214
214
|
- [ ] v4 folders backed up to `v4-backup/`
|
|
215
|
-
- [ ] v6 installed to
|
|
215
|
+
- [ ] v6 installed to `.bmad/` folder
|
|
216
216
|
- [ ] `workflow-init` run with correct project level selected
|
|
217
|
-
- [ ] Agent customizations migrated to
|
|
217
|
+
- [ ] Agent customizations migrated to `.bmad/_cfg/agents/` if needed
|
|
218
218
|
- [ ] IDE integration working (test by listing agents)
|
|
219
219
|
- [ ] For active development: `sprint-planning` workflow executed
|
|
220
220
|
|
|
@@ -224,4 +224,4 @@ Since you are migrating an existing project from v4, it's most likely **Level 3
|
|
|
224
224
|
|
|
225
225
|
- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
|
|
226
226
|
- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
|
227
|
-
- **Docs**: Check
|
|
227
|
+
- **Docs**: Check `.bmad/docs/` in your installation for IDE-specific instructions
|
|
@@ -73,7 +73,7 @@ web-bundles/
|
|
|
73
73
|
|
|
74
74
|
**Create a Gem:**
|
|
75
75
|
|
|
76
|
-
1. Go to [
|
|
76
|
+
1. Go to [Gemini Gem manager](https://gemini.google.com/gems/view)
|
|
77
77
|
2. Click "New Gem" or "Create Gem"
|
|
78
78
|
3. Give your Gem a name (e.g., "BMad PM Agent")
|
|
79
79
|
4. **Enable "Code execution" for best results with document generation**
|
|
@@ -336,7 +336,7 @@ Agents adapt their menus based on project phase and available workflows.
|
|
|
336
336
|
|
|
337
337
|
Customize agents using the [Agent Customization Guide](./agent-customization-guide.md):
|
|
338
338
|
|
|
339
|
-
1. Edit
|
|
339
|
+
1. Edit `.bmad/_cfg/agents/<agent>.customize.yaml`
|
|
340
340
|
2. Rebuild: `npx bmad-method build <agent-name>`
|
|
341
341
|
3. Generate bundles: `npm run bundle`
|
|
342
342
|
|
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@ const chalk = require('chalk');
|
|
|
6
6
|
*
|
|
7
7
|
* @param {Object} options - Installation options
|
|
8
8
|
* @param {string} options.projectRoot - The root directory of the target project
|
|
9
|
-
* @param {Object} options.config - Module configuration from
|
|
9
|
+
* @param {Object} options.config - Module configuration from module.yaml
|
|
10
10
|
* @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
|
|
11
11
|
* @param {Object} options.logger - Logger instance for output
|
|
12
12
|
* @returns {Promise<boolean>} - Success status
|