bmad-method 6.0.0-alpha.19 → 6.0.0-alpha.20
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/.github/workflows/docs.yaml +72 -0
- package/.github/workflows/quality.yaml +0 -3
- package/CHANGELOG.md +125 -0
- package/CONTRIBUTING.md +1 -3
- package/README.md +8 -7
- package/docs/agent-customization-guide.md +3 -3
- package/docs/custom-content-installation.md +1 -1
- package/docs/document-sharding-guide.md +2 -2
- package/docs/getting-started/installation.md +76 -0
- package/docs/ide-info/index.md +24 -0
- package/docs/ide-info/rovo-dev.md +14 -380
- package/docs/index.md +36 -45
- package/eslint.config.mjs +7 -2
- package/package.json +14 -8
- package/{docs → samples}/sample-custom-modules/README.md +1 -1
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md +2 -2
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md +1 -1
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md +1 -1
- package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/workflow.md +1 -1
- package/src/core/tasks/review-adversarial-general.xml +41 -0
- package/src/modules/bmb/README.md +25 -0
- package/src/modules/bmb/docs/agents/expert-agent-architecture.md +3 -3
- package/src/modules/bmb/docs/agents/index.md +9 -9
- package/src/modules/bmb/docs/agents/simple-agent-architecture.md +1 -1
- package/src/modules/bmb/docs/agents/understanding-agent-types.md +1 -1
- package/src/modules/bmb/docs/{README.md → index.md} +10 -12
- package/src/modules/bmb/docs/workflows/index.md +6 -6
- package/src/modules/bmb/docs/workflows/templates/step-01-init-continuable-template.md +7 -7
- package/src/modules/bmb/docs/workflows/templates/step-1b-template.md +1 -1
- package/src/modules/bmb/docs/workflows/templates/step-template.md +7 -7
- package/src/modules/bmb/docs/workflows/templates/workflow-template.md +1 -1
- package/src/modules/bmb/docs/workflows/templates/workflow.md +1 -1
- package/src/modules/bmb/reference/workflows/meal-prep-nutrition/workflow.md +1 -1
- package/src/modules/bmb/workflows/create-agent/data/reference/workflows/meal-prep-nutrition/workflow.md +1 -1
- package/src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md +3 -3
- package/src/modules/bmb/workflows/create-module/steps/step-04-structure.md +1 -1
- package/src/modules/bmb/workflows/create-module/steps/step-08-installer.md +5 -5
- package/src/modules/bmb/workflows/create-module/templates/agent.template.md +1 -1
- package/src/modules/bmb/workflows/create-module/validation.md +2 -2
- package/src/modules/bmb/workflows/create-module/workflow.md +1 -1
- package/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md +2 -2
- package/src/modules/bmb/workflows/create-workflow/workflow.md +1 -1
- package/src/modules/bmb/workflows/edit-agent/workflow.md +1 -1
- package/src/modules/bmb/workflows/edit-workflow/workflow.md +1 -1
- package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +1 -1
- package/src/modules/bmb/workflows/workflow-compliance-check/workflow.md +1 -1
- package/src/modules/bmb/workflows-legacy/edit-module/checklist.md +1 -1
- package/src/modules/bmb/workflows-legacy/edit-module/instructions.md +3 -3
- package/src/modules/bmb/workflows-legacy/module-brief/instructions.md +2 -2
- package/src/modules/bmgd/_module-installer/installer.js +2 -2
- package/src/modules/bmgd/agents/game-architect.agent.yaml +4 -0
- package/src/modules/bmgd/docs/{README.md → index.md} +2 -2
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/instructions.md +4 -4
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-01-init.md +1 -1
- package/src/modules/bmgd/workflows/1-preproduction/brainstorm-game/steps/step-04-complete.md +1 -1
- package/src/modules/bmgd/workflows/1-preproduction/game-brief/instructions.md +4 -4
- package/src/modules/bmgd/workflows/2-design/narrative/instructions-narrative.md +4 -4
- package/src/modules/bmgd/workflows/2-design/narrative/steps/step-11-complete.md +1 -1
- package/src/modules/bmgd/workflows/3-technical/game-architecture/instructions.md +5 -5
- package/src/modules/bmgd/workflows/3-technical/game-architecture/steps/step-09-complete.md +60 -6
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/project-context-template.md +20 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-01-discover.md +201 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-02-generate.md +373 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/steps/step-03-complete.md +279 -0
- package/src/modules/bmgd/workflows/3-technical/generate-project-context/workflow.md +48 -0
- package/src/modules/bmgd/workflows/4-production/code-review/workflow.yaml +3 -3
- 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/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/4-production/dev-story/workflow.yaml +4 -4
- package/src/modules/bmgd/workflows/4-production/retrospective/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/retrospective/workflow.yaml +5 -5
- package/src/modules/bmgd/workflows/4-production/sprint-planning/instructions.md +11 -2
- package/src/modules/bmgd/workflows/4-production/sprint-planning/workflow.yaml +4 -4
- package/src/modules/bmgd/workflows/4-production/sprint-status/instructions.md +2 -2
- package/src/modules/bmgd/workflows/4-production/sprint-status/workflow.yaml +3 -3
- package/src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/instructions.md +3 -3
- package/src/modules/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/workflow-status/init/instructions.md +2 -2
- package/src/modules/bmgd/workflows/workflow-status/init/workflow.yaml +1 -1
- package/src/modules/bmgd/workflows/workflow-status/instructions.md +2 -2
- package/src/modules/bmm/README.md +5 -6
- package/src/modules/bmm/_module-installer/installer.js +2 -2
- package/src/modules/bmm/agents/analyst.agent.yaml +1 -1
- package/src/modules/bmm/agents/dev.agent.yaml +8 -4
- package/src/modules/bmm/agents/quick-flow-solo-dev.agent.yaml +8 -17
- package/src/modules/bmm/agents/sm.agent.yaml +6 -3
- package/src/modules/bmm/agents/tech-writer.agent.yaml +1 -1
- package/src/modules/bmm/agents/ux-designer.agent.yaml +6 -3
- package/src/modules/bmm/docs/agents-guide.md +83 -1026
- package/src/modules/bmm/docs/bmad-quick-flow.md +10 -32
- package/src/modules/bmm/docs/brownfield-guide.md +1 -1
- package/src/modules/bmm/docs/enterprise-agentic-development.md +1 -1
- package/src/modules/bmm/docs/{README.md → index.md} +7 -88
- package/src/modules/bmm/docs/quick-spec-flow.md +1 -1
- package/src/modules/bmm/docs/quick-start.md +7 -7
- package/src/modules/bmm/docs/scale-adaptive-system.md +1 -1
- package/src/modules/bmm/docs/test-architecture.md +13 -12
- package/src/modules/bmm/docs/workflows-solutioning.md +1 -1
- package/src/modules/bmm/module.yaml +11 -10
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +7 -5
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +2 -4
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +2 -2
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +7 -10
- package/src/modules/bmm/workflows/1-analysis/create-product-brief/workflow.md +3 -3
- package/src/modules/bmm/workflows/1-analysis/research/research.template.md +14 -0
- package/src/modules/bmm/workflows/1-analysis/research/workflow.md +8 -39
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +15 -15
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +5 -25
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +6 -6
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +5 -5
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +2 -2
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +3 -5
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +4 -4
- package/src/modules/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +2 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +0 -1
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +9 -21
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +2 -2
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +4 -4
- package/src/modules/bmm/workflows/3-solutioning/create-architecture/workflow.md +1 -1
- package/src/modules/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +8 -8
- 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/4-implementation/code-review/workflow.yaml +4 -4
- 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 +16 -14
- package/src/modules/bmm/workflows/4-implementation/create-story/instructions.xml +2 -12
- package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +4 -4
- package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.xml +1 -1
- package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +3 -3
- package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +5 -5
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +7 -6
- package/src/modules/bmm/workflows/4-implementation/sprint-status/instructions.md +2 -2
- package/src/modules/bmm/workflows/4-implementation/sprint-status/workflow.yaml +4 -3
- package/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/instructions.md +4 -4
- package/src/modules/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml +4 -2
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +51 -0
- package/src/modules/bmm/workflows/document-project/instructions.md +27 -28
- package/src/modules/bmm/workflows/document-project/workflow.yaml +2 -3
- package/src/modules/bmm/workflows/generate-project-context/project-context-template.md +2 -1
- package/src/modules/bmm/workflows/generate-project-context/steps/step-01-discover.md +5 -15
- package/src/modules/bmm/workflows/generate-project-context/steps/step-02-generate.md +2 -2
- package/src/modules/bmm/workflows/testarch/atdd/atdd-checklist-template.md +8 -7
- package/src/modules/bmm/workflows/testarch/atdd/checklist.md +1 -0
- package/src/modules/bmm/workflows/testarch/atdd/instructions.md +1 -0
- package/src/modules/bmm/workflows/testarch/automate/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/ci/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/ci/instructions.md +2 -0
- package/src/modules/bmm/workflows/testarch/nfr-assess/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +2 -0
- package/src/modules/bmm/workflows/testarch/test-design/checklist.md +3 -2
- package/src/modules/bmm/workflows/testarch/test-design/instructions.md +1 -1
- package/src/modules/bmm/workflows/testarch/test-design/test-design-template.md +9 -0
- package/src/modules/bmm/workflows/testarch/test-review/checklist.md +2 -0
- package/src/modules/bmm/workflows/testarch/test-review/test-review-template.md +2 -0
- package/src/modules/bmm/workflows/testarch/trace/checklist.md +1 -0
- package/src/modules/bmm/workflows/testarch/trace/instructions.md +2 -0
- package/src/modules/bmm/workflows/testarch/trace/trace-template.md +2 -0
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +2 -2
- package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +1 -1
- package/src/modules/bmm/workflows/workflow-status/instructions.md +2 -2
- package/src/modules/bmm/workflows/workflow-status/workflow.yaml +3 -1
- package/src/modules/cis/{readme.md → docs/index.md} +2 -6
- package/src/modules/cis/workflows/design-thinking/instructions.md +2 -2
- package/src/modules/cis/workflows/innovation-strategy/instructions.md +2 -2
- package/src/modules/cis/workflows/problem-solving/instructions.md +2 -2
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-wrong-shortcut.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +30 -0
- package/tools/build-docs.js +630 -0
- package/tools/cli/commands/install.js +11 -5
- package/tools/cli/installers/install-messages.yaml +52 -0
- package/tools/cli/installers/lib/core/config-collector.js +25 -30
- package/tools/cli/installers/lib/message-loader.js +85 -0
- package/tools/cli/lib/ui.js +221 -41
- package/tools/schema/agent.js +68 -5
- package/website/css/custom.css +52 -0
- package/website/docusaurus.config.js +179 -0
- package/website/sidebars.js +157 -0
- package/website/src/pages/downloads.md +81 -0
- package/website/src/pages/index.js +50 -0
- package/website/static/favicon.ico +0 -0
- package/website/static/img/logo.svg +4 -0
- package/website/static/robots.txt +37 -0
- package/docs/installers-bundlers/ide-injections.md +0 -186
- package/docs/installers-bundlers/installers-modules-platforms-reference.md +0 -389
- package/src/modules/bmgd/README.md +0 -209
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/checklist.md +0 -25
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/instructions.md +0 -202
- package/src/modules/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml +0 -33
- package/tools/cli/commands/build.js +0 -283
- package/tools/cli/commands/list.js +0 -40
- package/tools/cli/commands/status.js +0 -47
- package/tools/cli/commands/uninstall.js +0 -44
- package/tools/cli/commands/update.js +0 -28
- package/tools/validate-bundles.js +0 -87
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/commit-poet/commit-poet.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/instructions.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/bundlers.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/deploy.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/docs.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/tests.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/memories.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/module.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-07-q6.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-08-q7.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-09-q8.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-10-q9.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-11-q10.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-12-results.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/quiz-master/templates/csv-headers.template +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-unitary-module/workflows/wassup/workflow.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/meditation-guide.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/foo.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/addition1.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/insights.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/instructions.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/memories.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion-sidecar/patterns.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/agents/wellness-companion/wellness-companion.agent.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/module.yaml +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/daily-checkin/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/daily-checkin/workflow.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/guided-meditation/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/guided-meditation/workflow.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/wellness-journal/README.md +0 -0
- /package/{docs → samples}/sample-custom-modules/sample-wellness-module/workflows/wellness-journal/workflow.md +0 -0
|
@@ -1,388 +1,22 @@
|
|
|
1
|
-
# Rovo Dev
|
|
1
|
+
# BMAD Method - Rovo Dev Instructions
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Activating Agents
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
BMAD agents are installed as subagents in `.rovodev/subagents/`.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
### How to Use
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
1. **Open Project**: Subagents auto-load when project opens
|
|
10
|
+
2. **Invoke Agent**: Type `@` and select agent (e.g., `@bmad-bmm-dev`, `@bmad-bmm-architect`)
|
|
11
|
+
3. **Reference Files**: Check `.rovodev/workflows/` and `.rovodev/references/`
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
- **Workflows**: Multi-step workflow guides and coordinators
|
|
13
|
-
- **Tasks & Tools**: Reference documentation for BMAD tasks and tools
|
|
13
|
+
### Directory Structure
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
- `.rovodev/subagents/` - BMAD agents
|
|
16
|
+
- `.rovodev/workflows/` - Workflow guides
|
|
17
|
+
- `.rovodev/references/` - Tasks and tools
|
|
16
18
|
|
|
17
|
-
|
|
19
|
+
### Notes
|
|
18
20
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
### Automatic Installation
|
|
22
|
-
|
|
23
|
-
When you run the BMAD-METHOD installer and select Rovo Dev as your IDE:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
bmad install
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
The installer will:
|
|
30
|
-
|
|
31
|
-
1. Create a `.rovodev/subagents/` directory in your project (if it doesn't exist)
|
|
32
|
-
2. Convert BMAD agents into Rovo Dev subagent format
|
|
33
|
-
3. Write subagent files with the naming pattern: `bmad-<module>-<agent-name>.md`
|
|
34
|
-
|
|
35
|
-
### File Structure
|
|
36
|
-
|
|
37
|
-
After installation, your project will have:
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
project-root/
|
|
41
|
-
├── .rovodev/
|
|
42
|
-
│ ├── subagents/
|
|
43
|
-
│ │ ├── bmad-core-code-reviewer.md
|
|
44
|
-
│ │ ├── bmad-bmm-pm.md
|
|
45
|
-
│ │ ├── bmad-bmm-dev.md
|
|
46
|
-
│ │ └── ... (more agents from selected modules)
|
|
47
|
-
│ ├── workflows/
|
|
48
|
-
│ │ ├── bmad-brainstorming.md
|
|
49
|
-
│ │ ├── bmad-prd-creation.md
|
|
50
|
-
│ │ └── ... (workflow guides)
|
|
51
|
-
│ ├── references/
|
|
52
|
-
│ │ ├── bmad-task-core-code-review.md
|
|
53
|
-
│ │ ├── bmad-tool-core-analysis.md
|
|
54
|
-
│ │ └── ... (task/tool references)
|
|
55
|
-
│ ├── config.yml (Rovo Dev configuration)
|
|
56
|
-
│ ├── prompts.yml (Optional: reusable prompts)
|
|
57
|
-
│ └── ...
|
|
58
|
-
├── _bmad/ (BMAD installation directory)
|
|
59
|
-
└── ...
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
**Directory Structure Explanation:**
|
|
63
|
-
|
|
64
|
-
- **subagents/**: Agents discovered and used by Rovo Dev with `@agent-name` syntax
|
|
65
|
-
- **workflows/**: Multi-step workflow guides and instructions
|
|
66
|
-
- **references/**: Documentation for available tasks and tools in BMAD
|
|
67
|
-
|
|
68
|
-
## Subagent File Format
|
|
69
|
-
|
|
70
|
-
BMAD agents are converted to Rovo Dev subagent format, which uses Markdown with YAML frontmatter:
|
|
71
|
-
|
|
72
|
-
### Basic Structure
|
|
73
|
-
|
|
74
|
-
```markdown
|
|
75
|
-
---
|
|
76
|
-
name: bmad-module-agent-name
|
|
77
|
-
description: One sentence description of what this agent does
|
|
78
|
-
tools:
|
|
79
|
-
- bash
|
|
80
|
-
- open_files
|
|
81
|
-
- grep
|
|
82
|
-
- expand_code_chunks
|
|
83
|
-
model: anthropic.claude-3-5-sonnet-20241022-v2:0 # Optional
|
|
84
|
-
load_memory: true # Optional
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
You are a specialized agent for [specific task].
|
|
88
|
-
|
|
89
|
-
## Your Role
|
|
90
|
-
|
|
91
|
-
Describe the agent's role and responsibilities...
|
|
92
|
-
|
|
93
|
-
## Key Instructions
|
|
94
|
-
|
|
95
|
-
1. First instruction
|
|
96
|
-
2. Second instruction
|
|
97
|
-
3. Third instruction
|
|
98
|
-
|
|
99
|
-
## When to Use This Agent
|
|
100
|
-
|
|
101
|
-
Explain when and how to use this agent...
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
### YAML Frontmatter Fields
|
|
105
|
-
|
|
106
|
-
| Field | Type | Required | Description |
|
|
107
|
-
| ------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
108
|
-
| `name` | string | Yes | Unique identifier for the subagent (kebab-case, no spaces) |
|
|
109
|
-
| `description` | string | Yes | One-line description of the subagent's purpose |
|
|
110
|
-
| `tools` | array | No | List of tools the subagent can use. If not specified, uses parent agent's tools |
|
|
111
|
-
| `model` | string | No | Specific LLM model for this subagent (e.g., `anthropic.claude-3-5-sonnet-20241022-v2:0`). If not specified, uses parent agent's model |
|
|
112
|
-
| `load_memory` | boolean | No | Whether to load default memory files (AGENTS.md, AGENTS.local.md). Defaults to `true` |
|
|
113
|
-
|
|
114
|
-
### System Prompt
|
|
115
|
-
|
|
116
|
-
The content after the closing `---` is the subagent's system prompt. This defines:
|
|
117
|
-
|
|
118
|
-
- The agent's persona and role
|
|
119
|
-
- Its capabilities and constraints
|
|
120
|
-
- Step-by-step instructions for task execution
|
|
121
|
-
- Examples of expected behavior
|
|
122
|
-
|
|
123
|
-
## Using BMAD Components in Rovo Dev
|
|
124
|
-
|
|
125
|
-
### Invoking a Subagent (Agent)
|
|
126
|
-
|
|
127
|
-
In Rovo Dev, you can invoke a BMAD agent as a subagent using the `@` syntax:
|
|
128
|
-
|
|
129
|
-
```
|
|
130
|
-
@bmad-core-code-reviewer Please review this PR for potential issues
|
|
131
|
-
@bmad-bmm-pm Help plan this feature release
|
|
132
|
-
@bmad-bmm-dev Implement this feature
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### Accessing Workflows
|
|
136
|
-
|
|
137
|
-
Workflow guides are available in `.rovodev/workflows/` directory:
|
|
138
|
-
|
|
139
|
-
```
|
|
140
|
-
@bmad-core-code-reviewer Use the brainstorming workflow from .rovodev/workflows/bmad-brainstorming.md
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
Workflow files contain step-by-step instructions and can be referenced or copied into Rovo Dev for collaborative workflow execution.
|
|
144
|
-
|
|
145
|
-
### Accessing Tasks and Tools
|
|
146
|
-
|
|
147
|
-
Task and tool documentation is available in `.rovodev/references/` directory. These provide:
|
|
148
|
-
|
|
149
|
-
- Task execution instructions
|
|
150
|
-
- Tool capabilities and usage
|
|
151
|
-
- Integration examples
|
|
152
|
-
- Parameter documentation
|
|
153
|
-
|
|
154
|
-
### Example Usage Scenarios
|
|
155
|
-
|
|
156
|
-
#### Code Review
|
|
157
|
-
|
|
158
|
-
```
|
|
159
|
-
@bmad-core-code-reviewer Review the changes in src/components/Button.tsx
|
|
160
|
-
for best practices, performance, and potential bugs
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
#### Documentation
|
|
164
|
-
|
|
165
|
-
```
|
|
166
|
-
@bmad-core-documentation-writer Generate API documentation for the new
|
|
167
|
-
user authentication module
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
#### Feature Design
|
|
171
|
-
|
|
172
|
-
```
|
|
173
|
-
@bmad-module-feature-designer Design a solution for implementing
|
|
174
|
-
dark mode support across the application
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
## Customizing BMAD Subagents
|
|
178
|
-
|
|
179
|
-
You can customize BMAD subagents after installation by editing their files directly in `.rovodev/subagents/`.
|
|
180
|
-
|
|
181
|
-
### Example: Adding Tool Restrictions
|
|
182
|
-
|
|
183
|
-
By default, BMAD subagents inherit tools from the parent Rovo Dev agent. You can restrict which tools a specific subagent can use:
|
|
184
|
-
|
|
185
|
-
```yaml
|
|
186
|
-
---
|
|
187
|
-
name: bmad-core-code-reviewer
|
|
188
|
-
description: Reviews code and suggests improvements
|
|
189
|
-
tools:
|
|
190
|
-
- open_files
|
|
191
|
-
- expand_code_chunks
|
|
192
|
-
- grep
|
|
193
|
-
---
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
### Example: Using a Specific Model
|
|
197
|
-
|
|
198
|
-
Some agents might benefit from using a different model. You can specify this:
|
|
199
|
-
|
|
200
|
-
```yaml
|
|
201
|
-
---
|
|
202
|
-
name: bmad-core-documentation-writer
|
|
203
|
-
description: Writes clear and comprehensive documentation
|
|
204
|
-
model: anthropic.claude-3-5-sonnet-20241022-v2:0
|
|
205
|
-
---
|
|
206
|
-
```
|
|
207
|
-
|
|
208
|
-
### Example: Enhancing the System Prompt
|
|
209
|
-
|
|
210
|
-
You can add additional context to a subagent's system prompt:
|
|
211
|
-
|
|
212
|
-
```markdown
|
|
213
|
-
---
|
|
214
|
-
name: bmad-core-code-reviewer
|
|
215
|
-
description: Reviews code and suggests improvements
|
|
216
|
-
---
|
|
217
|
-
|
|
218
|
-
You are a specialized code review agent for our project.
|
|
219
|
-
|
|
220
|
-
## Project Context
|
|
221
|
-
|
|
222
|
-
Our codebase uses:
|
|
223
|
-
|
|
224
|
-
- React 18 for frontend
|
|
225
|
-
- Node.js 18+ for backend
|
|
226
|
-
- TypeScript for type safety
|
|
227
|
-
- Jest for testing
|
|
228
|
-
|
|
229
|
-
## Review Checklist
|
|
230
|
-
|
|
231
|
-
1. Type safety and TypeScript correctness
|
|
232
|
-
2. React best practices and hooks usage
|
|
233
|
-
3. Performance considerations
|
|
234
|
-
4. Test coverage
|
|
235
|
-
5. Documentation and comments
|
|
236
|
-
|
|
237
|
-
...rest of original system prompt...
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
## Memory and Context
|
|
241
|
-
|
|
242
|
-
By default, BMAD subagents have `load_memory: true`, which means they will load memory files from your project:
|
|
243
|
-
|
|
244
|
-
- **Project-level**: `.rovodev/AGENTS.md` and `.rovodev/.agent.md`
|
|
245
|
-
- **User-level**: `~/.rovodev/AGENTS.md` (global memory across all projects)
|
|
246
|
-
|
|
247
|
-
These files can contain:
|
|
248
|
-
|
|
249
|
-
- Project guidelines and conventions
|
|
250
|
-
- Common patterns and best practices
|
|
251
|
-
- Recent decisions and context
|
|
252
|
-
- Custom instructions for all agents
|
|
253
|
-
|
|
254
|
-
### Creating Project Memory
|
|
255
|
-
|
|
256
|
-
Create `.rovodev/AGENTS.md` in your project:
|
|
257
|
-
|
|
258
|
-
```markdown
|
|
259
|
-
# Project Guidelines
|
|
260
|
-
|
|
261
|
-
## Code Style
|
|
262
|
-
|
|
263
|
-
- Use 2-space indentation
|
|
264
|
-
- Use camelCase for variables
|
|
265
|
-
- Use PascalCase for classes
|
|
266
|
-
|
|
267
|
-
## Architecture
|
|
268
|
-
|
|
269
|
-
- Follow modular component structure
|
|
270
|
-
- Use dependency injection for services
|
|
271
|
-
- Implement proper error handling
|
|
272
|
-
|
|
273
|
-
## Testing Requirements
|
|
274
|
-
|
|
275
|
-
- Minimum 80% code coverage
|
|
276
|
-
- Write tests before implementation
|
|
277
|
-
- Use descriptive test names
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
## Troubleshooting
|
|
281
|
-
|
|
282
|
-
### Subagents Not Appearing in Rovo Dev
|
|
283
|
-
|
|
284
|
-
1. **Verify files exist**: Check that `.rovodev/subagents/bmad-*.md` files are present
|
|
285
|
-
2. **Check Rovo Dev is reloaded**: Rovo Dev may cache agent definitions. Restart Rovo Dev or reload the project
|
|
286
|
-
3. **Verify file format**: Ensure files have proper YAML frontmatter (between `---` markers)
|
|
287
|
-
4. **Check file permissions**: Ensure files are readable by Rovo Dev
|
|
288
|
-
|
|
289
|
-
### Agent Name Conflicts
|
|
290
|
-
|
|
291
|
-
If you have custom subagents with the same names as BMAD agents, Rovo Dev will load both but may show a warning. Use unique prefixes for custom subagents to avoid conflicts.
|
|
292
|
-
|
|
293
|
-
### Tools Not Available
|
|
294
|
-
|
|
295
|
-
If a subagent's tools aren't working:
|
|
296
|
-
|
|
297
|
-
1. Verify the tool names match Rovo Dev's available tools
|
|
298
|
-
2. Check that the parent Rovo Dev agent has access to those tools
|
|
299
|
-
3. Ensure tool permissions are properly configured in `.rovodev/config.yml`
|
|
300
|
-
|
|
301
|
-
## Advanced: Tool Configuration
|
|
302
|
-
|
|
303
|
-
Rovo Dev agents have access to a set of tools for various tasks. Common tools available include:
|
|
304
|
-
|
|
305
|
-
- `bash`: Execute shell commands
|
|
306
|
-
- `open_files`: View file contents
|
|
307
|
-
- `grep`: Search across files
|
|
308
|
-
- `expand_code_chunks`: View specific code sections
|
|
309
|
-
- `find_and_replace_code`: Modify files
|
|
310
|
-
- `create_file`: Create new files
|
|
311
|
-
- `delete_file`: Delete files
|
|
312
|
-
- `move_file`: Rename or move files
|
|
313
|
-
|
|
314
|
-
### MCP Servers
|
|
315
|
-
|
|
316
|
-
Rovo Dev can also connect to Model Context Protocol (MCP) servers, which provide additional tools and data sources:
|
|
317
|
-
|
|
318
|
-
- **Atlassian Integration**: Access to Jira, Confluence, and Bitbucket
|
|
319
|
-
- **Code Analysis**: Custom code analysis and metrics
|
|
320
|
-
- **External Services**: APIs and third-party integrations
|
|
321
|
-
|
|
322
|
-
Configure MCP servers in `~/.rovodev/mcp.json` or `.rovodev/mcp.json`.
|
|
323
|
-
|
|
324
|
-
## Integration with Other IDE Handlers
|
|
325
|
-
|
|
326
|
-
BMAD-METHOD supports multiple IDEs simultaneously. You can have both Rovo Dev and other IDE configurations (Cursor, VS Code, etc.) in the same project. Each IDE will have its own artifacts installed in separate directories.
|
|
327
|
-
|
|
328
|
-
For example:
|
|
329
|
-
|
|
330
|
-
- Rovo Dev agents: `.rovodev/subagents/bmad-*.md`
|
|
331
|
-
- Cursor rules: `.cursor/rules/bmad/`
|
|
332
|
-
- Claude Code: `.claude/rules/bmad/`
|
|
333
|
-
|
|
334
|
-
## Performance Considerations
|
|
335
|
-
|
|
336
|
-
- BMAD subagent files are typically small (1-5 KB each)
|
|
337
|
-
- Rovo Dev lazy-loads subagents, so having many subagents doesn't impact startup time
|
|
338
|
-
- System prompts are cached by Rovo Dev after first load
|
|
339
|
-
|
|
340
|
-
## Best Practices
|
|
341
|
-
|
|
342
|
-
1. **Keep System Prompts Concise**: Shorter, well-structured prompts are more effective
|
|
343
|
-
2. **Use Project Memory**: Leverage `.rovodev/AGENTS.md` for shared context
|
|
344
|
-
3. **Customize Tool Restrictions**: Give subagents only the tools they need
|
|
345
|
-
4. **Test Subagent Invocations**: Verify each subagent works as expected for your project
|
|
346
|
-
5. **Version Control**: Commit `.rovodev/subagents/` to version control for team consistency
|
|
347
|
-
6. **Document Custom Subagents**: Add comments explaining the purpose of customized subagents
|
|
348
|
-
|
|
349
|
-
## Related Documentation
|
|
350
|
-
|
|
351
|
-
- [Rovo Dev Official Documentation](https://www.atlassian.com/rovo-dev)
|
|
352
|
-
- [BMAD-METHOD Installation Guide](./installation.md)
|
|
353
|
-
- [IDE Handler Architecture](./ide-handlers.md)
|
|
354
|
-
- [Rovo Dev Configuration Reference](https://www.atlassian.com/rovo-dev/configuration)
|
|
355
|
-
|
|
356
|
-
## Examples
|
|
357
|
-
|
|
358
|
-
### Example 1: Code Review Workflow
|
|
359
|
-
|
|
360
|
-
```
|
|
361
|
-
User: @bmad-core-code-reviewer Review src/auth/login.ts for security issues
|
|
362
|
-
Rovo Dev → Subagent: Opens file, analyzes code, suggests improvements
|
|
363
|
-
Subagent output: Security vulnerabilities found, recommendations provided
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
### Example 2: Documentation Generation
|
|
367
|
-
|
|
368
|
-
```
|
|
369
|
-
User: @bmad-core-documentation-writer Generate API docs for the new payment module
|
|
370
|
-
Rovo Dev → Subagent: Analyzes code structure, generates documentation
|
|
371
|
-
Subagent output: Markdown documentation with examples and API reference
|
|
372
|
-
```
|
|
373
|
-
|
|
374
|
-
### Example 3: Architecture Design
|
|
375
|
-
|
|
376
|
-
```
|
|
377
|
-
User: @bmad-module-feature-designer Design a caching strategy for the database layer
|
|
378
|
-
Rovo Dev → Subagent: Reviews current architecture, proposes design
|
|
379
|
-
Subagent output: Detailed architecture proposal with implementation plan
|
|
380
|
-
```
|
|
381
|
-
|
|
382
|
-
## Support
|
|
383
|
-
|
|
384
|
-
For issues or questions about:
|
|
385
|
-
|
|
386
|
-
- **Rovo Dev**: See [Atlassian Rovo Dev Documentation](https://www.atlassian.com/rovo-dev)
|
|
387
|
-
- **BMAD-METHOD**: See [BMAD-METHOD README](../README.md)
|
|
388
|
-
- **IDE Integration**: See [IDE Handler Guide](./ide-handlers.md)
|
|
21
|
+
- Agents are automatically discovered by Rovo Dev
|
|
22
|
+
- Subagents use YAML frontmatter for configuration
|
package/docs/index.md
CHANGED
|
@@ -8,11 +8,11 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
|
|
|
8
8
|
|
|
9
9
|
**New users:** Start with one of these based on your situation:
|
|
10
10
|
|
|
11
|
-
| Your Situation | Start Here
|
|
12
|
-
| ---------------------- |
|
|
13
|
-
| **Brand new to BMad** | [Quick Start Guide](
|
|
14
|
-
| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)
|
|
15
|
-
| **Brownfield project** | [Brownfield Guide](
|
|
11
|
+
| Your Situation | Start Here | Then Read |
|
|
12
|
+
| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
|
|
13
|
+
| **Brand new to BMad** | [Quick Start Guide](./modules/bmm/quick-start) | [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) |
|
|
14
|
+
| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](./modules/bmm/quick-start) |
|
|
15
|
+
| **Brownfield project** | [Brownfield Guide](./modules/bmm/brownfield-guide) | [Quick Start Guide](./modules/bmm/quick-start) |
|
|
16
16
|
|
|
17
17
|
---
|
|
18
18
|
|
|
@@ -20,16 +20,14 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
|
|
|
20
20
|
|
|
21
21
|
### Project-Level Docs (Root)
|
|
22
22
|
|
|
23
|
-
- **[README.md](
|
|
24
|
-
- **[CONTRIBUTING.md](
|
|
25
|
-
- **[CHANGELOG.md](
|
|
26
|
-
- **[CLAUDE.md](../CLAUDE.md)** - Claude Code specific guidelines for this project
|
|
23
|
+
- **[README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md)** - Main project overview, feature summary, and module introductions
|
|
24
|
+
- **[CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
|
|
25
|
+
- **[CHANGELOG.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)** - Version history and breaking changes
|
|
27
26
|
|
|
28
27
|
### Installation & Setup
|
|
29
28
|
|
|
30
29
|
- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
|
|
31
30
|
- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents for 90%+ token savings
|
|
32
|
-
- **[Web Bundles](./USING_WEB_BUNDLES.md)** - Use BMAD agents in Claude Projects, ChatGPT, or Gemini without installation
|
|
33
31
|
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing
|
|
34
32
|
|
|
35
33
|
---
|
|
@@ -40,27 +38,27 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
|
|
|
40
38
|
|
|
41
39
|
The flagship module for agile AI-driven development.
|
|
42
40
|
|
|
43
|
-
- **[BMM Module README](
|
|
44
|
-
- **[BMM Documentation](
|
|
45
|
-
- [Quick Start Guide](
|
|
46
|
-
- [Quick Spec Flow](
|
|
47
|
-
- [Scale Adaptive System](
|
|
48
|
-
- [Brownfield Guide](
|
|
49
|
-
- **[BMM Workflows Guide](
|
|
50
|
-
- **[Test Architect Guide](
|
|
41
|
+
- **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index
|
|
42
|
+
- **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references:
|
|
43
|
+
- [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project
|
|
44
|
+
- [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development
|
|
45
|
+
- [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system
|
|
46
|
+
- [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases
|
|
47
|
+
- **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING**
|
|
48
|
+
- **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance
|
|
51
49
|
|
|
52
50
|
### BMad Builder (BMB) - Create Custom Solutions
|
|
53
51
|
|
|
54
52
|
Build your own agents, workflows, and modules.
|
|
55
53
|
|
|
56
|
-
- **[BMB Module
|
|
57
|
-
- **[Agent Creation Guide](
|
|
54
|
+
- **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities
|
|
55
|
+
- **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents
|
|
58
56
|
|
|
59
57
|
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
|
60
58
|
|
|
61
59
|
AI-powered creative thinking and brainstorming.
|
|
62
60
|
|
|
63
|
-
- **[CIS Module README](
|
|
61
|
+
- **[CIS Module README](./modules/cis/)** - Module overview and workflows
|
|
64
62
|
|
|
65
63
|
---
|
|
66
64
|
|
|
@@ -101,52 +99,45 @@ Instructions for loading agents and running workflows in your development enviro
|
|
|
101
99
|
- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
|
|
102
100
|
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
|
|
103
101
|
|
|
104
|
-
### Installation & Bundling
|
|
105
|
-
|
|
106
|
-
- [IDE Injections Reference](./installers-bundlers/ide-injections.md) - How agents are installed to IDEs
|
|
107
|
-
- [Installers & Platforms Reference](./installers-bundlers/installers-modules-platforms-reference.md) - CLI tool and platform support
|
|
108
|
-
- [Web Bundler Usage](./installers-bundlers/web-bundler-usage.md) - Creating web-compatible bundles
|
|
109
|
-
|
|
110
102
|
---
|
|
111
103
|
|
|
112
104
|
## 🎓 Recommended Reading Paths
|
|
113
105
|
|
|
114
106
|
### Path 1: Brand New to BMad (Software Project)
|
|
115
107
|
|
|
116
|
-
1. [README.md](
|
|
117
|
-
2. [Quick Start Guide](
|
|
118
|
-
3. [BMM Module README](
|
|
119
|
-
4. [BMM Workflows Guide](
|
|
108
|
+
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
|
109
|
+
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
|
110
|
+
3. [BMM Module README](./modules/bmm/) - Understand agents
|
|
111
|
+
4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
|
120
112
|
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
|
121
113
|
|
|
122
114
|
### Path 2: Game Development Project
|
|
123
115
|
|
|
124
|
-
1. [README.md](
|
|
125
|
-
2. [Quick Start Guide](
|
|
126
|
-
3. [BMM Module README](
|
|
127
|
-
4. [
|
|
116
|
+
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
|
117
|
+
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
|
118
|
+
3. [BMM Module README](./modules/bmm/) - Game agents are included
|
|
119
|
+
4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
|
|
128
120
|
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
|
129
121
|
|
|
130
122
|
### Path 3: Upgrading from v4
|
|
131
123
|
|
|
132
124
|
1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
|
|
133
|
-
2. [Quick Start Guide](
|
|
134
|
-
3. [BMM Workflows Guide](
|
|
125
|
+
2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself
|
|
126
|
+
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows
|
|
135
127
|
|
|
136
128
|
### Path 4: Working with Existing Codebase (Brownfield)
|
|
137
129
|
|
|
138
|
-
1. [Brownfield Guide](
|
|
139
|
-
2. [Quick Start Guide](
|
|
140
|
-
3. [BMM Workflows Guide](
|
|
130
|
+
1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code
|
|
131
|
+
2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process
|
|
132
|
+
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
|
141
133
|
|
|
142
134
|
### Path 5: Building Custom Solutions
|
|
143
135
|
|
|
144
|
-
1. [BMB Module
|
|
145
|
-
2. [Agent Creation Guide](
|
|
146
|
-
3. [
|
|
136
|
+
1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities
|
|
137
|
+
2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents
|
|
138
|
+
3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure
|
|
147
139
|
|
|
148
140
|
### Path 6: Contributing to BMad
|
|
149
141
|
|
|
150
|
-
1. [CONTRIBUTING.md](
|
|
142
|
+
1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
|
|
151
143
|
2. Relevant module README - Understand the area you're contributing to
|
|
152
|
-
3. [Code Style section in CONTRIBUTING.md](../CONTRIBUTING.md#code-style) - Follow standards
|
package/eslint.config.mjs
CHANGED
|
@@ -18,6 +18,10 @@ export default [
|
|
|
18
18
|
'test/fixtures/**/*.yaml',
|
|
19
19
|
'_bmad/**',
|
|
20
20
|
'_bmad*/**',
|
|
21
|
+
// Docusaurus build artifacts
|
|
22
|
+
'.docusaurus/**',
|
|
23
|
+
'build/**',
|
|
24
|
+
'website/**',
|
|
21
25
|
// Gitignored patterns
|
|
22
26
|
'z*/**', // z-samples, z1, z2, etc.
|
|
23
27
|
'.claude/**',
|
|
@@ -77,9 +81,9 @@ export default [
|
|
|
77
81
|
},
|
|
78
82
|
},
|
|
79
83
|
|
|
80
|
-
// CLI
|
|
84
|
+
// CLI scripts under tools/** and test/**
|
|
81
85
|
{
|
|
82
|
-
files: ['tools/**/*.js', 'test/**/*.js'],
|
|
86
|
+
files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js'],
|
|
83
87
|
rules: {
|
|
84
88
|
// Allow CommonJS patterns for Node CLI scripts
|
|
85
89
|
'unicorn/prefer-module': 'off',
|
|
@@ -106,6 +110,7 @@ export default [
|
|
|
106
110
|
'no-useless-catch': 'off',
|
|
107
111
|
'unicorn/prefer-number-properties': 'off',
|
|
108
112
|
'no-unreachable': 'off',
|
|
113
|
+
'unicorn/text-encoding-identifier-case': 'off',
|
|
109
114
|
},
|
|
110
115
|
},
|
|
111
116
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/package.json",
|
|
3
3
|
"name": "bmad-method",
|
|
4
|
-
"version": "6.0.0-alpha.
|
|
4
|
+
"version": "6.0.0-alpha.20",
|
|
5
5
|
"description": "Breakthrough Method of Agile AI-driven Development",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"agile",
|
|
@@ -25,11 +25,13 @@
|
|
|
25
25
|
},
|
|
26
26
|
"scripts": {
|
|
27
27
|
"bmad:install": "node tools/cli/bmad-cli.js install",
|
|
28
|
-
"bmad:status": "node tools/cli/bmad-cli.js status",
|
|
29
28
|
"bundle": "node tools/cli/bundlers/bundle-web.js all",
|
|
29
|
+
"docs:build": "node tools/build-docs.js",
|
|
30
|
+
"docs:dev": "npm run docs:build && npm run docs:serve",
|
|
31
|
+
"docs:serve": "docusaurus start --config website/docusaurus.config.js --host localhost",
|
|
30
32
|
"flatten": "node tools/flattener/main.js",
|
|
31
|
-
"format:check": "prettier --check \"**/*.{js,cjs,mjs,json,
|
|
32
|
-
"format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,
|
|
33
|
+
"format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"",
|
|
34
|
+
"format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"",
|
|
33
35
|
"install:bmad": "node tools/cli/bmad-cli.js install",
|
|
34
36
|
"lint": "eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0",
|
|
35
37
|
"lint:fix": "eslint . --ext .js,.cjs,.mjs,.yaml --fix",
|
|
@@ -40,11 +42,10 @@
|
|
|
40
42
|
"release:minor": "gh workflow run \"Manual Release\" -f version_bump=minor",
|
|
41
43
|
"release:patch": "gh workflow run \"Manual Release\" -f version_bump=patch",
|
|
42
44
|
"release:watch": "gh run watch",
|
|
43
|
-
"test": "npm run test:schemas && npm run test:install && npm run validate:
|
|
45
|
+
"test": "npm run test:schemas && npm run test:install && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check",
|
|
44
46
|
"test:coverage": "c8 --reporter=text --reporter=html npm run test:schemas",
|
|
45
47
|
"test:install": "node test/test-installation-components.js",
|
|
46
48
|
"test:schemas": "node test/test-agent-schema.js",
|
|
47
|
-
"validate:bundles": "node tools/validate-bundles.js",
|
|
48
49
|
"validate:schemas": "node tools/validate-agent-schema.js"
|
|
49
50
|
},
|
|
50
51
|
"lint-staged": {
|
|
@@ -60,8 +61,7 @@
|
|
|
60
61
|
"npm run format:fix"
|
|
61
62
|
],
|
|
62
63
|
"*.md": [
|
|
63
|
-
"markdownlint-cli2"
|
|
64
|
-
"npm run format:fix"
|
|
64
|
+
"markdownlint-cli2"
|
|
65
65
|
]
|
|
66
66
|
},
|
|
67
67
|
"dependencies": {
|
|
@@ -84,7 +84,10 @@
|
|
|
84
84
|
"yaml": "^2.7.0"
|
|
85
85
|
},
|
|
86
86
|
"devDependencies": {
|
|
87
|
+
"@docusaurus/core": "^3.6.0",
|
|
88
|
+
"@docusaurus/preset-classic": "^3.6.0",
|
|
87
89
|
"@eslint/js": "^9.33.0",
|
|
90
|
+
"archiver": "^7.0.1",
|
|
88
91
|
"c8": "^10.1.3",
|
|
89
92
|
"eslint": "^9.33.0",
|
|
90
93
|
"eslint-config-prettier": "^10.1.8",
|
|
@@ -97,6 +100,9 @@
|
|
|
97
100
|
"markdownlint-cli2": "^0.19.1",
|
|
98
101
|
"prettier": "^3.5.3",
|
|
99
102
|
"prettier-plugin-packagejson": "^2.5.19",
|
|
103
|
+
"prism-react-renderer": "^2.4.1",
|
|
104
|
+
"react": "^18.3.1",
|
|
105
|
+
"react-dom": "^18.3.1",
|
|
100
106
|
"yaml-eslint-parser": "^1.2.3",
|
|
101
107
|
"yaml-lint": "^1.7.0",
|
|
102
108
|
"zod": "^4.1.12"
|
|
@@ -4,7 +4,7 @@ These are quickly put together examples of both a stand alone somewhat cohesive
|
|
|
4
4
|
|
|
5
5
|
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
|
|
6
6
|
|
|
7
|
-
Note - a project is just a folder with
|
|
7
|
+
Note - a project is just a folder with \_bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
|
8
8
|
|
|
9
9
|
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
|
|
10
10
|
|