mdan-cli 2.5.1 → 2.5.2
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/.augment/code_review_guidelines.yaml +271 -0
- package/.claude/skills/bmad-os-audit-file-refs/SKILL.md +6 -0
- package/.claude/skills/bmad-os-audit-file-refs/prompts/instructions.md +59 -0
- package/.claude/skills/bmad-os-changelog-social/SKILL.md +177 -0
- package/.claude/skills/bmad-os-changelog-social/examples/discord-example.md +53 -0
- package/.claude/skills/bmad-os-changelog-social/examples/linkedin-example.md +49 -0
- package/.claude/skills/bmad-os-changelog-social/examples/twitter-example.md +55 -0
- package/.claude/skills/bmad-os-diataxis-style-fix/SKILL.md +6 -0
- package/.claude/skills/bmad-os-diataxis-style-fix/prompts/instructions.md +229 -0
- package/.claude/skills/bmad-os-draft-changelog/SKILL.md +6 -0
- package/.claude/skills/bmad-os-draft-changelog/prompts/instructions.md +82 -0
- package/.claude/skills/bmad-os-gh-triage/SKILL.md +6 -0
- package/.claude/skills/bmad-os-gh-triage/prompts/agent-prompt.md +60 -0
- package/.claude/skills/bmad-os-gh-triage/prompts/instructions.md +74 -0
- package/.claude/skills/bmad-os-release-module/SKILL.md +6 -0
- package/.claude/skills/bmad-os-release-module/prompts/instructions.md +53 -0
- package/.claude/skills/bmad-os-review-pr/SKILL.md +6 -0
- package/.claude/skills/bmad-os-review-pr/prompts/instructions.md +231 -0
- package/.claude/skills/bmad-os-root-cause-analysis/SKILL.md +12 -0
- package/.claude/skills/bmad-os-root-cause-analysis/prompts/instructions.md +74 -0
- package/.coderabbit.yaml +85 -0
- package/.github/CODE_OF_CONDUCT.md +128 -0
- package/.github/FUNDING.yaml +15 -0
- package/.github/ISSUE_TEMPLATE/bug-report.yaml +124 -0
- package/.github/ISSUE_TEMPLATE/config.yaml +8 -0
- package/.github/ISSUE_TEMPLATE/documentation.yaml +55 -0
- package/.github/ISSUE_TEMPLATE/feature-request.md +22 -0
- package/.github/ISSUE_TEMPLATE/issue.md +32 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +13 -0
- package/.github/scripts/discord-helpers.sh +34 -0
- package/.github/workflows/coderabbit-review.yaml +22 -0
- package/.github/workflows/discord.yaml +90 -0
- package/.github/workflows/docs.yaml +64 -0
- package/.github/workflows/quality.yaml +116 -0
- package/.husky/pre-commit +20 -0
- package/.markdownlint-cli2.yaml +41 -0
- package/.nvmrc +1 -0
- package/.prettierignore +12 -0
- package/.vscode/settings.json +96 -0
- package/AGENTS.md +227 -165
- package/AGENTS_LIST.md +946 -0
- package/ARCHITECTURE.md +590 -0
- package/CHANGELOG.md +1770 -0
- package/CNAME +1 -0
- package/CONTRIBUTING.md +512 -0
- package/CONTRIBUTORS.md +32 -0
- package/INSTALL.md +246 -0
- package/LICENSE +30 -0
- package/README.md +133 -194
- package/RELEASE_NOTES.md +246 -0
- package/SECURITY.md +85 -0
- package/TRADEMARK.md +55 -0
- package/USAGE.md +368 -0
- package/Wordmark.png +0 -0
- package/app/__init__.py +5 -0
- package/app/cis/agents/__init__.py +31 -0
- package/app/cis/agents/brainstorming-coach/__init__.py +3 -0
- package/app/cis/agents/brainstorming-coach/agent.py +162 -0
- package/app/cis/agents/brainstorming-coach/prompt.yaml +53 -0
- package/app/cis/agents/creative-problem-solver/__init__.py +3 -0
- package/app/cis/agents/creative-problem-solver/agent.py +233 -0
- package/app/cis/agents/creative-problem-solver/prompt.yaml +74 -0
- package/app/cis/agents/design-thinking-coach/__init__.py +3 -0
- package/app/cis/agents/design-thinking-coach/agent.py +241 -0
- package/app/cis/agents/design-thinking-coach/prompt.yaml +77 -0
- package/app/cis/agents/innovation-strategist/__init__.py +3 -0
- package/app/cis/agents/innovation-strategist/agent.py +271 -0
- package/app/cis/agents/innovation-strategist/prompt.yaml +70 -0
- package/app/cis/agents/presentation-master/__init__.py +3 -0
- package/app/cis/agents/presentation-master/agent.py +420 -0
- package/app/cis/agents/presentation-master/prompt.yaml +62 -0
- package/app/cis/agents/storyteller/__init__.py +3 -0
- package/app/cis/agents/storyteller/agent.py +303 -0
- package/app/cis/agents/storyteller/prompt.yaml +99 -0
- package/app/core/__init__.py +5 -0
- package/app/core/agents/__init__.py +5 -0
- package/app/core/agents/mdan-master/__init__.py +7 -0
- package/app/core/agents/mdan-master/agent.py +302 -0
- package/app/core/agents/mdan-master/prompt.yaml +105 -0
- package/app/mmb/agents/__init__.py +24 -0
- package/app/mmb/agents/agent-builder/__init__.py +5 -0
- package/app/mmb/agents/agent-builder/agent.py +261 -0
- package/app/mmb/agents/agent-builder/prompt.yaml +48 -0
- package/app/mmb/agents/module-builder/__init__.py +5 -0
- package/app/mmb/agents/module-builder/agent.py +299 -0
- package/app/mmb/agents/module-builder/prompt.yaml +50 -0
- package/app/mmb/agents/workflow-builder/__init__.py +5 -0
- package/app/mmb/agents/workflow-builder/agent.py +318 -0
- package/app/mmb/agents/workflow-builder/prompt.yaml +52 -0
- package/app/mmm/agents/__init__.py +48 -0
- package/app/mmm/agents/analyst/__init__.py +7 -0
- package/app/mmm/agents/analyst/agent.py +384 -0
- package/app/mmm/agents/analyst/prompt.yaml +62 -0
- package/app/mmm/agents/architect/__init__.py +7 -0
- package/app/mmm/agents/architect/agent.py +300 -0
- package/app/mmm/agents/architect/prompt.yaml +66 -0
- package/app/mmm/agents/dev/__init__.py +7 -0
- package/app/mmm/agents/dev/agent.py +285 -0
- package/app/mmm/agents/dev/prompt.yaml +62 -0
- package/app/mmm/agents/pm/__init__.py +7 -0
- package/app/mmm/agents/pm/agent.py +417 -0
- package/app/mmm/agents/pm/prompt.yaml +64 -0
- package/app/mmm/agents/qa/__init__.py +7 -0
- package/app/mmm/agents/qa/agent.py +267 -0
- package/app/mmm/agents/qa/prompt.yaml +67 -0
- package/app/mmm/agents/quick-flow-solo-dev/__init__.py +7 -0
- package/app/mmm/agents/quick-flow-solo-dev/agent.py +319 -0
- package/app/mmm/agents/quick-flow-solo-dev/prompt.yaml +60 -0
- package/app/mmm/agents/sm/__init__.py +7 -0
- package/app/mmm/agents/sm/agent.py +357 -0
- package/app/mmm/agents/sm/prompt.yaml +61 -0
- package/app/mmm/agents/tech-writer/__init__.py +7 -0
- package/app/mmm/agents/tech-writer/agent.py +420 -0
- package/app/mmm/agents/tech-writer/prompt.yaml +70 -0
- package/app/mmm/agents/ux-designer/__init__.py +14 -0
- package/app/mmm/agents/ux-designer/agent.py +412 -0
- package/app/mmm/agents/ux-designer/prompt.yaml +37 -0
- package/app/packs/__init__.py +32 -0
- package/app/packs/db-optimization/__init__.py +13 -0
- package/app/packs/db-optimization/agents/__init__.py +11 -0
- package/app/packs/db-optimization/agents/db-performance-analyst/__init__.py +5 -0
- package/app/packs/db-optimization/agents/db-performance-analyst/agent.py +559 -0
- package/app/packs/db-optimization/agents/db-performance-analyst/prompt.yaml +63 -0
- package/app/packs/db-optimization/agents/indexing-specialist/__init__.py +5 -0
- package/app/packs/db-optimization/agents/indexing-specialist/agent.py +713 -0
- package/app/packs/db-optimization/agents/indexing-specialist/prompt.yaml +92 -0
- package/app/packs/db-optimization/agents/query-optimizer/__init__.py +5 -0
- package/app/packs/db-optimization/agents/query-optimizer/agent.py +566 -0
- package/app/packs/db-optimization/agents/query-optimizer/prompt.yaml +74 -0
- package/app/packs/devops-azure/__init__.py +13 -0
- package/app/packs/devops-azure/agents/__init__.py +11 -0
- package/app/packs/devops-azure/agents/azure-specialist/__init__.py +5 -0
- package/app/packs/devops-azure/agents/azure-specialist/agent.py +584 -0
- package/app/packs/devops-azure/agents/azure-specialist/prompt.yaml +301 -0
- package/app/packs/devops-azure/agents/cicd-architect/__init__.py +5 -0
- package/app/packs/devops-azure/agents/cicd-architect/agent.py +665 -0
- package/app/packs/devops-azure/agents/cicd-architect/prompt.yaml +409 -0
- package/app/packs/devops-azure/agents/devops-engineer/__init__.py +5 -0
- package/app/packs/devops-azure/agents/devops-engineer/agent.py +545 -0
- package/app/packs/devops-azure/agents/devops-engineer/prompt.yaml +263 -0
- package/app/packs/fintech/__init__.py +13 -0
- package/app/packs/fintech/agents/__init__.py +11 -0
- package/app/packs/fintech/agents/compliance-officer/__init__.py +5 -0
- package/app/packs/fintech/agents/compliance-officer/agent.py +449 -0
- package/app/packs/fintech/agents/compliance-officer/prompt.yaml +135 -0
- package/app/packs/fintech/agents/financial-analyst/__init__.py +5 -0
- package/app/packs/fintech/agents/financial-analyst/agent.py +392 -0
- package/app/packs/fintech/agents/financial-analyst/prompt.yaml +143 -0
- package/app/packs/fintech/agents/risk-manager/__init__.py +5 -0
- package/app/packs/fintech/agents/risk-manager/agent.py +664 -0
- package/app/packs/fintech/agents/risk-manager/prompt.yaml +240 -0
- package/app/tea/agents/tea/__init__.py +9 -0
- package/app/tea/agents/tea/agent.py +689 -0
- package/app/tea/agents/tea/prompt.yaml +100 -0
- package/banner-bmad-method.png +0 -0
- package/docs/404.md +9 -0
- package/docs/_STYLE_GUIDE.md +370 -0
- package/docs/explanation/advanced-elicitation.md +49 -0
- package/docs/explanation/adversarial-review.md +59 -0
- package/docs/explanation/brainstorming.md +33 -0
- package/docs/explanation/established-projects-faq.md +50 -0
- package/docs/explanation/party-mode.md +59 -0
- package/docs/explanation/preventing-agent-conflicts.md +112 -0
- package/docs/explanation/project-context.md +157 -0
- package/docs/explanation/quick-flow.md +73 -0
- package/docs/explanation/why-solutioning-matters.md +77 -0
- package/docs/how-to/customize-bmad.md +172 -0
- package/docs/how-to/established-projects.md +117 -0
- package/docs/how-to/get-answers-about-bmad.md +134 -0
- package/docs/how-to/install-bmad.md +97 -0
- package/docs/how-to/non-interactive-installation.md +171 -0
- package/docs/how-to/project-context.md +136 -0
- package/docs/how-to/quick-fixes.md +123 -0
- package/docs/how-to/shard-large-documents.md +78 -0
- package/docs/how-to/upgrade-to-v6.md +97 -0
- package/docs/index.md +59 -0
- package/docs/reference/agents.md +28 -0
- package/docs/reference/commands.md +151 -0
- package/docs/reference/modules.md +76 -0
- package/docs/reference/testing.md +106 -0
- package/docs/reference/workflow-map.md +89 -0
- package/docs/roadmap.mdx +136 -0
- package/docs/tutorials/getting-started.md +286 -0
- package/eslint.config.mjs +141 -0
- package/package.json +106 -37
- package/prettier.config.mjs +32 -0
- package/prompts/cis/brainstorming-coach.yaml +53 -0
- package/prompts/cis/creative-problem-solver.yaml +74 -0
- package/prompts/cis/design-thinking-coach.yaml +77 -0
- package/prompts/cis/innovation-strategist.yaml +70 -0
- package/prompts/cis/presentation-master.yaml +62 -0
- package/prompts/cis/storyteller.yaml +99 -0
- package/prompts/core/mdan-master.yaml +105 -0
- package/prompts/mmb/agent-builder.yaml +48 -0
- package/prompts/mmb/module-builder.yaml +50 -0
- package/prompts/mmb/workflow-builder.yaml +52 -0
- package/prompts/mmm/analyst.yaml +62 -0
- package/prompts/mmm/architect.yaml +66 -0
- package/prompts/mmm/dev.yaml +62 -0
- package/prompts/mmm/pm.yaml +64 -0
- package/prompts/mmm/qa.yaml +67 -0
- package/prompts/mmm/quick-flow-solo-dev.yaml +60 -0
- package/prompts/mmm/sm.yaml +61 -0
- package/prompts/mmm/tech-writer.yaml +70 -0
- package/prompts/mmm/ux-designer.yaml +33 -0
- package/prompts/packs/db-optimization/db-performance-analyst.yaml +63 -0
- package/prompts/packs/db-optimization/indexing-specialist.yaml +92 -0
- package/prompts/packs/db-optimization/query-optimizer.yaml +74 -0
- package/prompts/packs/devops-azure/azure-specialist.yaml +301 -0
- package/prompts/packs/devops-azure/cicd-architect.yaml +409 -0
- package/prompts/packs/devops-azure/devops-engineer.yaml +263 -0
- package/prompts/packs/fintech/compliance-officer.yaml +135 -0
- package/prompts/packs/fintech/financial-analyst.yaml +143 -0
- package/prompts/packs/fintech/risk-manager.yaml +240 -0
- package/prompts/tea/tea.yaml +100 -0
- package/prompts.json +237 -0
- package/src/bmm/agents/analyst.agent.yaml +43 -0
- package/src/bmm/agents/architect.agent.yaml +29 -0
- package/src/bmm/agents/dev.agent.yaml +38 -0
- package/src/bmm/agents/pm.agent.yaml +44 -0
- package/src/bmm/agents/qa.agent.yaml +58 -0
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
- package/src/bmm/agents/sm.agent.yaml +37 -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 +46 -0
- package/src/bmm/agents/ux-designer.agent.yaml +27 -0
- package/src/bmm/data/project-context-template.md +26 -0
- package/src/bmm/module-help.csv +31 -0
- package/src/bmm/module.yaml +50 -0
- package/src/bmm/teams/default-party.csv +20 -0
- package/src/bmm/teams/team-fullstack.yaml +12 -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 +162 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -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 +444 -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-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 +476 -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 +233 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +487 -0
- package/src/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -0
- package/src/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -0
- package/src/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/data/domain-complexity.csv +15 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md +197 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv +11 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01-init.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md +152 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +154 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +170 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +213 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +207 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +124 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +247 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +249 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md +253 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md +168 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md +174 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/templates/prd-template.md +10 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +63 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -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 +171 -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 +42 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +184 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +172 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +173 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +133 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +245 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -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 +54 -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 +13 -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 +173 -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 +329 -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 +76 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -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 +149 -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 +58 -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 +43 -0
- package/src/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
- package/src/bmm/workflows/4-implementation/correct-course/instructions.md +207 -0
- package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +53 -0
- package/src/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
- package/src/bmm/workflows/4-implementation/create-story/instructions.xml +346 -0
- package/src/bmm/workflows/4-implementation/create-story/template.md +49 -0
- package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +52 -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 +20 -0
- package/src/bmm/workflows/4-implementation/retrospective/instructions.md +1444 -0
- package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +52 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/instructions.md +226 -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 +47 -0
- package/src/bmm/workflows/4-implementation/sprint-status/instructions.md +230 -0
- package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +174 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +118 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +111 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +111 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +104 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -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 +143 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +126 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +200 -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 +130 -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 +22 -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/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/qa-generate-e2e-tests/checklist.md +33 -0
- package/src/bmm/workflows/qa-generate-e2e-tests/instructions.md +110 -0
- package/src/bmm/workflows/qa-generate-e2e-tests/workflow.yaml +42 -0
- package/src/core/agents/bmad-master.agent.yaml +30 -0
- package/src/core/module-help.csv +9 -0
- package/src/core/module.yaml +25 -0
- package/src/core/tasks/editorial-review-prose.xml +102 -0
- package/src/core/tasks/editorial-review-structure.xml +208 -0
- package/src/core/tasks/help.md +86 -0
- package/src/core/tasks/index-docs.xml +65 -0
- package/src/core/tasks/review-adversarial-general.xml +49 -0
- package/src/core/tasks/shard-doc.xml +108 -0
- package/src/core/tasks/workflow.xml +235 -0
- package/src/core/workflows/advanced-elicitation/methods.csv +51 -0
- package/src/core/workflows/advanced-elicitation/workflow.xml +118 -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 +168 -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 +14 -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 +6 -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/adversarial-review-tests/README.md +56 -0
- package/test/adversarial-review-tests/sample-content.md +46 -0
- package/test/adversarial-review-tests/test-cases.yaml +103 -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/fixtures/file-refs-csv/invalid/all-empty-workflow.csv +3 -0
- package/test/fixtures/file-refs-csv/invalid/empty-data.csv +1 -0
- package/test/fixtures/file-refs-csv/invalid/no-workflow-column.csv +3 -0
- package/test/fixtures/file-refs-csv/invalid/unresolvable-vars.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/bmm-style.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/core-style.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/minimal.csv +2 -0
- package/test/test-agent-schema.js +387 -0
- package/test/test-cli-integration.sh +159 -0
- package/test/test-file-refs-csv.js +133 -0
- package/test/test-installation-components.js +212 -0
- package/test/test-rehype-plugins.mjs +1050 -0
- package/test/unit-test-schema.js +133 -0
- package/tests/run_all_tests.py +80 -0
- package/tests/scenarios/cis/brainstorming-coach.test.py +150 -0
- package/tests/scenarios/cis/creative-problem-solver.test.py +167 -0
- package/tests/scenarios/cis/design-thinking-coach.test.py +177 -0
- package/tests/scenarios/cis/innovation-strategist.test.py +191 -0
- package/tests/scenarios/cis/presentation-master.test.py +240 -0
- package/tests/scenarios/cis/storyteller.test.py +324 -0
- package/tests/scenarios/core/mdan-master.test.py +281 -0
- package/tests/scenarios/mmb/agent-builder.test.py +124 -0
- package/tests/scenarios/mmb/module-builder.test.py +124 -0
- package/tests/scenarios/mmb/workflow-builder.test.py +124 -0
- package/tests/scenarios/mmm/analyst.test.py +138 -0
- package/tests/scenarios/mmm/architect.test.py +138 -0
- package/tests/scenarios/mmm/dev.test.py +138 -0
- package/tests/scenarios/mmm/pm.test.py +138 -0
- package/tests/scenarios/mmm/qa.test.py +138 -0
- package/tests/scenarios/mmm/quick-flow-solo-dev.test.py +138 -0
- package/tests/scenarios/mmm/sm.test.py +138 -0
- package/tests/scenarios/mmm/tech-writer.test.py +138 -0
- package/tests/scenarios/mmm/ux-designer.test.py +294 -0
- package/tests/scenarios/packs/db-optimization/db-performance-analyst.test.py +108 -0
- package/tests/scenarios/packs/db-optimization/indexing-specialist.test.py +108 -0
- package/tests/scenarios/packs/db-optimization/query-optimizer.test.py +106 -0
- package/tests/scenarios/packs/devops-azure/azure-specialist.test.py +125 -0
- package/tests/scenarios/packs/devops-azure/cicd-architect.test.py +122 -0
- package/tests/scenarios/packs/devops-azure/devops-engineer.test.py +128 -0
- package/tests/scenarios/packs/fintech/compliance-officer.test.py +165 -0
- package/tests/scenarios/packs/fintech/financial-analyst.test.py +184 -0
- package/tests/scenarios/packs/fintech/risk-manager.test.py +171 -0
- package/tests/scenarios/tea/tea.test.py +346 -0
- package/tests/simple_cis_test.py +285 -0
- package/tests/simple_db_optimization_test.py +199 -0
- package/tests/simple_devops_test.py +193 -0
- package/tests/simple_fintech_test.py +205 -0
- package/tests/simple_mmb_test.py +103 -0
- package/tests/simple_mmm_test.py +159 -0
- package/tests/simple_tea_test.py +80 -0
- package/tests/simple_test.py +111 -0
- package/tests/simple_ux_designer_test.py +144 -0
- package/tests/validate_yaml.py +86 -0
- package/tools/bmad-npx-wrapper.js +38 -0
- package/tools/build-docs.mjs +463 -0
- package/tools/cli/README.md +60 -0
- package/tools/cli/bmad-cli.js +106 -0
- package/tools/cli/commands/install.js +87 -0
- package/tools/cli/commands/status.js +65 -0
- package/tools/cli/commands/uninstall.js +167 -0
- package/tools/cli/external-official-modules.yaml +53 -0
- package/tools/cli/installers/install-messages.yaml +39 -0
- package/tools/cli/installers/lib/core/config-collector.js +1285 -0
- package/tools/cli/installers/lib/core/custom-module-cache.js +260 -0
- package/tools/cli/installers/lib/core/dependency-resolver.js +743 -0
- package/tools/cli/installers/lib/core/detector.js +223 -0
- package/tools/cli/installers/lib/core/ide-config-manager.js +157 -0
- package/tools/cli/installers/lib/core/installer.js +3162 -0
- package/tools/cli/installers/lib/core/manifest-generator.js +1081 -0
- package/tools/cli/installers/lib/core/manifest.js +1038 -0
- package/tools/cli/installers/lib/custom/handler.js +358 -0
- package/tools/cli/installers/lib/ide/_base-ide.js +665 -0
- package/tools/cli/installers/lib/ide/_config-driven.js +634 -0
- package/tools/cli/installers/lib/ide/codex.js +440 -0
- package/tools/cli/installers/lib/ide/github-copilot.js +699 -0
- package/tools/cli/installers/lib/ide/kilo.js +269 -0
- package/tools/cli/installers/lib/ide/manager.js +342 -0
- package/tools/cli/installers/lib/ide/platform-codes.js +100 -0
- package/tools/cli/installers/lib/ide/platform-codes.yaml +243 -0
- package/tools/cli/installers/lib/ide/rovodev.js +257 -0
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +180 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +174 -0
- package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
- package/tools/cli/installers/lib/ide/shared/path-utils.js +299 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +366 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +318 -0
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/antigravity.md +8 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-agent.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-task.md +10 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-tool.md +10 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow.md +6 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-agent.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-task.toml +11 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-tool.toml +11 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml +16 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-agent.md +16 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-task.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-tool.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow-yaml.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow.md +7 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-agent.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-task.md +13 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-tool.md +13 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md +16 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md +16 -0
- package/tools/cli/installers/lib/ide/templates/combined/rovodev.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/trae.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/windsurf-workflow.md +10 -0
- package/tools/cli/installers/lib/ide/templates/split/.gitkeep +0 -0
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +13 -0
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +5 -0
- package/tools/cli/installers/lib/message-loader.js +83 -0
- package/tools/cli/installers/lib/modules/external-manager.js +136 -0
- package/tools/cli/installers/lib/modules/manager.js +1498 -0
- package/tools/cli/lib/activation-builder.js +165 -0
- package/tools/cli/lib/agent/compiler.js +525 -0
- package/tools/cli/lib/agent/installer.js +680 -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 +182 -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 +809 -0
- package/tools/cli/lib/ui.js +1936 -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/docs/_prompt-external-modules-page.md +59 -0
- package/tools/docs/fix-refs.md +91 -0
- package/tools/fix-doc-links.js +285 -0
- package/tools/format-workflow-md.js +263 -0
- package/tools/lib/xml-utils.js +13 -0
- package/tools/migrate-custom-module-paths.js +124 -0
- package/tools/platform-codes.yaml +157 -0
- package/tools/schema/agent.js +491 -0
- package/tools/validate-agent-schema.js +110 -0
- package/tools/validate-doc-links.js +407 -0
- package/tools/validate-file-refs.js +554 -0
- package/tools/validate-svg-changes.sh +356 -0
- package/website/README.md +75 -0
- package/website/astro.config.mjs +136 -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/workflow-map-diagram.html +361 -0
- package/website/src/components/Banner.astro +62 -0
- package/website/src/components/Header.astro +96 -0
- package/website/src/components/MobileMenuFooter.astro +33 -0
- package/website/src/content/config.ts +6 -0
- package/website/src/lib/site-url.mjs +25 -0
- package/website/src/pages/404.astro +11 -0
- package/website/src/pages/robots.txt.ts +48 -0
- package/website/src/rehype-base-paths.js +112 -0
- package/website/src/rehype-markdown-links.js +119 -0
- package/website/src/styles/custom.css +805 -0
- package/.mcp.json +0 -46
- package/agents/AGENTS-REGISTRY.md +0 -215
- package/agents/architect.md +0 -160
- package/agents/dev.md +0 -166
- package/agents/devops.md +0 -230
- package/agents/doc.md +0 -189
- package/agents/learn.md +0 -377
- package/agents/product.md +0 -124
- package/agents/security.md +0 -168
- package/agents/test.md +0 -209
- package/agents/ux.md +0 -207
- package/cli/mdan.js +0 -628
- package/cli/mdan.py +0 -316
- package/cli/mdan.sh +0 -724
- package/cli/postinstall.js +0 -4
- package/core/orchestrator.md +0 -238
- package/core/universal-envelope.md +0 -160
- package/install.sh +0 -91
- package/integrations/all-integrations.md +0 -300
- package/integrations/claude.md +0 -46
- package/integrations/cursor.md +0 -74
- package/integrations/mcp.md +0 -153
- package/integrations/windsurf.md +0 -48
- package/memory/MDAN-STATE.template.json +0 -44
- package/memory/MEMORY-SYSTEM.md +0 -197
- package/phases/01-discover.md +0 -136
- package/phases/02-design.md +0 -147
- package/phases/03-build.md +0 -113
- package/phases/04-verify.md +0 -107
- package/phases/05-ship.md +0 -156
- package/skills/find-skills/skill.md +0 -133
- package/templates/ARCHITECTURE.md +0 -186
- package/templates/CHANGELOG.md +0 -41
- package/templates/MDAN-KNOWLEDGE.md +0 -73
- package/templates/PRD.md +0 -120
- package/templates/SECURITY-REVIEW.md +0 -99
- package/templates/TEST-PLAN.md +0 -97
- package/templates/prompts/README.md +0 -108
- package/templates/prompts/dev-agent.yaml +0 -85
- package/templates/prompts/orchestrator.yaml +0 -97
- package/templates/prompts.json +0 -81
- package/templates/tests/evaluations/README.md +0 -80
- package/templates/tests/evaluations/classification_eval.md +0 -136
- package/templates/tests/evaluations/rag_eval.md +0 -116
- package/templates/tests/scenarios/README.md +0 -62
- package/templates/tests/scenarios/basic_authentication.test.md +0 -82
- package/templates/tests/scenarios/user_registration.test.md +0 -107
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Testing Options
|
|
3
|
+
description: Comparing the built-in QA agent (Quinn) with the Test Architect (TEA) module for test automation.
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 5
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
BMad provides two testing paths: a built-in QA agent for fast test generation and an installable Test Architect module for enterprise-grade test strategy.
|
|
9
|
+
|
|
10
|
+
## Which Should You Use?
|
|
11
|
+
|
|
12
|
+
| Factor | Quinn (Built-in QA) | TEA Module |
|
|
13
|
+
| --- | --- | --- |
|
|
14
|
+
| **Best for** | Small-medium projects, quick coverage | Large projects, regulated or complex domains |
|
|
15
|
+
| **Setup** | Nothing to install -- included in BMM | Install separately via `npx bmad-method install` |
|
|
16
|
+
| **Approach** | Generate tests fast, iterate later | Plan first, then generate with traceability |
|
|
17
|
+
| **Test types** | API and E2E tests | API, E2E, ATDD, NFR, and more |
|
|
18
|
+
| **Strategy** | Happy path + critical edge cases | Risk-based prioritization (P0-P3) |
|
|
19
|
+
| **Workflow count** | 1 (Automate) | 9 (design, ATDD, automate, review, trace, and others) |
|
|
20
|
+
|
|
21
|
+
:::tip[Start with Quinn]
|
|
22
|
+
Most projects should start with Quinn. If you later need test strategy, quality gates, or requirements traceability, install TEA alongside it.
|
|
23
|
+
:::
|
|
24
|
+
|
|
25
|
+
## Built-in QA Agent (Quinn)
|
|
26
|
+
|
|
27
|
+
Quinn is the built-in QA agent in the BMM (Agile suite) module. It generates working tests quickly using your project's existing test framework -- no configuration or additional installation required.
|
|
28
|
+
|
|
29
|
+
**Trigger:** `QA` or `bmad-bmm-qa-automate`
|
|
30
|
+
|
|
31
|
+
### What Quinn Does
|
|
32
|
+
|
|
33
|
+
Quinn runs a single workflow (Automate) that walks through five steps:
|
|
34
|
+
|
|
35
|
+
1. **Detect test framework** -- scans `package.json` and existing test files for your framework (Jest, Vitest, Playwright, Cypress, or any standard runner). If none exists, analyzes the project stack and suggests one.
|
|
36
|
+
2. **Identify features** -- asks what to test or auto-discovers features in the codebase.
|
|
37
|
+
3. **Generate API tests** -- covers status codes, response structure, happy path, and 1-2 error cases.
|
|
38
|
+
4. **Generate E2E tests** -- covers user workflows with semantic locators and visible-outcome assertions.
|
|
39
|
+
5. **Run and verify** -- executes the generated tests and fixes failures immediately.
|
|
40
|
+
|
|
41
|
+
Quinn produces a test summary saved to your project's implementation artifacts folder.
|
|
42
|
+
|
|
43
|
+
### Test Patterns
|
|
44
|
+
|
|
45
|
+
Generated tests follow a "simple and maintainable" philosophy:
|
|
46
|
+
|
|
47
|
+
- **Standard framework APIs only** -- no external utilities or custom abstractions
|
|
48
|
+
- **Semantic locators** for UI tests (roles, labels, text rather than CSS selectors)
|
|
49
|
+
- **Independent tests** with no order dependencies
|
|
50
|
+
- **No hardcoded waits or sleeps**
|
|
51
|
+
- **Clear descriptions** that read as feature documentation
|
|
52
|
+
|
|
53
|
+
:::note[Scope]
|
|
54
|
+
Quinn generates tests only. For code review and story validation, use the Code Review workflow (`CR`) instead.
|
|
55
|
+
:::
|
|
56
|
+
|
|
57
|
+
### When to Use Quinn
|
|
58
|
+
|
|
59
|
+
- Quick test coverage for a new or existing feature
|
|
60
|
+
- Beginner-friendly test automation without advanced setup
|
|
61
|
+
- Standard test patterns that any developer can read and maintain
|
|
62
|
+
- Small-medium projects where comprehensive test strategy is unnecessary
|
|
63
|
+
|
|
64
|
+
## Test Architect (TEA) Module
|
|
65
|
+
|
|
66
|
+
TEA is a standalone module that provides an expert agent (Murat) and nine structured workflows for enterprise-grade testing. It goes beyond test generation into test strategy, risk-based planning, quality gates, and requirements traceability.
|
|
67
|
+
|
|
68
|
+
- **Documentation:** [TEA Module Docs](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)
|
|
69
|
+
- **Install:** `npx bmad-method install` and select the TEA module
|
|
70
|
+
- **npm:** [`bmad-method-test-architecture-enterprise`](https://www.npmjs.com/package/bmad-method-test-architecture-enterprise)
|
|
71
|
+
|
|
72
|
+
### What TEA Provides
|
|
73
|
+
|
|
74
|
+
| Workflow | Purpose |
|
|
75
|
+
| --- | --- |
|
|
76
|
+
| Test Design | Create a comprehensive test strategy tied to requirements |
|
|
77
|
+
| ATDD | Acceptance-test-driven development with stakeholder criteria |
|
|
78
|
+
| Automate | Generate tests with advanced patterns and utilities |
|
|
79
|
+
| Test Review | Validate test quality and coverage against strategy |
|
|
80
|
+
| Traceability | Map tests back to requirements for audit and compliance |
|
|
81
|
+
| NFR Assessment | Evaluate non-functional requirements (performance, security) |
|
|
82
|
+
| CI Setup | Configure test execution in continuous integration pipelines |
|
|
83
|
+
| Framework Scaffolding | Set up test infrastructure and project structure |
|
|
84
|
+
| Release Gate | Make data-driven go/no-go release decisions |
|
|
85
|
+
|
|
86
|
+
TEA also supports P0-P3 risk-based prioritization and optional integrations with Playwright Utils and MCP tooling.
|
|
87
|
+
|
|
88
|
+
### When to Use TEA
|
|
89
|
+
|
|
90
|
+
- Projects that require requirements traceability or compliance documentation
|
|
91
|
+
- Teams that need risk-based test prioritization across many features
|
|
92
|
+
- Enterprise environments with formal quality gates before release
|
|
93
|
+
- Complex domains where test strategy must be planned before tests are written
|
|
94
|
+
- Projects that have outgrown Quinn's single-workflow approach
|
|
95
|
+
|
|
96
|
+
## How Testing Fits into Workflows
|
|
97
|
+
|
|
98
|
+
Quinn's Automate workflow appears in Phase 4 (Implementation) of the BMad Method workflow map. A typical sequence:
|
|
99
|
+
|
|
100
|
+
1. Implement a story with the Dev workflow (`DS`)
|
|
101
|
+
2. Generate tests with Quinn (`QA`) or TEA's Automate workflow
|
|
102
|
+
3. Validate implementation with Code Review (`CR`)
|
|
103
|
+
|
|
104
|
+
Quinn works directly from source code without loading planning documents (PRD, architecture). TEA workflows can integrate with upstream planning artifacts for traceability.
|
|
105
|
+
|
|
106
|
+
For more on where testing fits in the overall process, see the [Workflow Map](./workflow-map.md).
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Workflow Map"
|
|
3
|
+
description: Visual reference for BMad Method workflow phases and outputs
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
The BMad Method (BMM) is a module in the BMad Ecosystem, targeted at following the best practices of context engineering and planning. AI agents work best with clear, structured context. The BMM system builds that context progressively across 4 distinct phases - each phase, and multiple workflows optionally within each phase, produce documents that inform the next, so agents always know what to build and why.
|
|
9
|
+
|
|
10
|
+
The rationale and concepts come from agile methodologies that have been used across the industry with great success as a mental framework.
|
|
11
|
+
|
|
12
|
+
If at any time you are unsure what to do, the `/bmad-help` command will help you stay on track or know what to do next. You can always refer to this for reference also - but /bmad-help is fully interactive and much quicker if you have already installed the BMad Method. Additionally, if you are using different modules that have extended the BMad Method or added other complementary non-extension modules - the /bmad-help evolves to know all that is available to give you the best in-the-moment advice.
|
|
13
|
+
|
|
14
|
+
Final important note: Every workflow below can be run directly with your tool of choice via slash command or by loading an agent first and using the entry from the agents menu.
|
|
15
|
+
|
|
16
|
+
<iframe src="/workflow-map-diagram.html" title="BMad Method Workflow Map Diagram" width="100%" height="100%" style="border-radius: 8px; border: 1px solid #334155; min-height: 900px;"></iframe>
|
|
17
|
+
|
|
18
|
+
<p style="font-size: 0.8rem; text-align: right; margin-top: -0.5rem; margin-bottom: 1rem;">
|
|
19
|
+
<a href="/workflow-map-diagram.html" target="_blank" rel="noopener noreferrer">Open diagram in new tab ↗</a>
|
|
20
|
+
</p>
|
|
21
|
+
|
|
22
|
+
## Phase 1: Analysis (Optional)
|
|
23
|
+
|
|
24
|
+
Explore the problem space and validate ideas before committing to planning.
|
|
25
|
+
|
|
26
|
+
| Workflow | Purpose | Produces |
|
|
27
|
+
| ------------------------------- | -------------------------------------------------------------------------- | ------------------------- |
|
|
28
|
+
| `bmad-brainstorming` | Brainstorm Project Ideas with guided facilitation of a brainstorming coach | `brainstorming-report.md` |
|
|
29
|
+
| `bmad-bmm-research` | Validate market, technical, or domain assumptions | Research findings |
|
|
30
|
+
| `bmad-bmm-create-product-brief` | Capture strategic vision | `product-brief.md` |
|
|
31
|
+
|
|
32
|
+
## Phase 2: Planning
|
|
33
|
+
|
|
34
|
+
Define what to build and for whom.
|
|
35
|
+
|
|
36
|
+
| Workflow | Purpose | Produces |
|
|
37
|
+
| --------------------------- | ---------------------------------------- | ------------ |
|
|
38
|
+
| `bmad-bmm-create-prd` | Define requirements (FRs/NFRs) | `PRD.md` |
|
|
39
|
+
| `bmad-bmm-create-ux-design` | Design user experience (when UX matters) | `ux-spec.md` |
|
|
40
|
+
|
|
41
|
+
## Phase 3: Solutioning
|
|
42
|
+
|
|
43
|
+
Decide how to build it and break work into stories.
|
|
44
|
+
|
|
45
|
+
| Workflow | Purpose | Produces |
|
|
46
|
+
| ----------------------------------------- | ------------------------------------------ | --------------------------- |
|
|
47
|
+
| `bmad-bmm-create-architecture` | Make technical decisions explicit | `architecture.md` with ADRs |
|
|
48
|
+
| `bmad-bmm-create-epics-and-stories` | Break requirements into implementable work | Epic files with stories |
|
|
49
|
+
| `bmad-bmm-check-implementation-readiness` | Gate check before implementation | PASS/CONCERNS/FAIL decision |
|
|
50
|
+
|
|
51
|
+
## Phase 4: Implementation
|
|
52
|
+
|
|
53
|
+
Build it, one story at a time. Coming soon, full phase 4 automation!
|
|
54
|
+
|
|
55
|
+
| Workflow | Purpose | Produces |
|
|
56
|
+
| -------------------------- | ------------------------------------------------------------------------ | -------------------------------- |
|
|
57
|
+
| `bmad-bmm-sprint-planning` | Initialize tracking (once per project to sequence the dev cycle) | `sprint-status.yaml` |
|
|
58
|
+
| `bmad-bmm-create-story` | Prepare next story for implementation | `story-[slug].md` |
|
|
59
|
+
| `bmad-bmm-dev-story` | Implement the story | Working code + tests |
|
|
60
|
+
| `bmad-bmm-code-review` | Validate implementation quality | Approved or changes requested |
|
|
61
|
+
| `bmad-bmm-correct-course` | Handle significant mid-sprint changes | Updated plan or re-routing |
|
|
62
|
+
| `bmad-bmm-automate` | Generate tests for existing features - Use after a full epic is complete | End to End UI Focused Test suite |
|
|
63
|
+
| `bmad-bmm-retrospective` | Review after epic completion | Lessons learned |
|
|
64
|
+
|
|
65
|
+
## Quick Flow (Parallel Track)
|
|
66
|
+
|
|
67
|
+
Skip phases 1-3 for small, well-understood work.
|
|
68
|
+
|
|
69
|
+
| Workflow | Purpose | Produces |
|
|
70
|
+
| --------------------- | ------------------------------------------ | --------------------------------------------- |
|
|
71
|
+
| `bmad-bmm-quick-spec` | Define an ad-hoc change | `tech-spec.md` (story file for small changes) |
|
|
72
|
+
| `bmad-bmm-quick-dev` | Implement from spec or direct instructions | Working code + tests |
|
|
73
|
+
|
|
74
|
+
## Context Management
|
|
75
|
+
|
|
76
|
+
Each document becomes context for the next phase. The PRD tells the architect what constraints matter. The architecture tells the dev agent which patterns to follow. Story files give focused, complete context for implementation. Without this structure, agents make inconsistent decisions.
|
|
77
|
+
|
|
78
|
+
### Project Context
|
|
79
|
+
|
|
80
|
+
:::tip[Recommended]
|
|
81
|
+
Create `project-context.md` to ensure AI agents follow your project's rules and preferences. This file works like a constitution for your project — it guides implementation decisions across all workflows. This optional file can be generated at the end of Architecture Creation, or in an existing project it can be generated also to capture whats important to keep aligned with current conventions.
|
|
82
|
+
:::
|
|
83
|
+
|
|
84
|
+
**How to create it:**
|
|
85
|
+
|
|
86
|
+
- **Manually** — Create `_bmad-output/project-context.md` with your technology stack and implementation rules
|
|
87
|
+
- **Generate it** — Run `/bmad-bmm-generate-project-context` to auto-generate from your architecture or codebase
|
|
88
|
+
|
|
89
|
+
[**Learn more about project-context.md**](../explanation/project-context.md)
|
package/docs/roadmap.mdx
ADDED
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Roadmap
|
|
3
|
+
description: What's next for BMad - Features, improvements, and community contributions
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# The BMad Method: Public Roadmap
|
|
7
|
+
|
|
8
|
+
The BMad Method, BMad Method Module (BMM), and BMad Builder (BMB) are evolving. Here's what we're working on and what's coming next.
|
|
9
|
+
|
|
10
|
+
<div class="roadmap-container">
|
|
11
|
+
|
|
12
|
+
<h2 class="roadmap-section-title">In Progress</h2>
|
|
13
|
+
|
|
14
|
+
<div class="roadmap-future">
|
|
15
|
+
<div class="roadmap-future-card">
|
|
16
|
+
<span class="roadmap-emoji">🧩</span>
|
|
17
|
+
<h4>Universal Skills Architecture</h4>
|
|
18
|
+
<p>One skill, any platform. Write once, run everywhere.</p>
|
|
19
|
+
</div>
|
|
20
|
+
<div class="roadmap-future-card">
|
|
21
|
+
<span class="roadmap-emoji">🏗️</span>
|
|
22
|
+
<h4>BMad Builder v1</h4>
|
|
23
|
+
<p>Craft production-ready AI agents and workflows with evals, teams, and graceful degradation built in.</p>
|
|
24
|
+
</div>
|
|
25
|
+
<div class="roadmap-future-card">
|
|
26
|
+
<span class="roadmap-emoji">🧠</span>
|
|
27
|
+
<h4>Project Context System</h4>
|
|
28
|
+
<p>Your AI actually understands your project. Framework-aware context that evolves with your codebase.</p>
|
|
29
|
+
</div>
|
|
30
|
+
<div class="roadmap-future-card">
|
|
31
|
+
<span class="roadmap-emoji">📦</span>
|
|
32
|
+
<h4>Centralized Skills</h4>
|
|
33
|
+
<p>Install once, use everywhere. Share skills across projects without the file clutter.</p>
|
|
34
|
+
</div>
|
|
35
|
+
<div class="roadmap-future-card">
|
|
36
|
+
<span class="roadmap-emoji">🔄</span>
|
|
37
|
+
<h4>Adaptive Skills</h4>
|
|
38
|
+
<p>Skills that know your tool. Optimized variants for Claude, Codex, Kimi, and OpenCode, plus many more.</p>
|
|
39
|
+
</div>
|
|
40
|
+
<div class="roadmap-future-card">
|
|
41
|
+
<span class="roadmap-emoji">📝</span>
|
|
42
|
+
<h4>BMad Team Pros Blog</h4>
|
|
43
|
+
<p>Guides, articles and insights from the team. Launching soon.</p>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
|
|
47
|
+
<h2 class="roadmap-section-title">Getting Started</h2>
|
|
48
|
+
|
|
49
|
+
<div class="roadmap-future">
|
|
50
|
+
<div class="roadmap-future-card">
|
|
51
|
+
<span class="roadmap-emoji">🏪</span>
|
|
52
|
+
<h4>Skill Marketplace</h4>
|
|
53
|
+
<p>Discover, install, and update community-built skills. One curl command away from superpowers.</p>
|
|
54
|
+
</div>
|
|
55
|
+
<div class="roadmap-future-card">
|
|
56
|
+
<span class="roadmap-emoji">🎨</span>
|
|
57
|
+
<h4>Workflow Customization</h4>
|
|
58
|
+
<p>Make it yours. Integrate Jira, Linear, custom outputs your workflow, your rules.</p>
|
|
59
|
+
</div>
|
|
60
|
+
<div class="roadmap-future-card">
|
|
61
|
+
<span class="roadmap-emoji">🚀</span>
|
|
62
|
+
<h4>Phase 1-3 Optimization</h4>
|
|
63
|
+
<p>Lightning-fast planning with sub-agent context gathering. YOLO mode meets guided excellence.</p>
|
|
64
|
+
</div>
|
|
65
|
+
<div class="roadmap-future-card">
|
|
66
|
+
<span class="roadmap-emoji">🌐</span>
|
|
67
|
+
<h4>Enterprise Ready</h4>
|
|
68
|
+
<p>SSO, audit logs, team workspaces. All the boring stuff that makes companies say yes.</p>
|
|
69
|
+
</div>
|
|
70
|
+
<div class="roadmap-future-card">
|
|
71
|
+
<span class="roadmap-emoji">💎</span>
|
|
72
|
+
<h4>Community Modules Explosion</h4>
|
|
73
|
+
<p>Entertainment, security, therapy, roleplay and much more. Expand the BMad Method platform.</p>
|
|
74
|
+
</div>
|
|
75
|
+
<div class="roadmap-future-card">
|
|
76
|
+
<span class="roadmap-emoji">⚡</span>
|
|
77
|
+
<h4>Dev Loop Automation</h4>
|
|
78
|
+
<p>Optional autopilot for development. Let AI handle the flow while keeping quality sky-high.</p>
|
|
79
|
+
</div>
|
|
80
|
+
</div>
|
|
81
|
+
|
|
82
|
+
<h2 class="roadmap-section-title">Community and Team</h2>
|
|
83
|
+
|
|
84
|
+
<div class="roadmap-future">
|
|
85
|
+
<div class="roadmap-future-card">
|
|
86
|
+
<span class="roadmap-emoji">🎙️</span>
|
|
87
|
+
<h4>The BMad Method Podcast</h4>
|
|
88
|
+
<p>Conversations about AI-native development. Launching March 1, 2026!</p>
|
|
89
|
+
</div>
|
|
90
|
+
<div class="roadmap-future-card">
|
|
91
|
+
<span class="roadmap-emoji">🎓</span>
|
|
92
|
+
<h4>The BMad Method Master Class</h4>
|
|
93
|
+
<p>Go from user to expert. Deep dives into every phase, every workflow, every secret.</p>
|
|
94
|
+
</div>
|
|
95
|
+
<div class="roadmap-future-card">
|
|
96
|
+
<span class="roadmap-emoji">🏗️</span>
|
|
97
|
+
<h4>The BMad Builder Master Class</h4>
|
|
98
|
+
<p>Build your own agents. Advanced techniques for when you are ready to create, not just use.</p>
|
|
99
|
+
</div>
|
|
100
|
+
<div class="roadmap-future-card">
|
|
101
|
+
<span class="roadmap-emoji">⚡</span>
|
|
102
|
+
<h4>BMad Prototype First</h4>
|
|
103
|
+
<p>Idea to working prototype in one session. Craft your dream app like a work of art.</p>
|
|
104
|
+
</div>
|
|
105
|
+
<div class="roadmap-future-card">
|
|
106
|
+
<span class="roadmap-emoji">🌴</span>
|
|
107
|
+
<h4>BMad BALM!</h4>
|
|
108
|
+
<p>Life management for the AI-native. Tasks, habits, goals your AI copilot for everything.</p>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="roadmap-future-card">
|
|
111
|
+
<span class="roadmap-emoji">🖥️</span>
|
|
112
|
+
<h4>Official UI</h4>
|
|
113
|
+
<p>A beautiful interface for the entire BMad ecosystem. CLI power, GUI polish.</p>
|
|
114
|
+
</div>
|
|
115
|
+
<div class="roadmap-future-card">
|
|
116
|
+
<span class="roadmap-emoji">🔒</span>
|
|
117
|
+
<h4>BMad in a Box</h4>
|
|
118
|
+
<p>Self-hosted, air-gapped, enterprise-grade. Your AI assistant, your infrastructure, your control.</p>
|
|
119
|
+
</div>
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
<div style="text-align: center; margin-top: 3rem; padding: 2rem; background: var(--color-bg-card); border-radius: 12px; border: 1px solid var(--color-border);">
|
|
123
|
+
<h3 style="margin: 0 0 1rem;">Want to Contribute?</h3>
|
|
124
|
+
<p style="color: var(--slate-color-400); margin: 0;">
|
|
125
|
+
This is only a partial list of what's planned. The BMad Open Source team welcomes contributors!{" "}<br />
|
|
126
|
+
<a href="https://github.com/bmad-code-org/BMAD-METHOD" style="color: var(--color-in-progress);">Join us on GitHub</a> to help shape the future of AI-driven development.
|
|
127
|
+
</p>
|
|
128
|
+
<p style="color: var(--slate-color-400); margin: 1.5rem 0 0;">
|
|
129
|
+
Love what we're building? We appreciate both one-time and monthly{" "}<a href="https://buymeacoffee.com/bmad" style="color: var(--color-in-progress);">support</a>.
|
|
130
|
+
</p>
|
|
131
|
+
<p style="color: var(--slate-color-400); margin: 1rem 0 0;">
|
|
132
|
+
For corporate sponsorship, partnership inquiries, speaking engagements, training, or media enquiries:{" "}
|
|
133
|
+
<a href="mailto:contact@bmadcode.com" style="color: var(--color-in-progress);">contact@bmadcode.com</a>
|
|
134
|
+
</p>
|
|
135
|
+
</div>
|
|
136
|
+
</div>
|
|
@@ -0,0 +1,286 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Getting Started"
|
|
3
|
+
description: Install MDAN and build your first project
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation.
|
|
7
|
+
|
|
8
|
+
## What You'll Learn
|
|
9
|
+
|
|
10
|
+
- Install and initialize MDAN for a new project
|
|
11
|
+
- Use **MDAN-Help** — your intelligent guide that knows what to do next
|
|
12
|
+
- Choose the right planning track for your project size
|
|
13
|
+
- Progress through phases from requirements to working code
|
|
14
|
+
- Use agents and workflows effectively
|
|
15
|
+
|
|
16
|
+
:::note[Prerequisites]
|
|
17
|
+
- **Node.js 20+** — Required for the installer
|
|
18
|
+
- **Git** — Recommended for version control
|
|
19
|
+
- **AI-powered IDE** — Claude Code, Cursor, or similar
|
|
20
|
+
- **A project idea** — Even a simple one works for learning
|
|
21
|
+
:::
|
|
22
|
+
|
|
23
|
+
:::tip[The Easiest Path]
|
|
24
|
+
**Install** → `npx mdan install`
|
|
25
|
+
**Ask** → `/mdan-help what should I do first?`
|
|
26
|
+
**Build** → Let MDAN-Help guide you workflow by workflow
|
|
27
|
+
:::
|
|
28
|
+
|
|
29
|
+
## Meet MDAN-Help: Your Intelligent Guide
|
|
30
|
+
|
|
31
|
+
**MDAN-Help is the fastest way to get started with MDAN.** You don't need to memorize workflows or phases — just ask, and MDAN-Help will:
|
|
32
|
+
|
|
33
|
+
- **Inspect your project** to see what's already been done
|
|
34
|
+
- **Show your options** based on which modules you have installed
|
|
35
|
+
- **Recommend what's next** — including the first required task
|
|
36
|
+
- **Answer questions** like "I have a SaaS idea, where do I start?"
|
|
37
|
+
|
|
38
|
+
### How to Use MDAN-Help
|
|
39
|
+
|
|
40
|
+
Run it in your AI IDE with just the slash command:
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
/mdan-help
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Or combine it with a question for context-aware guidance:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
/mdan-help I have an idea for a SaaS product, I already know all the features I want. where do I get started?
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
MDAN-Help will respond with:
|
|
53
|
+
- What's recommended for your situation
|
|
54
|
+
- What the first required task is
|
|
55
|
+
- What the rest of the process looks like
|
|
56
|
+
|
|
57
|
+
### It Powers Workflows Too
|
|
58
|
+
|
|
59
|
+
MDAN-Help doesn't just answer questions — **it automatically runs at the end of every workflow** to tell you exactly what to do next. No guessing, no searching docs — just clear guidance on the next required workflow.
|
|
60
|
+
|
|
61
|
+
:::tip[Start Here]
|
|
62
|
+
After installing MDAN, run `/mdan-help` immediately. It will detect what modules you have installed and guide you to the right starting point for your project.
|
|
63
|
+
:::
|
|
64
|
+
|
|
65
|
+
## Understanding MDAN
|
|
66
|
+
|
|
67
|
+
MDAN helps you build software through guided workflows with specialized AI agents. The process follows four phases:
|
|
68
|
+
|
|
69
|
+
| Phase | Name | What Happens |
|
|
70
|
+
| ----- | -------------- | --------------------------------------------------- |
|
|
71
|
+
| 1 | Analysis | Brainstorming, research, product brief *(optional)* |
|
|
72
|
+
| 2 | Planning | Create requirements (PRD or tech-spec) |
|
|
73
|
+
| 3 | Solutioning | Design architecture *(MDAN Method/Enterprise only)* |
|
|
74
|
+
| 4 | Implementation | Build epic by epic, story by story |
|
|
75
|
+
|
|
76
|
+
**[Open the Workflow Map](../reference/workflow-map.md)** to explore phases, workflows, and context management.
|
|
77
|
+
|
|
78
|
+
Based on your project's complexity, MDAN offers three planning tracks:
|
|
79
|
+
|
|
80
|
+
| Track | Best For | Documents Created |
|
|
81
|
+
| --------------- | ------------------------------------------------------ | -------------------------------------- |
|
|
82
|
+
| **Quick Flow** | Bug fixes, simple features, clear scope (1-15 stories) | Tech-spec only |
|
|
83
|
+
| **MDAN Method** | Products, platforms, complex features (10-50+ stories) | PRD + Architecture + UX |
|
|
84
|
+
| **Enterprise** | Compliance, multi-tenant systems (30+ stories) | PRD + Architecture + Security + DevOps |
|
|
85
|
+
|
|
86
|
+
:::note
|
|
87
|
+
Story counts are guidance, not definitions. Choose your track based on planning needs, not story math.
|
|
88
|
+
:::
|
|
89
|
+
|
|
90
|
+
## Installation
|
|
91
|
+
|
|
92
|
+
### Install from npm (Recommended)
|
|
93
|
+
|
|
94
|
+
Open a terminal in your project directory and run:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
npx mdan install
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Install from GitHub
|
|
101
|
+
|
|
102
|
+
Alternatively, clone the repository and install:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
git clone https://github.com/khalilbenaz/MDANV2.git
|
|
106
|
+
cd MDANV2
|
|
107
|
+
npm install
|
|
108
|
+
npm link
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
When prompted to select modules, choose **MDAN Method**.
|
|
112
|
+
|
|
113
|
+
The installer creates two folders:
|
|
114
|
+
- `_bmad/` — agents, workflows, tasks, and configuration
|
|
115
|
+
- `_bmad-output/` — empty for now, but this is where your artifacts will be saved
|
|
116
|
+
|
|
117
|
+
:::tip[Your Next Step]
|
|
118
|
+
Open your AI IDE in the project folder and run:
|
|
119
|
+
|
|
120
|
+
```
|
|
121
|
+
/bmad-help
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
BMad-Help will detect what you've completed and recommend exactly what to do next. You can also ask it questions like "What are my options?" or "I have a SaaS idea, where should I start?"
|
|
125
|
+
:::
|
|
126
|
+
|
|
127
|
+
:::note[How to Load Agents and Run Workflows]
|
|
128
|
+
Each workflow has a **slash command** you run in your IDE (e.g., `/bmad-bmm-create-prd`). Running a workflow command automatically loads the appropriate agent — you don't need to load agents separately. You can also load an agent directly for general conversation (e.g., `/bmad-agent-bmm-pm` for the PM agent).
|
|
129
|
+
:::
|
|
130
|
+
|
|
131
|
+
:::caution[Fresh Chats]
|
|
132
|
+
Always start a fresh chat for each workflow. This prevents context limitations from causing issues.
|
|
133
|
+
:::
|
|
134
|
+
|
|
135
|
+
## Step 1: Create Your Plan
|
|
136
|
+
|
|
137
|
+
Work through phases 1-3. **Use fresh chats for each workflow.**
|
|
138
|
+
|
|
139
|
+
:::tip[Project Context (Optional)]
|
|
140
|
+
Before starting, consider creating `project-context.md` to document your technical preferences and implementation rules. This ensures all AI agents follow your conventions throughout the project.
|
|
141
|
+
|
|
142
|
+
Create it manually at `_bmad-output/project-context.md` or generate it after architecture using `/bmad-bmm-generate-project-context`. [Learn more](../explanation/project-context.md).
|
|
143
|
+
:::
|
|
144
|
+
|
|
145
|
+
### Phase 1: Analysis (Optional)
|
|
146
|
+
|
|
147
|
+
All workflows in this phase are optional:
|
|
148
|
+
- **brainstorming** (`/bmad-brainstorming`) — Guided ideation
|
|
149
|
+
- **research** (`/bmad-bmm-research`) — Market and technical research
|
|
150
|
+
- **create-product-brief** (`/bmad-bmm-create-product-brief`) — Recommended foundation document
|
|
151
|
+
|
|
152
|
+
### Phase 2: Planning (Required)
|
|
153
|
+
|
|
154
|
+
**For BMad Method and Enterprise tracks:**
|
|
155
|
+
1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
|
|
156
|
+
2. Run the `prd` workflow (`/bmad-bmm-create-prd`)
|
|
157
|
+
3. Output: `PRD.md`
|
|
158
|
+
|
|
159
|
+
**For Quick Flow track:**
|
|
160
|
+
- Use the `quick-spec` workflow (`/bmad-bmm-quick-spec`) instead of PRD, then skip to implementation
|
|
161
|
+
|
|
162
|
+
:::note[UX Design (Optional)]
|
|
163
|
+
If your project has a user interface, load the **UX-Designer agent** (`/bmad-agent-bmm-ux-designer`) and run the UX design workflow (`/bmad-bmm-create-ux-design`) after creating your PRD.
|
|
164
|
+
:::
|
|
165
|
+
|
|
166
|
+
### Phase 3: Solutioning (BMad Method/Enterprise)
|
|
167
|
+
|
|
168
|
+
**Create Architecture**
|
|
169
|
+
1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
|
|
170
|
+
2. Run `create-architecture` (`/bmad-bmm-create-architecture`)
|
|
171
|
+
3. Output: Architecture document with technical decisions
|
|
172
|
+
|
|
173
|
+
**Create Epics and Stories**
|
|
174
|
+
|
|
175
|
+
:::tip[V6 Improvement]
|
|
176
|
+
Epics and stories are now created *after* architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down.
|
|
177
|
+
:::
|
|
178
|
+
|
|
179
|
+
1. Load the **PM agent** (`/bmad-agent-bmm-pm`) in a new chat
|
|
180
|
+
2. Run `create-epics-and-stories` (`/bmad-bmm-create-epics-and-stories`)
|
|
181
|
+
3. The workflow uses both PRD and Architecture to create technically-informed stories
|
|
182
|
+
|
|
183
|
+
**Implementation Readiness Check** *(Highly Recommended)*
|
|
184
|
+
1. Load the **Architect agent** (`/bmad-agent-bmm-architect`) in a new chat
|
|
185
|
+
2. Run `check-implementation-readiness` (`/bmad-bmm-check-implementation-readiness`)
|
|
186
|
+
3. Validates cohesion across all planning documents
|
|
187
|
+
|
|
188
|
+
## Step 2: Build Your Project
|
|
189
|
+
|
|
190
|
+
Once planning is complete, move to implementation. **Each workflow should run in a fresh chat.**
|
|
191
|
+
|
|
192
|
+
### Initialize Sprint Planning
|
|
193
|
+
|
|
194
|
+
Load the **SM agent** (`/bmad-agent-bmm-sm`) and run `sprint-planning` (`/bmad-bmm-sprint-planning`). This creates `sprint-status.yaml` to track all epics and stories.
|
|
195
|
+
|
|
196
|
+
### The Build Cycle
|
|
197
|
+
|
|
198
|
+
For each story, repeat this cycle with fresh chats:
|
|
199
|
+
|
|
200
|
+
| Step | Agent | Workflow | Command | Purpose |
|
|
201
|
+
| ---- | ----- | -------------- | -------------------------- | ---------------------------------- |
|
|
202
|
+
| 1 | SM | `create-story` | `/bmad-bmm-create-story` | Create story file from epic |
|
|
203
|
+
| 2 | DEV | `dev-story` | `/bmad-bmm-dev-story` | Implement the story |
|
|
204
|
+
| 3 | DEV | `code-review` | `/bmad-bmm-code-review` | Quality validation *(recommended)* |
|
|
205
|
+
|
|
206
|
+
After completing all stories in an epic, load the **SM agent** (`/bmad-agent-bmm-sm`) and run `retrospective` (`/bmad-bmm-retrospective`).
|
|
207
|
+
|
|
208
|
+
## What You've Accomplished
|
|
209
|
+
|
|
210
|
+
You've learned the foundation of building with BMad:
|
|
211
|
+
|
|
212
|
+
- Installed BMad and configured it for your IDE
|
|
213
|
+
- Initialized a project with your chosen planning track
|
|
214
|
+
- Created planning documents (PRD, Architecture, Epics & Stories)
|
|
215
|
+
- Understood the build cycle for implementation
|
|
216
|
+
|
|
217
|
+
Your project now has:
|
|
218
|
+
|
|
219
|
+
```text
|
|
220
|
+
your-project/
|
|
221
|
+
├── _bmad/ # BMad configuration
|
|
222
|
+
├── _bmad-output/
|
|
223
|
+
│ ├── planning-artifacts/
|
|
224
|
+
│ │ ├── PRD.md # Your requirements document
|
|
225
|
+
│ │ ├── architecture.md # Technical decisions
|
|
226
|
+
│ │ └── epics/ # Epic and story files
|
|
227
|
+
│ ├── implementation-artifacts/
|
|
228
|
+
│ │ └── sprint-status.yaml # Sprint tracking
|
|
229
|
+
│ └── project-context.md # Implementation rules (optional)
|
|
230
|
+
└── ...
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
## Quick Reference
|
|
234
|
+
|
|
235
|
+
| Workflow | Command | Agent | Purpose |
|
|
236
|
+
| ------------------------------------- | ------------------------------------------ | --------- | ----------------------------------------------- |
|
|
237
|
+
| **`help`** ⭐ | `/bmad-help` | Any | **Your intelligent guide — ask anything!** |
|
|
238
|
+
| `prd` | `/bmad-bmm-create-prd` | PM | Create Product Requirements Document |
|
|
239
|
+
| `create-architecture` | `/bmad-bmm-create-architecture` | Architect | Create architecture document |
|
|
240
|
+
| `generate-project-context` | `/bmad-bmm-generate-project-context` | Analyst | Create project context file |
|
|
241
|
+
| `create-epics-and-stories` | `/bmad-bmm-create-epics-and-stories` | PM | Break down PRD into epics |
|
|
242
|
+
| `check-implementation-readiness` | `/bmad-bmm-check-implementation-readiness` | Architect | Validate planning cohesion |
|
|
243
|
+
| `sprint-planning` | `/bmad-bmm-sprint-planning` | SM | Initialize sprint tracking |
|
|
244
|
+
| `create-story` | `/bmad-bmm-create-story` | SM | Create a story file |
|
|
245
|
+
| `dev-story` | `/bmad-bmm-dev-story` | DEV | Implement a story |
|
|
246
|
+
| `code-review` | `/bmad-bmm-code-review` | DEV | Review implemented code |
|
|
247
|
+
|
|
248
|
+
## Common Questions
|
|
249
|
+
|
|
250
|
+
**Do I always need architecture?**
|
|
251
|
+
Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation.
|
|
252
|
+
|
|
253
|
+
**Can I change my plan later?**
|
|
254
|
+
Yes. The SM agent has a `correct-course` workflow (`/bmad-bmm-correct-course`) for handling scope changes.
|
|
255
|
+
|
|
256
|
+
**What if I want to brainstorm first?**
|
|
257
|
+
Load the Analyst agent (`/bmad-agent-bmm-analyst`) and run `brainstorming` (`/bmad-brainstorming`) before starting your PRD.
|
|
258
|
+
|
|
259
|
+
**Do I need to follow a strict order?**
|
|
260
|
+
Not strictly. Once you learn the flow, you can run workflows directly using the Quick Reference above.
|
|
261
|
+
|
|
262
|
+
## Getting Help
|
|
263
|
+
|
|
264
|
+
:::tip[First Stop: BMad-Help]
|
|
265
|
+
**Run `/bmad-help` anytime** — it's the fastest way to get unstuck. Ask it anything:
|
|
266
|
+
- "What should I do after installing?"
|
|
267
|
+
- "I'm stuck on workflow X"
|
|
268
|
+
- "What are my options for Y?"
|
|
269
|
+
- "Show me what's been done so far"
|
|
270
|
+
|
|
271
|
+
BMad-Help inspects your project, detects what you've completed, and tells you exactly what to do next.
|
|
272
|
+
:::
|
|
273
|
+
|
|
274
|
+
- **During workflows** — Agents guide you with questions and explanations
|
|
275
|
+
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
|
|
276
|
+
|
|
277
|
+
## Key Takeaways
|
|
278
|
+
|
|
279
|
+
:::tip[Remember These]
|
|
280
|
+
- **Start with `/bmad-help`** — Your intelligent guide that knows your project and options
|
|
281
|
+
- **Always use fresh chats** — Start a new chat for each workflow
|
|
282
|
+
- **Track matters** — Quick Flow uses quick-spec; Method/Enterprise need PRD and architecture
|
|
283
|
+
- **BMad-Help runs automatically** — Every workflow ends with guidance on what's next
|
|
284
|
+
:::
|
|
285
|
+
|
|
286
|
+
Ready to start? Install BMad, run `/bmad-help`, and let your intelligent guide lead the way.
|