bmad-fh 6.0.0-alpha.23
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 +40 -0
- package/.githooks/post-checkout +129 -0
- package/.githooks/pre-commit +63 -0
- package/.githooks/pre-push +135 -0
- package/.github/CODE_OF_CONDUCT.md +128 -0
- package/.github/FUNDING.yaml +15 -0
- package/.github/ISSUE_TEMPLATE/config.yaml +8 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- package/.github/ISSUE_TEMPLATE/issue.md +32 -0
- package/.github/scripts/discord-helpers.sh +34 -0
- package/.github/workflows/bundle-latest.yaml +330 -0
- package/.github/workflows/discord.yaml +90 -0
- package/.github/workflows/docs.yaml +63 -0
- package/.github/workflows/manual-release.yaml +190 -0
- package/.github/workflows/publish-multi-artifact.yaml +50 -0
- package/.github/workflows/quality.yaml +115 -0
- package/.husky/pre-commit +20 -0
- package/.markdownlint-cli2.yaml +41 -0
- package/.nvmrc +1 -0
- package/.prettierignore +9 -0
- package/.vscode/settings.json +97 -0
- package/CHANGELOG.md +1394 -0
- package/CNAME +1 -0
- package/CONTRIBUTING.md +306 -0
- package/CONTRIBUTORS.md +32 -0
- package/LICENSE +30 -0
- package/README.md +126 -0
- package/SECURITY.md +85 -0
- package/TRADEMARK.md +55 -0
- package/Wordmark.png +0 -0
- package/banner-bmad-method.png +0 -0
- package/docs/404.md +9 -0
- package/docs/_README_WORKFLOW_DIAGRAMS.md +40 -0
- package/docs/_STYLE_GUIDE.md +367 -0
- package/docs/_archive/customize-workflows.md +30 -0
- package/docs/_archive/getting-started-bmadv4.md +247 -0
- package/docs/_archive/vendor-workflows.md +52 -0
- package/docs/downloads.md +72 -0
- package/docs/explanation/agents/barry-quick-flow.md +328 -0
- package/docs/explanation/agents/index.md +19 -0
- package/docs/explanation/architecture/four-phases.md +107 -0
- package/docs/explanation/architecture/preventing-agent-conflicts.md +111 -0
- package/docs/explanation/architecture/why-solutioning-matters.md +75 -0
- package/docs/explanation/bmm/index.md +131 -0
- package/docs/explanation/core/index.md +18 -0
- package/docs/explanation/core-concepts/agent-roles.md +179 -0
- package/docs/explanation/core-concepts/index.md +35 -0
- package/docs/explanation/core-concepts/what-are-agents.md +97 -0
- package/docs/explanation/core-concepts/what-are-modules.md +85 -0
- package/docs/explanation/core-concepts/what-are-workflows.md +204 -0
- package/docs/explanation/faq/brownfield-faq.md +73 -0
- package/docs/explanation/faq/getting-started-faq.md +67 -0
- package/docs/explanation/faq/implementation-faq.md +52 -0
- package/docs/explanation/faq/index.md +16 -0
- package/docs/explanation/faq/levels-and-tracks-faq.md +52 -0
- package/docs/explanation/faq/planning-faq.md +41 -0
- package/docs/explanation/faq/tools-faq.md +277 -0
- package/docs/explanation/faq/workflows-faq.md +61 -0
- package/docs/explanation/features/advanced-elicitation.md +95 -0
- package/docs/explanation/features/brainstorming-techniques.md +92 -0
- package/docs/explanation/features/party-mode.md +95 -0
- package/docs/explanation/features/quick-flow.md +149 -0
- package/docs/explanation/features/tea-overview.md +410 -0
- package/docs/explanation/features/web-bundles.md +34 -0
- package/docs/explanation/philosophy/facilitation-over-generation.md +333 -0
- package/docs/explanation/philosophy/testing-as-engineering.md +112 -0
- package/docs/explanation/tea/engagement-models.md +710 -0
- package/docs/explanation/tea/fixture-architecture.md +457 -0
- package/docs/explanation/tea/knowledge-base-system.md +554 -0
- package/docs/explanation/tea/network-first-patterns.md +853 -0
- package/docs/explanation/tea/risk-based-testing.md +586 -0
- package/docs/explanation/tea/test-quality-standards.md +907 -0
- package/docs/how-to/brownfield/add-feature-to-existing.md +74 -0
- package/docs/how-to/brownfield/document-existing-project.md +66 -0
- package/docs/how-to/brownfield/index.md +84 -0
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +77 -0
- package/docs/how-to/brownfield/use-tea-for-enterprise.md +526 -0
- package/docs/how-to/brownfield/use-tea-with-existing-tests.md +577 -0
- package/docs/how-to/customization/customize-agents.md +212 -0
- package/docs/how-to/customization/enable-tea-mcp-enhancements.md +424 -0
- package/docs/how-to/customization/index.md +23 -0
- package/docs/how-to/customization/integrate-playwright-utils.md +813 -0
- package/docs/how-to/customization/shard-large-documents.md +101 -0
- package/docs/how-to/get-answers-about-bmad.md +102 -0
- package/docs/how-to/installation/index.md +12 -0
- package/docs/how-to/installation/install-bmad.md +111 -0
- package/docs/how-to/installation/install-custom-modules.md +118 -0
- package/docs/how-to/installation/upgrade-to-v6.md +131 -0
- package/docs/how-to/workflows/bmgd-quick-flow.md +156 -0
- package/docs/how-to/workflows/conduct-research.md +97 -0
- package/docs/how-to/workflows/create-architecture.md +119 -0
- package/docs/how-to/workflows/create-epics-and-stories.md +109 -0
- package/docs/how-to/workflows/create-prd.md +91 -0
- package/docs/how-to/workflows/create-product-brief.md +94 -0
- package/docs/how-to/workflows/create-story.md +102 -0
- package/docs/how-to/workflows/create-ux-design.md +100 -0
- package/docs/how-to/workflows/implement-story.md +97 -0
- package/docs/how-to/workflows/quick-spec.md +122 -0
- package/docs/how-to/workflows/run-atdd.md +436 -0
- package/docs/how-to/workflows/run-automate.md +653 -0
- package/docs/how-to/workflows/run-brainstorming-session.md +73 -0
- package/docs/how-to/workflows/run-code-review.md +89 -0
- package/docs/how-to/workflows/run-implementation-readiness.md +125 -0
- package/docs/how-to/workflows/run-nfr-assess.md +679 -0
- package/docs/how-to/workflows/run-sprint-planning.md +94 -0
- package/docs/how-to/workflows/run-test-design.md +98 -0
- package/docs/how-to/workflows/run-test-review.md +605 -0
- package/docs/how-to/workflows/run-trace.md +883 -0
- package/docs/how-to/workflows/setup-ci.md +712 -0
- package/docs/how-to/workflows/setup-party-mode.md +89 -0
- package/docs/how-to/workflows/setup-test-framework.md +98 -0
- package/docs/index.md +63 -0
- package/docs/migration-guide.md +365 -0
- package/docs/multi-scope-guide.md +379 -0
- package/docs/plans/multi-scope-parallel-artifacts-plan.md +695 -0
- package/docs/reference/agents/index.md +109 -0
- package/docs/reference/configuration/core-tasks.md +67 -0
- package/docs/reference/configuration/global-config.md +28 -0
- package/docs/reference/glossary/index.md +159 -0
- package/docs/reference/tea/commands.md +254 -0
- package/docs/reference/tea/configuration.md +678 -0
- package/docs/reference/tea/knowledge-base.md +340 -0
- package/docs/reference/workflows/core-workflows.md +32 -0
- package/docs/reference/workflows/document-project.md +73 -0
- package/docs/reference/workflows/index.md +12 -0
- package/docs/tutorials/getting-started/getting-started-bmadv6.md +246 -0
- package/docs/tutorials/getting-started/images/workflow-method-greenfield.excalidraw +5034 -0
- package/docs/tutorials/getting-started/images/workflow-method-greenfield.svg +4 -0
- package/docs/tutorials/getting-started/images/workflow-overview.jpg +0 -0
- package/docs/tutorials/getting-started/tea-lite-quickstart.md +444 -0
- package/docs/tutorials/getting-started/workflow-overview.jpg +0 -0
- package/eslint.config.mjs +152 -0
- package/package.json +117 -0
- package/prettier.config.mjs +32 -0
- package/src/bmm/_module-installer/installer.js +48 -0
- package/src/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
- package/src/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
- package/src/bmm/agents/analyst.agent.yaml +41 -0
- package/src/bmm/agents/architect.agent.yaml +33 -0
- package/src/bmm/agents/dev.agent.yaml +38 -0
- package/src/bmm/agents/pm.agent.yaml +51 -0
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
- package/src/bmm/agents/sm.agent.yaml +47 -0
- package/src/bmm/agents/tea.agent.yaml +68 -0
- package/src/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +224 -0
- package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +49 -0
- package/src/bmm/agents/ux-designer.agent.yaml +30 -0
- package/src/bmm/data/README.md +29 -0
- package/src/bmm/data/project-context-template.md +40 -0
- package/src/bmm/module.yaml +64 -0
- package/src/bmm/sub-modules/claude-code/config.yaml +4 -0
- package/src/bmm/sub-modules/claude-code/injections.yaml +242 -0
- package/src/bmm/sub-modules/claude-code/readme.md +87 -0
- package/src/bmm/teams/default-party.csv +21 -0
- package/src/bmm/teams/team-fullstack.yaml +12 -0
- package/src/bmm/testarch/knowledge/api-request.md +442 -0
- package/src/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
- package/src/bmm/testarch/knowledge/auth-session.md +552 -0
- package/src/bmm/testarch/knowledge/burn-in.md +273 -0
- package/src/bmm/testarch/knowledge/ci-burn-in.md +675 -0
- package/src/bmm/testarch/knowledge/component-tdd.md +486 -0
- package/src/bmm/testarch/knowledge/contract-testing.md +957 -0
- package/src/bmm/testarch/knowledge/data-factories.md +500 -0
- package/src/bmm/testarch/knowledge/email-auth.md +721 -0
- package/src/bmm/testarch/knowledge/error-handling.md +725 -0
- package/src/bmm/testarch/knowledge/feature-flags.md +750 -0
- package/src/bmm/testarch/knowledge/file-utils.md +463 -0
- package/src/bmm/testarch/knowledge/fixture-architecture.md +401 -0
- package/src/bmm/testarch/knowledge/fixtures-composition.md +382 -0
- package/src/bmm/testarch/knowledge/intercept-network-call.md +430 -0
- package/src/bmm/testarch/knowledge/log.md +429 -0
- package/src/bmm/testarch/knowledge/network-error-monitor.md +405 -0
- package/src/bmm/testarch/knowledge/network-first.md +486 -0
- package/src/bmm/testarch/knowledge/network-recorder.md +527 -0
- package/src/bmm/testarch/knowledge/nfr-criteria.md +670 -0
- package/src/bmm/testarch/knowledge/overview.md +286 -0
- package/src/bmm/testarch/knowledge/playwright-config.md +730 -0
- package/src/bmm/testarch/knowledge/probability-impact.md +601 -0
- package/src/bmm/testarch/knowledge/recurse.md +421 -0
- package/src/bmm/testarch/knowledge/risk-governance.md +615 -0
- package/src/bmm/testarch/knowledge/selective-testing.md +732 -0
- package/src/bmm/testarch/knowledge/selector-resilience.md +527 -0
- package/src/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
- package/src/bmm/testarch/knowledge/test-levels-framework.md +473 -0
- package/src/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/src/bmm/testarch/knowledge/test-quality.md +664 -0
- package/src/bmm/testarch/knowledge/timing-debugging.md +372 -0
- package/src/bmm/testarch/knowledge/visual-debugging.md +524 -0
- package/src/bmm/testarch/tea-index.csv +34 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +194 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -0
- package/src/bmm/workflows/1-analysis/research/research.template.md +29 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -0
- package/src/bmm/workflows/1-analysis/research/workflow.md +173 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv +13 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/project-types.csv +11 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md +153 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +180 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +232 -0
- package/src/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md +10 -0
- package/src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
- package/src/bmm/workflows/2-plan-workflows/prd/workflow.md +150 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +11 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +50 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -0
- package/src/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
- package/src/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
- package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +51 -0
- package/src/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
- package/src/bmm/workflows/4-implementation/correct-course/instructions.md +206 -0
- package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +60 -0
- package/src/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
- package/src/bmm/workflows/4-implementation/create-story/instructions.xml +345 -0
- package/src/bmm/workflows/4-implementation/create-story/template.md +49 -0
- package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +61 -0
- package/src/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
- package/src/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
- package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +27 -0
- package/src/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -0
- package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +58 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +54 -0
- package/src/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -0
- package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +36 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +191 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
- package/src/bmm/workflows/document-project/checklist.md +245 -0
- package/src/bmm/workflows/document-project/documentation-requirements.csv +12 -0
- package/src/bmm/workflows/document-project/instructions.md +221 -0
- package/src/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
- package/src/bmm/workflows/document-project/templates/index-template.md +169 -0
- package/src/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
- package/src/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/src/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
- package/src/bmm/workflows/document-project/workflow.yaml +30 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
- package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
- package/src/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
- package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -0
- package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +27 -0
- package/src/bmm/workflows/generate-project-context/project-context-template.md +21 -0
- package/src/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
- package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
- package/src/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
- package/src/bmm/workflows/generate-project-context/workflow.md +49 -0
- package/src/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -0
- package/src/bmm/workflows/testarch/atdd/checklist.md +374 -0
- package/src/bmm/workflows/testarch/atdd/instructions.md +806 -0
- package/src/bmm/workflows/testarch/atdd/workflow.yaml +47 -0
- package/src/bmm/workflows/testarch/automate/checklist.md +582 -0
- package/src/bmm/workflows/testarch/automate/instructions.md +1324 -0
- package/src/bmm/workflows/testarch/automate/workflow.yaml +54 -0
- package/src/bmm/workflows/testarch/ci/checklist.md +248 -0
- package/src/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -0
- package/src/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -0
- package/src/bmm/workflows/testarch/ci/instructions.md +536 -0
- package/src/bmm/workflows/testarch/ci/workflow.yaml +47 -0
- package/src/bmm/workflows/testarch/framework/checklist.md +321 -0
- package/src/bmm/workflows/testarch/framework/instructions.md +481 -0
- package/src/bmm/workflows/testarch/framework/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/nfr-assess/checklist.md +407 -0
- package/src/bmm/workflows/testarch/nfr-assess/instructions.md +722 -0
- package/src/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -0
- package/src/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/test-design/checklist.md +235 -0
- package/src/bmm/workflows/testarch/test-design/instructions.md +788 -0
- package/src/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
- package/src/bmm/workflows/testarch/test-design/workflow.yaml +56 -0
- package/src/bmm/workflows/testarch/test-review/checklist.md +472 -0
- package/src/bmm/workflows/testarch/test-review/instructions.md +628 -0
- package/src/bmm/workflows/testarch/test-review/test-review-template.md +390 -0
- package/src/bmm/workflows/testarch/test-review/workflow.yaml +48 -0
- package/src/bmm/workflows/testarch/trace/checklist.md +655 -0
- package/src/bmm/workflows/testarch/trace/instructions.md +1047 -0
- package/src/bmm/workflows/testarch/trace/trace-template.md +675 -0
- package/src/bmm/workflows/testarch/trace/workflow.yaml +57 -0
- package/src/bmm/workflows/workflow-status/init/instructions.md +346 -0
- package/src/bmm/workflows/workflow-status/init/workflow.yaml +30 -0
- package/src/bmm/workflows/workflow-status/instructions.md +397 -0
- package/src/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -0
- package/src/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -0
- package/src/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -0
- package/src/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -0
- package/src/bmm/workflows/workflow-status/project-levels.yaml +59 -0
- package/src/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -0
- package/src/bmm/workflows/workflow-status/workflow.yaml +32 -0
- package/src/core/_module-installer/installer.js +60 -0
- package/src/core/agents/bmad-master.agent.yaml +30 -0
- package/src/core/lib/scope/artifact-resolver.js +298 -0
- package/src/core/lib/scope/event-logger.js +411 -0
- package/src/core/lib/scope/index.js +30 -0
- package/src/core/lib/scope/scope-context.js +307 -0
- package/src/core/lib/scope/scope-initializer.js +458 -0
- package/src/core/lib/scope/scope-manager.js +512 -0
- package/src/core/lib/scope/scope-migrator.js +442 -0
- package/src/core/lib/scope/scope-sync.js +489 -0
- package/src/core/lib/scope/scope-validator.js +299 -0
- package/src/core/lib/scope/state-lock.js +342 -0
- package/src/core/module.yaml +53 -0
- package/src/core/resources/excalidraw/README.md +160 -0
- package/src/core/resources/excalidraw/excalidraw-helpers.md +127 -0
- package/src/core/resources/excalidraw/library-loader.md +50 -0
- package/src/core/resources/excalidraw/validate-json-instructions.md +79 -0
- package/src/core/tasks/editorial-review-prose.xml +91 -0
- package/src/core/tasks/editorial-review-structure.xml +198 -0
- package/src/core/tasks/index-docs.xml +65 -0
- package/src/core/tasks/review-adversarial-general.xml +46 -0
- package/src/core/tasks/shard-doc.xml +109 -0
- package/src/core/tasks/workflow.xml +277 -0
- package/src/core/workflows/advanced-elicitation/methods.csv +51 -0
- package/src/core/workflows/advanced-elicitation/workflow.xml +117 -0
- package/src/core/workflows/brainstorming/brain-methods.csv +62 -0
- package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
- package/src/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
- package/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
- package/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
- package/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
- package/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
- package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
- package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
- package/src/core/workflows/brainstorming/template.md +15 -0
- package/src/core/workflows/brainstorming/workflow.md +58 -0
- package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -0
- package/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -0
- package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +157 -0
- package/src/core/workflows/party-mode/workflow.md +194 -0
- package/src/utility/agent-components/activation-rules.txt +6 -0
- package/src/utility/agent-components/activation-steps.txt +28 -0
- package/src/utility/agent-components/agent-command-header.md +1 -0
- package/src/utility/agent-components/agent.customize.template.yaml +41 -0
- package/src/utility/agent-components/handler-action.txt +4 -0
- package/src/utility/agent-components/handler-data.txt +5 -0
- package/src/utility/agent-components/handler-exec.txt +19 -0
- package/src/utility/agent-components/handler-multi.txt +14 -0
- package/src/utility/agent-components/handler-tmpl.txt +5 -0
- package/src/utility/agent-components/handler-validate-workflow.txt +7 -0
- package/src/utility/agent-components/handler-workflow.txt +10 -0
- package/src/utility/agent-components/menu-handlers.txt +6 -0
- package/test/README.md +295 -0
- package/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +30 -0
- package/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +22 -0
- package/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +20 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +31 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/metadata/empty-module-string.agent.yaml +26 -0
- package/test/fixtures/agent-schema/invalid/metadata/empty-name.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/metadata/missing-id.agent.yaml +23 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +29 -0
- package/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +31 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/top-level/empty-file.agent.yaml +5 -0
- package/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/top-level/missing-agent-key.agent.yaml +11 -0
- package/test/fixtures/agent-schema/invalid/yaml-errors/invalid-indentation.agent.yaml +19 -0
- package/test/fixtures/agent-schema/invalid/yaml-errors/malformed-yaml.agent.yaml +18 -0
- package/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +27 -0
- package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +31 -0
- package/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +38 -0
- package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +31 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +34 -0
- package/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml +23 -0
- package/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +28 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +30 -0
- package/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +24 -0
- package/test/test-agent-schema.js +387 -0
- package/test/test-cli-integration.sh +159 -0
- package/test/test-installation-components.js +214 -0
- package/test/test-scope-e2e.js +450 -0
- package/test/test-scope-system.js +787 -0
- package/test/unit-test-schema.js +133 -0
- package/tools/bmad-npx-wrapper.js +38 -0
- package/tools/build-docs.js +577 -0
- package/tools/cli/README.md +7 -0
- package/tools/cli/bmad-cli.js +58 -0
- package/tools/cli/commands/install.js +87 -0
- package/tools/cli/commands/scope.js +474 -0
- package/tools/cli/external-official-modules.yaml +41 -0
- package/tools/cli/installers/install-messages.yaml +58 -0
- package/tools/cli/installers/lib/core/config-collector.js +1079 -0
- package/tools/cli/installers/lib/core/custom-module-cache.js +259 -0
- package/tools/cli/installers/lib/core/dependency-resolver.js +739 -0
- package/tools/cli/installers/lib/core/detector.js +223 -0
- package/tools/cli/installers/lib/core/ide-config-manager.js +156 -0
- package/tools/cli/installers/lib/core/installer.js +2585 -0
- package/tools/cli/installers/lib/core/manifest-generator.js +963 -0
- package/tools/cli/installers/lib/core/manifest.js +590 -0
- package/tools/cli/installers/lib/custom/handler.js +363 -0
- package/tools/cli/installers/lib/ide/_base-ide.js +654 -0
- package/tools/cli/installers/lib/ide/antigravity.js +486 -0
- package/tools/cli/installers/lib/ide/auggie.js +244 -0
- package/tools/cli/installers/lib/ide/claude-code.js +487 -0
- package/tools/cli/installers/lib/ide/cline.js +269 -0
- package/tools/cli/installers/lib/ide/codex.js +375 -0
- package/tools/cli/installers/lib/ide/crush.js +300 -0
- package/tools/cli/installers/lib/ide/cursor.js +169 -0
- package/tools/cli/installers/lib/ide/gemini.js +301 -0
- package/tools/cli/installers/lib/ide/github-copilot.js +383 -0
- package/tools/cli/installers/lib/ide/iflow.js +191 -0
- package/tools/cli/installers/lib/ide/kilo.js +250 -0
- package/tools/cli/installers/lib/ide/kiro-cli.js +326 -0
- package/tools/cli/installers/lib/ide/manager.js +244 -0
- package/tools/cli/installers/lib/ide/opencode.js +257 -0
- package/tools/cli/installers/lib/ide/qwen.js +372 -0
- package/tools/cli/installers/lib/ide/roo.js +270 -0
- package/tools/cli/installers/lib/ide/rovo-dev.js +290 -0
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +96 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +158 -0
- package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +119 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +242 -0
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +29 -0
- package/tools/cli/installers/lib/ide/templates/gemini-agent-command.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/gemini-task-command.toml +12 -0
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +30 -0
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +45 -0
- package/tools/cli/installers/lib/ide/trae.js +313 -0
- package/tools/cli/installers/lib/ide/windsurf.js +258 -0
- package/tools/cli/installers/lib/message-loader.js +85 -0
- package/tools/cli/installers/lib/modules/external-manager.js +133 -0
- package/tools/cli/installers/lib/modules/manager.js +1362 -0
- package/tools/cli/lib/activation-builder.js +163 -0
- package/tools/cli/lib/agent/compiler.js +522 -0
- package/tools/cli/lib/agent/installer.js +716 -0
- package/tools/cli/lib/agent/template-engine.js +152 -0
- package/tools/cli/lib/agent-analyzer.js +109 -0
- package/tools/cli/lib/agent-party-generator.js +194 -0
- package/tools/cli/lib/cli-utils.js +227 -0
- package/tools/cli/lib/config.js +213 -0
- package/tools/cli/lib/file-ops.js +204 -0
- package/tools/cli/lib/platform-codes.js +116 -0
- package/tools/cli/lib/project-root.js +77 -0
- package/tools/cli/lib/prompts.js +433 -0
- package/tools/cli/lib/ui.js +1591 -0
- package/tools/cli/lib/xml-handler.js +177 -0
- package/tools/cli/lib/xml-to-markdown.js +82 -0
- package/tools/cli/lib/yaml-format.js +245 -0
- package/tools/cli/lib/yaml-xml-builder.js +587 -0
- package/tools/cli/scripts/migrate-workflows.js +281 -0
- package/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md +95 -0
- package/tools/docs/index.md +2 -0
- package/tools/fix-doc-links.js +288 -0
- package/tools/flattener/aggregate.js +76 -0
- package/tools/flattener/binary.js +80 -0
- package/tools/flattener/discovery.js +71 -0
- package/tools/flattener/files.js +35 -0
- package/tools/flattener/ignoreRules.js +172 -0
- package/tools/flattener/main.js +483 -0
- package/tools/flattener/projectRoot.js +201 -0
- package/tools/flattener/prompts.js +44 -0
- package/tools/flattener/stats.helpers.js +368 -0
- package/tools/flattener/stats.js +75 -0
- package/tools/flattener/test-matrix.js +409 -0
- package/tools/flattener/xml.js +82 -0
- package/tools/format-workflow-md.js +263 -0
- package/tools/lib/xml-utils.js +13 -0
- 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/tools/platform-codes.yaml +157 -0
- package/tools/schema/agent.js +493 -0
- package/tools/validate-agent-schema.js +110 -0
- package/tools/validate-doc-links.js +363 -0
- package/tools/validate-svg-changes.sh +356 -0
- package/website/README.md +76 -0
- package/website/astro.config.mjs +228 -0
- package/website/public/favicon.ico +0 -0
- package/website/public/img/bmad-dark.png +0 -0
- package/website/public/img/bmad-light.png +0 -0
- package/website/public/img/logo.svg +4 -0
- package/website/public/robots.txt +37 -0
- package/website/src/components/Banner.astro +59 -0
- package/website/src/components/Header.astro +121 -0
- package/website/src/components/MobileMenuFooter.astro +53 -0
- package/website/src/content/config.ts +6 -0
- package/website/src/lib/site-url.js +25 -0
- package/website/src/rehype-markdown-links.js +102 -0
- package/website/src/styles/custom.css +485 -0
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Why Solutioning Matters"
|
|
3
|
+
description: Understanding why the solutioning phase is critical for multi-epic projects
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
|
8
|
+
|
|
9
|
+
## The Problem Without Solutioning
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
Agent 1 implements Epic 1 using REST API
|
|
13
|
+
Agent 2 implements Epic 2 using GraphQL
|
|
14
|
+
Result: Inconsistent API design, integration nightmare
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
|
|
18
|
+
|
|
19
|
+
## The Solution With Solutioning
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
architecture workflow decides: "Use GraphQL for all APIs"
|
|
23
|
+
All agents follow architecture decisions
|
|
24
|
+
Result: Consistent implementation, no conflicts
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
|
|
28
|
+
|
|
29
|
+
## Solutioning vs Planning
|
|
30
|
+
|
|
31
|
+
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
|
32
|
+
| -------- | ----------------------- | --------------------------------- |
|
|
33
|
+
| Question | What and Why? | How? Then What units of work? |
|
|
34
|
+
| Output | FRs/NFRs (Requirements) | Architecture + Epics/Stories |
|
|
35
|
+
| Agent | PM | Architect → PM |
|
|
36
|
+
| Audience | Stakeholders | Developers |
|
|
37
|
+
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
|
38
|
+
| Level | Business logic | Technical design + Work breakdown |
|
|
39
|
+
|
|
40
|
+
## Key Principle
|
|
41
|
+
|
|
42
|
+
**Make technical decisions explicit and documented** so all agents implement consistently.
|
|
43
|
+
|
|
44
|
+
This prevents:
|
|
45
|
+
- API style conflicts (REST vs GraphQL)
|
|
46
|
+
- Database design inconsistencies
|
|
47
|
+
- State management disagreements
|
|
48
|
+
- Naming convention mismatches
|
|
49
|
+
- Security approach variations
|
|
50
|
+
|
|
51
|
+
## When Solutioning is Required
|
|
52
|
+
|
|
53
|
+
| Track | Solutioning Required? |
|
|
54
|
+
|-------|----------------------|
|
|
55
|
+
| Quick Flow | No - skip entirely |
|
|
56
|
+
| BMad Method Simple | Optional |
|
|
57
|
+
| BMad Method Complex | Yes |
|
|
58
|
+
| Enterprise | Yes |
|
|
59
|
+
|
|
60
|
+
:::tip[Rule of Thumb]
|
|
61
|
+
If you have multiple epics that could be implemented by different agents, you need solutioning.
|
|
62
|
+
:::
|
|
63
|
+
|
|
64
|
+
## The Cost of Skipping
|
|
65
|
+
|
|
66
|
+
Skipping solutioning on complex projects leads to:
|
|
67
|
+
|
|
68
|
+
- **Integration issues** discovered mid-sprint
|
|
69
|
+
- **Rework** due to conflicting implementations
|
|
70
|
+
- **Longer development time** overall
|
|
71
|
+
- **Technical debt** from inconsistent patterns
|
|
72
|
+
|
|
73
|
+
:::caution[Cost Multiplier]
|
|
74
|
+
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
|
|
75
|
+
:::
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "BMM Documentation"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Complete guides for the BMad Method Module (BMM) — AI-powered agile development workflows that adapt to your project's complexity.
|
|
6
|
+
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
:::tip[Quick Path]
|
|
10
|
+
Install → workflow-init → Follow agent guidance
|
|
11
|
+
:::
|
|
12
|
+
|
|
13
|
+
**New to BMM?** Start here:
|
|
14
|
+
|
|
15
|
+
| Resource | Description |
|
|
16
|
+
|----------|-------------|
|
|
17
|
+
| **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** | Step-by-step guide to building your first project |
|
|
18
|
+
| **[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** | Visual flowchart showing all phases, agents, and decision points |
|
|
19
|
+
|
|
20
|
+
## Core Concepts
|
|
21
|
+
|
|
22
|
+
The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).
|
|
23
|
+
|
|
24
|
+
First know there is the full BMad Method Process and then there is a Quick Flow for those quicker smaller efforts.
|
|
25
|
+
|
|
26
|
+
- **[Full Adaptive BMad Method](#workflow-guides)** - Full planning and scope support through extensive development and testing.
|
|
27
|
+
- Broken down into 4 phases, all of which are comprised of both required and optional phases
|
|
28
|
+
- Phases 1-3 are all about progressive idea development through planning and preparations to build your project.
|
|
29
|
+
- Phase 4 is the implementation cycle where you will Just In Time (JIT) produce the contextual stories needed for the dev agent based on the extensive planning completed
|
|
30
|
+
- All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability.
|
|
31
|
+
- While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next
|
|
32
|
+
|
|
33
|
+
- **[BMad Quick Flow](/docs/explanation/features/quick-flow.md)** - Fast-track development workflow
|
|
34
|
+
- 3-step process: spec → dev → optional review
|
|
35
|
+
- Perfect for bug fixes and small features
|
|
36
|
+
- Rapid prototyping with production quality
|
|
37
|
+
- Implementation in minutes, not days
|
|
38
|
+
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](/docs/explanation/agents/barry-quick-flow.md)**
|
|
39
|
+
|
|
40
|
+
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**.
|
|
41
|
+
|
|
42
|
+
## Agents and Collaboration
|
|
43
|
+
|
|
44
|
+
Complete guide to BMM's AI agent team:
|
|
45
|
+
|
|
46
|
+
- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference
|
|
47
|
+
- 12 specialized BMM agents + BMad Master
|
|
48
|
+
- Agent roles, workflows, and when to use them
|
|
49
|
+
- Agent customization system
|
|
50
|
+
- Best practices and common patterns
|
|
51
|
+
|
|
52
|
+
- **[Party Mode Guide](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
|
|
53
|
+
- How party mode works (19+ agents collaborate in real-time)
|
|
54
|
+
- When to use it (strategic, creative, cross-functional, complex)
|
|
55
|
+
- Example party compositions
|
|
56
|
+
- Multi-module integration (BMM + CIS + BMB + custom)
|
|
57
|
+
- Agent customization in party mode
|
|
58
|
+
- Best practices
|
|
59
|
+
|
|
60
|
+
## Working with Existing Code
|
|
61
|
+
|
|
62
|
+
Comprehensive guide for brownfield development:
|
|
63
|
+
|
|
64
|
+
- **[Brownfield Development Guide](/docs/how-to/brownfield/index.md)** - Complete guide for existing codebases
|
|
65
|
+
- Documentation phase strategies
|
|
66
|
+
- Track selection for brownfield
|
|
67
|
+
- Integration with existing patterns
|
|
68
|
+
- Phase-by-phase workflow guidance
|
|
69
|
+
- Common scenarios
|
|
70
|
+
|
|
71
|
+
## Quick References
|
|
72
|
+
|
|
73
|
+
Essential reference materials:
|
|
74
|
+
|
|
75
|
+
- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts
|
|
76
|
+
- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics
|
|
77
|
+
|
|
78
|
+
## Choose Your Path
|
|
79
|
+
|
|
80
|
+
### I need to...
|
|
81
|
+
|
|
82
|
+
**Build something new (greenfield)**
|
|
83
|
+
→ Start with [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
84
|
+
|
|
85
|
+
**Fix a bug or add small feature**
|
|
86
|
+
→ Use the [Quick Flow Solo Dev](/docs/explanation/agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](/docs/explanation/features/quick-flow.md) process
|
|
87
|
+
|
|
88
|
+
**Work with existing codebase (brownfield)**
|
|
89
|
+
→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
|
|
90
|
+
→ Pay special attention to documentation requirements for brownfield projects
|
|
91
|
+
|
|
92
|
+
## Workflow Guides
|
|
93
|
+
|
|
94
|
+
Comprehensive documentation for all BMM workflows organized by phase:
|
|
95
|
+
|
|
96
|
+
- **[Phase 1: Analysis Workflows](/docs/how-to/workflows/run-brainstorming-session.md)** - Optional exploration and research workflows (595 lines)
|
|
97
|
+
- brainstorm-project, product-brief, research, and more
|
|
98
|
+
- When to use analysis workflows
|
|
99
|
+
- Creative and strategic tools
|
|
100
|
+
|
|
101
|
+
- **[Phase 2: Planning Workflows](/docs/how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines)
|
|
102
|
+
- prd, tech-spec, gdd, narrative, ux
|
|
103
|
+
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
|
|
104
|
+
- Which planning workflow to use
|
|
105
|
+
|
|
106
|
+
- **[Phase 3: Solutioning Workflows](/docs/how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines)
|
|
107
|
+
- architecture, create-epics-and-stories, implementation-readiness
|
|
108
|
+
- V6: Epics created AFTER architecture for better quality
|
|
109
|
+
- Required for BMad Method and Enterprise Method tracks
|
|
110
|
+
- Preventing agent conflicts
|
|
111
|
+
|
|
112
|
+
- **[Phase 4: Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines)
|
|
113
|
+
- sprint-planning, create-story, dev-story, code-review
|
|
114
|
+
- Complete story lifecycle
|
|
115
|
+
- One-story-at-a-time discipline
|
|
116
|
+
|
|
117
|
+
- **[Testing & QA Workflows](/docs/explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines)
|
|
118
|
+
- Test strategy, automation, quality gates
|
|
119
|
+
- TEA agent and test healing
|
|
120
|
+
|
|
121
|
+
## External Resources
|
|
122
|
+
|
|
123
|
+
### Community and Support
|
|
124
|
+
|
|
125
|
+
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#bmad-method-help, #report-bugs-and-issues)
|
|
126
|
+
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
|
127
|
+
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
|
128
|
+
|
|
129
|
+
:::tip[Ready to Begin?]
|
|
130
|
+
[Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
|
|
131
|
+
:::
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Core Module"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
The Core Module is installed with all installations of BMad modules and provides common functionality that any module, workflow, or agent can take advantage of.
|
|
7
|
+
|
|
8
|
+
## Core Module Components
|
|
9
|
+
|
|
10
|
+
- **[Global Core Config](/docs/reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content
|
|
11
|
+
- **[Core Workflows](/docs/reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module
|
|
12
|
+
- [Party Mode](/docs/explanation/features/party-mode.md) — Multi-agent conversation orchestration
|
|
13
|
+
- [Brainstorming](/docs/explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques
|
|
14
|
+
- [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
|
15
|
+
- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules
|
|
16
|
+
- [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files
|
|
17
|
+
- [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review) — Critical content review
|
|
18
|
+
- [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Agent Roles in BMad Method"
|
|
3
|
+
description: Understanding the different agent roles in BMad Method
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task.
|
|
7
|
+
|
|
8
|
+
## Core Agents Overview
|
|
9
|
+
|
|
10
|
+
| Agent | Role | Primary Phase |
|
|
11
|
+
|-------|------|---------------|
|
|
12
|
+
| **Analyst** | Research and discovery | Phase 1 (Analysis) |
|
|
13
|
+
| **PM** | Requirements and planning | Phase 2 (Planning) |
|
|
14
|
+
| **Architect** | Technical design | Phase 3 (Solutioning) |
|
|
15
|
+
| **SM** | Sprint orchestration | Phase 4 (Implementation) |
|
|
16
|
+
| **DEV** | Code implementation | Phase 4 (Implementation) |
|
|
17
|
+
| **TEA** | Test architecture | Phases 3-4 (Cross-phase) |
|
|
18
|
+
| **UX Designer** | User experience | Phase 2-3 |
|
|
19
|
+
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
|
|
20
|
+
|
|
21
|
+
## Phase 1: Analysis
|
|
22
|
+
|
|
23
|
+
### Analyst (Mary)
|
|
24
|
+
|
|
25
|
+
Business analysis and research specialist.
|
|
26
|
+
|
|
27
|
+
**Responsibilities:**
|
|
28
|
+
- Brainstorming and ideation
|
|
29
|
+
- Market, domain, and competitive research
|
|
30
|
+
- Product brief creation
|
|
31
|
+
- Brownfield project documentation
|
|
32
|
+
|
|
33
|
+
**Key Workflows:**
|
|
34
|
+
- `*brainstorm-project`
|
|
35
|
+
- `*research`
|
|
36
|
+
- `*product-brief`
|
|
37
|
+
- `*document-project`
|
|
38
|
+
|
|
39
|
+
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
|
|
40
|
+
|
|
41
|
+
## Phase 2: Planning
|
|
42
|
+
|
|
43
|
+
### PM (John)
|
|
44
|
+
|
|
45
|
+
Product requirements and planning expert.
|
|
46
|
+
|
|
47
|
+
**Responsibilities:**
|
|
48
|
+
- Creating Product Requirements Documents
|
|
49
|
+
- Defining functional and non-functional requirements
|
|
50
|
+
- Breaking requirements into epics and stories
|
|
51
|
+
- Validating implementation readiness
|
|
52
|
+
|
|
53
|
+
**Key Workflows:**
|
|
54
|
+
- `*create-prd`
|
|
55
|
+
- `*create-epics-and-stories`
|
|
56
|
+
- `*implementation-readiness`
|
|
57
|
+
|
|
58
|
+
**When to use:** Defining what to build, creating PRDs, organizing work into stories.
|
|
59
|
+
|
|
60
|
+
### UX Designer (Sally)
|
|
61
|
+
|
|
62
|
+
User experience and UI design specialist.
|
|
63
|
+
|
|
64
|
+
**Responsibilities:**
|
|
65
|
+
- UX specification creation
|
|
66
|
+
- User journey mapping
|
|
67
|
+
- Wireframe and mockup design
|
|
68
|
+
- Design system documentation
|
|
69
|
+
|
|
70
|
+
**Key Workflows:**
|
|
71
|
+
- `*create-ux-design`
|
|
72
|
+
- `*validate-design`
|
|
73
|
+
|
|
74
|
+
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
|
|
75
|
+
|
|
76
|
+
## Phase 3: Solutioning
|
|
77
|
+
|
|
78
|
+
### Architect (Winston)
|
|
79
|
+
|
|
80
|
+
System architecture and technical design expert.
|
|
81
|
+
|
|
82
|
+
**Responsibilities:**
|
|
83
|
+
- System architecture design
|
|
84
|
+
- Architecture Decision Records (ADRs)
|
|
85
|
+
- Technical standards definition
|
|
86
|
+
- Implementation readiness validation
|
|
87
|
+
|
|
88
|
+
**Key Workflows:**
|
|
89
|
+
- `*create-architecture`
|
|
90
|
+
- `*implementation-readiness`
|
|
91
|
+
|
|
92
|
+
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
|
|
93
|
+
|
|
94
|
+
## Phase 4: Implementation
|
|
95
|
+
|
|
96
|
+
### SM (Bob)
|
|
97
|
+
|
|
98
|
+
Sprint planning and story preparation orchestrator.
|
|
99
|
+
|
|
100
|
+
**Responsibilities:**
|
|
101
|
+
- Sprint planning and tracking
|
|
102
|
+
- Story preparation for development
|
|
103
|
+
- Course correction handling
|
|
104
|
+
- Epic retrospectives
|
|
105
|
+
|
|
106
|
+
**Key Workflows:**
|
|
107
|
+
- `*sprint-planning`
|
|
108
|
+
- `*create-story`
|
|
109
|
+
- `*correct-course`
|
|
110
|
+
- `*epic-retrospective`
|
|
111
|
+
|
|
112
|
+
**When to use:** Organizing work, preparing stories, tracking progress.
|
|
113
|
+
|
|
114
|
+
### DEV (Amelia)
|
|
115
|
+
|
|
116
|
+
Story implementation and code review specialist.
|
|
117
|
+
|
|
118
|
+
**Responsibilities:**
|
|
119
|
+
- Story implementation with tests
|
|
120
|
+
- Code review
|
|
121
|
+
- Following architecture patterns
|
|
122
|
+
- Quality assurance
|
|
123
|
+
|
|
124
|
+
**Key Workflows:**
|
|
125
|
+
- `*dev-story`
|
|
126
|
+
- `*code-review`
|
|
127
|
+
|
|
128
|
+
**When to use:** Writing code, implementing stories, reviewing quality.
|
|
129
|
+
|
|
130
|
+
## Cross-Phase Agents
|
|
131
|
+
|
|
132
|
+
### TEA (Murat)
|
|
133
|
+
|
|
134
|
+
Test architecture and quality strategy expert.
|
|
135
|
+
|
|
136
|
+
**Responsibilities:**
|
|
137
|
+
- Test framework setup
|
|
138
|
+
- Test design and planning
|
|
139
|
+
- ATDD and automation
|
|
140
|
+
- Quality gate decisions
|
|
141
|
+
|
|
142
|
+
**Key Workflows:**
|
|
143
|
+
- `*framework`, `*ci`
|
|
144
|
+
- `*test-design`, `*atdd`, `*automate`
|
|
145
|
+
- `*test-review`, `*trace`, `*nfr-assess`
|
|
146
|
+
|
|
147
|
+
**When to use:** Setting up testing, creating test plans, quality gates.
|
|
148
|
+
|
|
149
|
+
## Quick Flow
|
|
150
|
+
|
|
151
|
+
### Quick Flow Solo Dev (Barry)
|
|
152
|
+
|
|
153
|
+
Fast solo development without handoffs.
|
|
154
|
+
|
|
155
|
+
**Responsibilities:**
|
|
156
|
+
- Technical specification
|
|
157
|
+
- End-to-end implementation
|
|
158
|
+
- Code review
|
|
159
|
+
|
|
160
|
+
**Key Workflows:**
|
|
161
|
+
- `*quick-spec`
|
|
162
|
+
- `*quick-dev`
|
|
163
|
+
- `*code-review`
|
|
164
|
+
|
|
165
|
+
**When to use:** Bug fixes, small features, rapid prototyping.
|
|
166
|
+
|
|
167
|
+
## Choosing the Right Agent
|
|
168
|
+
|
|
169
|
+
| Task | Agent |
|
|
170
|
+
|------|-------|
|
|
171
|
+
| Brainstorming ideas | Analyst |
|
|
172
|
+
| Market research | Analyst |
|
|
173
|
+
| Creating PRD | PM |
|
|
174
|
+
| Designing UX | UX Designer |
|
|
175
|
+
| System architecture | Architect |
|
|
176
|
+
| Preparing stories | SM |
|
|
177
|
+
| Writing code | DEV |
|
|
178
|
+
| Setting up tests | TEA |
|
|
179
|
+
| Quick bug fix | Quick Flow Solo Dev |
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "BMad Core Concepts"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Understanding the fundamental building blocks of the BMad Method.
|
|
6
|
+
|
|
7
|
+
## The Essentials
|
|
8
|
+
|
|
9
|
+
| Concept | Description | Guide |
|
|
10
|
+
|---------|-------------|-------|
|
|
11
|
+
| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) |
|
|
12
|
+
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md) |
|
|
13
|
+
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](/docs/explanation/core-concepts/what-are-modules.md) |
|
|
14
|
+
|
|
15
|
+
## Getting Started
|
|
16
|
+
|
|
17
|
+
### New to BMad?
|
|
18
|
+
Start here to understand what BMad is and how it works:
|
|
19
|
+
|
|
20
|
+
1. **[Agents Guide](/docs/explanation/core-concepts/what-are-agents.md)** - Learn about Simple and Expert agents
|
|
21
|
+
2. **[Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md)** - Understand how workflows orchestrate tasks
|
|
22
|
+
3. **[Modules Guide](/docs/explanation/core-concepts/what-are-modules.md)** - See how modules organize functionality
|
|
23
|
+
|
|
24
|
+
### Installing BMad
|
|
25
|
+
|
|
26
|
+
- **[Installation Guide](/docs/how-to/installation/index.md)** - Set up BMad in your project
|
|
27
|
+
- **[Upgrading from v4](/docs/how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions
|
|
28
|
+
|
|
29
|
+
### Configuration
|
|
30
|
+
|
|
31
|
+
- **[BMad Customization](/docs/how-to/customization/index.md)** - Personalize agents and workflows
|
|
32
|
+
|
|
33
|
+
### Advanced
|
|
34
|
+
|
|
35
|
+
- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Agents"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
|
6
|
+
|
|
7
|
+
## Agent Types
|
|
8
|
+
|
|
9
|
+
BMad has two primary agent types, designed for different use cases:
|
|
10
|
+
|
|
11
|
+
### Simple Agents
|
|
12
|
+
|
|
13
|
+
**Self-contained, focused, ready to use.**
|
|
14
|
+
|
|
15
|
+
Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup.
|
|
16
|
+
|
|
17
|
+
**Best for:**
|
|
18
|
+
- Single-purpose assistants (code review, documentation, commit messages)
|
|
19
|
+
- Quick deployment
|
|
20
|
+
- Projects that don't require persistent memory
|
|
21
|
+
- Getting started fast
|
|
22
|
+
|
|
23
|
+
**Example:** A commit message agent that reads your git diff and generates conventional commits.
|
|
24
|
+
|
|
25
|
+
### Expert Agents
|
|
26
|
+
|
|
27
|
+
**Powerful, memory-equipped, domain specialists.**
|
|
28
|
+
|
|
29
|
+
Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks.
|
|
30
|
+
|
|
31
|
+
**Best for:**
|
|
32
|
+
- Domain specialists (security architect, game designer, product manager)
|
|
33
|
+
- Tasks requiring persistent memory
|
|
34
|
+
- Complex workflows with multiple stages
|
|
35
|
+
- Projects that grow over time
|
|
36
|
+
|
|
37
|
+
**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
|
|
38
|
+
|
|
39
|
+
## Key Differences
|
|
40
|
+
|
|
41
|
+
| Feature | Simple | Expert |
|
|
42
|
+
| ---------------- | -------------- | -------------------------- |
|
|
43
|
+
| **Files** | Single file | Agent + sidecar folder |
|
|
44
|
+
| **Memory** | Session only | Persistent across sessions |
|
|
45
|
+
| **Capabilities** | Focused scope | Multi-domain, extensible |
|
|
46
|
+
| **Setup** | Zero config | Sidecar initialization |
|
|
47
|
+
| **Best Use** | Specific tasks | Ongoing projects |
|
|
48
|
+
|
|
49
|
+
## Agent Components
|
|
50
|
+
|
|
51
|
+
All agents share these building blocks:
|
|
52
|
+
|
|
53
|
+
### Persona
|
|
54
|
+
- **Role** - What the agent does (expertise domain)
|
|
55
|
+
- **Identity** - Who the agent is (personality, character)
|
|
56
|
+
- **Communication Style** - How the agent speaks (tone, voice)
|
|
57
|
+
- **Principles** - Why the agent acts (values, decision framework)
|
|
58
|
+
|
|
59
|
+
### Capabilities
|
|
60
|
+
- Skills, tools, and knowledge the agent can apply
|
|
61
|
+
- Mapped to specific menu commands
|
|
62
|
+
|
|
63
|
+
### Menu
|
|
64
|
+
- Interactive command list
|
|
65
|
+
- Triggers, descriptions, and handlers
|
|
66
|
+
- Auto-includes help and exit options
|
|
67
|
+
|
|
68
|
+
### Critical Actions (optional)
|
|
69
|
+
- Instructions that execute before the agent starts
|
|
70
|
+
- Enable autonomous behaviors (e.g., "check git status before changes")
|
|
71
|
+
|
|
72
|
+
## Which Should You Use?
|
|
73
|
+
|
|
74
|
+
:::tip[Quick Decision]
|
|
75
|
+
Choose **Simple** for focused, one-off tasks with no memory needs. Choose **Expert** when you need persistent context and complex workflows.
|
|
76
|
+
:::
|
|
77
|
+
|
|
78
|
+
**Choose Simple when:**
|
|
79
|
+
- You need a task done quickly and reliably
|
|
80
|
+
- The scope is well-defined and won't change much
|
|
81
|
+
- You don't need the agent to remember things between sessions
|
|
82
|
+
|
|
83
|
+
**Choose Expert when:**
|
|
84
|
+
- You're building something complex over time
|
|
85
|
+
- The agent needs to maintain context (project history, decisions)
|
|
86
|
+
- You want the agent to coordinate workflows or other agents
|
|
87
|
+
- Domain expertise requires specialized knowledge bases
|
|
88
|
+
|
|
89
|
+
## Creating Custom Agents
|
|
90
|
+
|
|
91
|
+
BMad provides the **BMad Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/tutorials/create-custom-agent.md) for step-by-step instructions.
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
## Customizing Existing Agents
|
|
96
|
+
|
|
97
|
+
You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Modules"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
|
6
|
+
|
|
7
|
+
## What is a Module?
|
|
8
|
+
|
|
9
|
+
A module is a self-contained package that includes:
|
|
10
|
+
|
|
11
|
+
- **Agents** - Specialized AI assistants
|
|
12
|
+
- **Workflows** - Step-by-step processes
|
|
13
|
+
- **Configuration** - Module-specific settings
|
|
14
|
+
- **Documentation** - Usage guides and reference
|
|
15
|
+
|
|
16
|
+
## Official BMad Method and Builder Modules
|
|
17
|
+
|
|
18
|
+
:::note[Core is Always Installed]
|
|
19
|
+
The Core module is automatically included with every BMad installation. It provides the foundation that other modules build upon.
|
|
20
|
+
:::
|
|
21
|
+
|
|
22
|
+
### Core Module
|
|
23
|
+
Always installed, provides shared functionality:
|
|
24
|
+
- Global configuration
|
|
25
|
+
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
|
|
26
|
+
- Common tasks (document indexing, sharding, review)
|
|
27
|
+
|
|
28
|
+
### BMad Method (BMM)
|
|
29
|
+
Software and game development:
|
|
30
|
+
- Project planning workflows
|
|
31
|
+
- Implementation agents (Dev, PM, QA, Scrum Master)
|
|
32
|
+
- Testing and architecture guidance
|
|
33
|
+
|
|
34
|
+
### BMad Builder (BMB)
|
|
35
|
+
Create custom solutions:
|
|
36
|
+
- Agent creation workflows
|
|
37
|
+
- Workflow authoring tools
|
|
38
|
+
- Module scaffolding
|
|
39
|
+
|
|
40
|
+
## Additional Official BMad Modules
|
|
41
|
+
|
|
42
|
+
These are officially maintained modules by BMad but have their own repo's and docs.
|
|
43
|
+
These give a good idea also of what can be done with the BMad builder and creating your own custom modules.
|
|
44
|
+
|
|
45
|
+
### Creative Intelligence Suite (CIS)
|
|
46
|
+
Innovation and creativity:
|
|
47
|
+
- Creative thinking techniques
|
|
48
|
+
- Innovation strategy workflows
|
|
49
|
+
- Storytelling and ideation
|
|
50
|
+
- [Available Here](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
|
|
51
|
+
|
|
52
|
+
### BMad Game Dev (BMGD)
|
|
53
|
+
Game development specialization:
|
|
54
|
+
- Game design workflows
|
|
55
|
+
- Narrative development
|
|
56
|
+
- Performance testing frameworks
|
|
57
|
+
- [Available Here](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
|
|
58
|
+
|
|
59
|
+
## Module Structure
|
|
60
|
+
|
|
61
|
+
Installed modules follow this structure:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
_bmad/
|
|
65
|
+
├── core/ # Always present
|
|
66
|
+
├── bmm/ # BMad Method (if installed)
|
|
67
|
+
├── bmb/ # BMad Builder (if installed)
|
|
68
|
+
├── cis/ # Creative Intelligence (if installed)
|
|
69
|
+
└── bmgd/ # Game Dev (if installed)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Custom Modules
|
|
73
|
+
|
|
74
|
+
You can create your own modules containing:
|
|
75
|
+
- Custom agents for your domain
|
|
76
|
+
- Organizational workflows
|
|
77
|
+
- Team-specific configurations
|
|
78
|
+
|
|
79
|
+
Custom modules are installed the same way as official modules.
|
|
80
|
+
|
|
81
|
+
## Installing Modules
|
|
82
|
+
|
|
83
|
+
During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
|
|
84
|
+
|
|
85
|
+
See [Installation Guide](/docs/how-to/installation/index.md) for details.
|