bmad-method 5.1.2 → 6.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/FUNDING.yaml +2 -2
- package/.github/ISSUE_TEMPLATE/config.yaml +1 -0
- package/.github/ISSUE_TEMPLATE/idea_submission.md +109 -0
- package/.github/workflows/discord.yaml +1 -10
- package/.github/workflows/format-check.yaml +3 -2
- package/.github/workflows/manual-release.yaml +2 -2
- package/.nvmrc +1 -0
- package/.vscode/settings.json +34 -9
- package/CHANGELOG.md +211 -577
- package/CONTRIBUTING.md +130 -60
- package/LICENSE +6 -1
- package/docs/codebase-flattener.md +19 -0
- package/docs/ide-info/auggie.md +31 -0
- package/docs/ide-info/claude-code.md +25 -0
- package/docs/ide-info/cline.md +31 -0
- package/docs/ide-info/codex.md +32 -0
- package/docs/ide-info/crush.md +30 -0
- package/docs/ide-info/cursor.md +25 -0
- package/docs/ide-info/gemini.md +25 -0
- package/docs/ide-info/github-copilot.md +26 -0
- package/docs/ide-info/iflow.md +33 -0
- package/docs/ide-info/kilo.md +24 -0
- package/docs/ide-info/qwen.md +25 -0
- package/docs/ide-info/roo.md +27 -0
- package/docs/ide-info/trae.md +25 -0
- package/docs/ide-info/windsurf.md +22 -0
- package/docs/installers-bundlers/ide-injections.md +196 -0
- package/docs/installers-bundlers/installers-modules-platforms-reference.md +355 -0
- package/docs/installers-bundlers/web-bundler-usage.md +54 -0
- package/eslint.config.mjs +17 -7
- package/package.json +26 -35
- package/prettier.config.mjs +1 -1
- package/readme.md +216 -0
- package/src/core/_module-installer/install-menu-config.yaml +24 -0
- package/src/core/_module-installer/installer.js +68 -0
- package/src/core/agents/bmad-master.md +27 -0
- package/src/core/agents/bmad-web-orchestrator.md +71 -0
- package/src/core/tasks/adv-elicit-methods.csv +39 -0
- package/src/core/tasks/adv-elicit.md +109 -0
- package/src/core/tasks/index-docs.md +69 -0
- package/src/core/tasks/shard-doc.md +57 -0
- package/src/core/tasks/validate-workflow.md +92 -0
- package/src/core/tasks/workflow.md +141 -0
- package/src/core/workflows/bmad-init/instructions.md +79 -0
- package/src/core/workflows/bmad-init/workflow.yaml +24 -0
- package/src/core/workflows/party-mode/instructions.md +181 -0
- package/src/core/workflows/party-mode/workflow.yaml +24 -0
- package/src/modules/bmb/_module-installer/install-menu-config.yaml +16 -0
- package/src/modules/bmb/agents/bmad-builder.md +30 -0
- package/src/modules/bmb/workflows/convert-legacy/README.md +262 -0
- package/src/modules/bmb/workflows/convert-legacy/checklist.md +204 -0
- package/src/modules/bmb/workflows/convert-legacy/instructions.md +328 -0
- package/src/modules/bmb/workflows/convert-legacy/workflow.yaml +35 -0
- package/src/modules/bmb/workflows/create-agent/README.md +268 -0
- package/src/modules/bmb/workflows/create-agent/agent-architecture.md +412 -0
- package/src/modules/bmb/workflows/create-agent/agent-command-patterns.md +757 -0
- package/src/modules/bmb/workflows/create-agent/agent-types.md +177 -0
- package/src/modules/bmb/workflows/create-agent/brainstorm-context.md +174 -0
- package/src/modules/bmb/workflows/create-agent/checklist.md +134 -0
- package/src/modules/bmb/workflows/create-agent/communication-styles.md +240 -0
- package/src/modules/bmb/workflows/create-agent/instructions.md +340 -0
- package/src/modules/bmb/workflows/create-agent/workflow.yaml +39 -0
- package/src/modules/bmb/workflows/create-module/README.md +218 -0
- package/src/modules/bmb/workflows/create-module/brainstorm-context.md +137 -0
- package/src/modules/bmb/workflows/create-module/checklist.md +245 -0
- package/src/modules/bmb/workflows/create-module/installer-templates/install-module-config.yaml +132 -0
- package/src/modules/bmb/workflows/create-module/installer-templates/installer.js +231 -0
- package/src/modules/bmb/workflows/create-module/instructions.md +509 -0
- package/src/modules/bmb/workflows/create-module/module-structure.md +310 -0
- package/src/modules/bmb/workflows/create-module/workflow.yaml +47 -0
- package/src/modules/bmb/workflows/create-workflow/README.md +216 -0
- package/src/modules/bmb/workflows/create-workflow/brainstorm-context.md +197 -0
- package/src/modules/bmb/workflows/create-workflow/checklist.md +72 -0
- package/src/modules/bmb/workflows/create-workflow/instructions.md +267 -0
- package/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md +456 -0
- package/src/modules/bmb/workflows/create-workflow/workflow-template/checklist.md +24 -0
- package/src/modules/bmb/workflows/create-workflow/workflow-template/instructions.md +12 -0
- package/src/modules/bmb/workflows/create-workflow/workflow-template/template.md +9 -0
- package/src/modules/bmb/workflows/create-workflow/workflow-template/workflow.yaml +35 -0
- package/src/modules/bmb/workflows/create-workflow/workflow.yaml +42 -0
- package/src/modules/bmb/workflows/edit-workflow/README.md +63 -0
- package/src/modules/bmb/workflows/edit-workflow/checklist.md +70 -0
- package/src/modules/bmb/workflows/edit-workflow/instructions.md +170 -0
- package/src/modules/bmb/workflows/edit-workflow/workflow.yaml +34 -0
- package/src/modules/bmb/workflows/module-brief/README.md +264 -0
- package/src/modules/bmb/workflows/module-brief/checklist.md +116 -0
- package/src/modules/bmb/workflows/module-brief/instructions.md +265 -0
- package/src/modules/bmb/workflows/module-brief/template.md +275 -0
- package/src/modules/bmb/workflows/module-brief/workflow.yaml +30 -0
- package/src/modules/bmb/workflows/redoc/README.md +87 -0
- package/src/modules/bmb/workflows/redoc/checklist.md +99 -0
- package/src/modules/bmb/workflows/redoc/instructions.md +255 -0
- package/src/modules/bmb/workflows/redoc/workflow.yaml +33 -0
- package/src/modules/bmm/_module-installer/assets/bmm-kb.md +1 -0
- package/src/modules/bmm/_module-installer/assets/technical-decisions-template.md +30 -0
- package/src/modules/bmm/_module-installer/install-menu-config.yaml +49 -0
- package/src/modules/bmm/_module-installer/installer.js +131 -0
- package/src/modules/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
- package/src/modules/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
- package/src/modules/bmm/agents/analyst.md +26 -0
- package/src/modules/bmm/agents/architect.md +29 -0
- package/src/modules/bmm/agents/dev.md +61 -0
- package/src/modules/bmm/agents/game-architect.md +26 -0
- package/src/modules/bmm/agents/game-designer.md +27 -0
- package/src/modules/bmm/agents/game-dev.md +28 -0
- package/src/modules/bmm/agents/pm.md +26 -0
- package/src/modules/bmm/agents/po.md +25 -0
- package/src/modules/bmm/agents/sm.md +29 -0
- package/src/modules/bmm/agents/tea.md +32 -0
- package/src/modules/bmm/agents/ux-expert.md +24 -0
- package/src/modules/bmm/sub-modules/claude-code/config.yaml +5 -0
- package/src/modules/bmm/sub-modules/claude-code/injections.yaml +242 -0
- package/src/modules/bmm/sub-modules/claude-code/readme.md +87 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/api-documenter.md +85 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/codebase-analyzer.md +64 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/data-analyst.md +84 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/dependency-mapper.md +67 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/document-reviewer.md +85 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/epic-optimizer.md +66 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/market-researcher.md +34 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/pattern-detector.md +67 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/requirements-analyst.md +61 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/tech-debt-auditor.md +89 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-decisions-curator.md +146 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/technical-evaluator.md +51 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/test-coverage-analyzer.md +91 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/trend-spotter.md +99 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-journey-mapper.md +101 -0
- package/src/modules/bmm/sub-modules/claude-code/sub-agents/user-researcher.md +56 -0
- package/src/modules/bmm/tasks/daily-standup.md +91 -0
- package/src/modules/bmm/tasks/retrospective.md +110 -0
- package/src/modules/bmm/teams/team-all.yaml +7 -0
- package/src/modules/bmm/teams/team-dev.yaml +14 -0
- package/src/modules/bmm/teams/team-gamedev.yaml +9 -0
- package/src/modules/bmm/testarch/atdd.md +40 -0
- package/src/modules/bmm/testarch/automate.md +38 -0
- package/src/modules/bmm/testarch/ci.md +39 -0
- package/src/modules/bmm/testarch/framework.md +41 -0
- package/src/modules/bmm/testarch/nfr-assess.md +38 -0
- package/src/modules/bmm/testarch/risk-profile.md +38 -0
- package/src/modules/bmm/testarch/tea-commands.csv +11 -0
- package/src/modules/bmm/testarch/tea-gate.md +38 -0
- package/src/modules/bmm/testarch/tea-knowledge.md +275 -0
- package/src/modules/bmm/testarch/test-design.md +39 -0
- package/{bmad-core/data → src/modules/bmm/testarch}/test-levels-framework.md +2 -0
- package/{bmad-core/data → src/modules/bmm/testarch}/test-priorities-matrix.md +2 -0
- package/src/modules/bmm/testarch/trace-requirements.md +38 -0
- package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-brain-methods.csv +26 -0
- package/src/modules/bmm/workflows/1-analysis/brainstorm-game/game-context.md +115 -0
- package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +47 -0
- package/src/modules/bmm/workflows/1-analysis/brainstorm-game/workflow.yaml +22 -0
- package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +38 -0
- package/src/modules/bmm/workflows/1-analysis/brainstorm-project/project-context.md +25 -0
- package/src/modules/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml +21 -0
- package/src/modules/bmm/workflows/1-analysis/game-brief/README.md +221 -0
- package/src/modules/bmm/workflows/1-analysis/game-brief/checklist.md +128 -0
- package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +517 -0
- package/src/modules/bmm/workflows/1-analysis/game-brief/template.md +205 -0
- package/src/modules/bmm/workflows/1-analysis/game-brief/workflow.yaml +34 -0
- package/src/modules/bmm/workflows/1-analysis/product-brief/README.md +180 -0
- package/src/modules/bmm/workflows/1-analysis/product-brief/checklist.md +115 -0
- package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +353 -0
- package/src/modules/bmm/workflows/1-analysis/product-brief/template.md +165 -0
- package/src/modules/bmm/workflows/1-analysis/product-brief/workflow.yaml +33 -0
- package/src/modules/bmm/workflows/1-analysis/research/README.md +454 -0
- package/src/modules/bmm/workflows/1-analysis/research/checklist.md +202 -0
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/injections.yaml +114 -0
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-competitor-analyzer.md +259 -0
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-data-analyst.md +190 -0
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-market-researcher.md +337 -0
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-trend-spotter.md +107 -0
- package/src/modules/bmm/workflows/1-analysis/research/claude-code/sub-agents/bmm-user-researcher.md +329 -0
- package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +370 -0
- package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +553 -0
- package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +91 -0
- package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +442 -0
- package/src/modules/bmm/workflows/1-analysis/research/template-deep-prompt.md +94 -0
- package/src/modules/bmm/workflows/1-analysis/research/template-market.md +311 -0
- package/src/modules/bmm/workflows/1-analysis/research/template-technical.md +210 -0
- package/src/modules/bmm/workflows/1-analysis/research/workflow.yaml +149 -0
- package/src/modules/bmm/workflows/2-plan/README.md +203 -0
- package/src/modules/bmm/workflows/2-plan/checklist.md +369 -0
- package/src/modules/bmm/workflows/2-plan/gdd/README.md +222 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/action-platformer.md +45 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/adventure.md +84 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/card-game.md +76 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/fighting.md +89 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/horror.md +86 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/idle-incremental.md +78 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/metroidvania.md +87 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/moba.md +74 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/party-game.md +79 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/puzzle.md +58 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/racing.md +88 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/rhythm.md +79 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/roguelike.md +69 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/rpg.md +70 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/sandbox.md +79 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/shooter.md +62 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/simulation.md +73 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/sports.md +75 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/strategy.md +71 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/survival.md +79 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/text-based.md +91 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/tower-defense.md +79 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/turn-based-tactics.md +88 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types/visual-novel.md +89 -0
- package/src/modules/bmm/workflows/2-plan/gdd/game-types.csv +25 -0
- package/src/modules/bmm/workflows/2-plan/gdd/gdd-template.md +159 -0
- package/src/modules/bmm/workflows/2-plan/gdd/instructions-gdd.md +480 -0
- package/src/modules/bmm/workflows/2-plan/instructions-router.md +222 -0
- package/src/modules/bmm/workflows/2-plan/narrative/instructions-narrative.md +517 -0
- package/src/modules/bmm/workflows/2-plan/narrative/narrative-template.md +195 -0
- package/src/modules/bmm/workflows/2-plan/prd/analysis-template.md +53 -0
- package/src/modules/bmm/workflows/2-plan/prd/epics-template.md +18 -0
- package/src/modules/bmm/workflows/2-plan/prd/instructions-lg.md +267 -0
- package/src/modules/bmm/workflows/2-plan/prd/instructions-med.md +251 -0
- package/src/modules/bmm/workflows/2-plan/prd/prd-template.md +73 -0
- package/src/modules/bmm/workflows/2-plan/tech-spec/instructions-sm.md +137 -0
- package/src/modules/bmm/workflows/2-plan/tech-spec/tech-spec-template.md +59 -0
- package/src/modules/bmm/workflows/2-plan/ux/instructions-ux.md +360 -0
- package/src/modules/bmm/workflows/2-plan/ux/ux-spec-template.md +162 -0
- package/src/modules/bmm/workflows/2-plan/workflow.yaml +60 -0
- package/src/modules/bmm/workflows/3-solutioning/ADR-template.md +74 -0
- package/src/modules/bmm/workflows/3-solutioning/README.md +565 -0
- package/src/modules/bmm/workflows/3-solutioning/checklist.md +170 -0
- package/src/modules/bmm/workflows/3-solutioning/instructions.md +661 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/backend-questions.md +490 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/cli-questions.md +337 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/data-questions.md +472 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/desktop-questions.md +299 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/embedded-questions.md +118 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/extension-questions.md +374 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/game-questions.md +133 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/infra-questions.md +484 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/library-questions.md +146 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/mobile-questions.md +110 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/project-types.csv +12 -0
- package/src/modules/bmm/workflows/3-solutioning/project-types/web-questions.md +136 -0
- package/src/modules/bmm/workflows/3-solutioning/tech-spec/README.md +195 -0
- package/src/modules/bmm/workflows/3-solutioning/tech-spec/checklist.md +17 -0
- package/src/modules/bmm/workflows/3-solutioning/tech-spec/instructions.md +73 -0
- package/src/modules/bmm/workflows/3-solutioning/tech-spec/template.md +76 -0
- package/src/modules/bmm/workflows/3-solutioning/tech-spec/workflow.yaml +51 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/backend-service-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/cli-tool-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/data-pipeline-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/desktop-app-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/embedded-firmware-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-architecture.md +244 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-godot-guide.md +428 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-unity-guide.md +333 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/game-engine-web-guide.md +528 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/infrastructure-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/library-package-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/mobile-app-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/registry.csv +172 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/web-api-architecture.md +66 -0
- package/src/modules/bmm/workflows/3-solutioning/templates/web-fullstack-architecture.md +277 -0
- package/src/modules/bmm/workflows/3-solutioning/workflow.yaml +65 -0
- package/src/modules/bmm/workflows/4-implementation/correct-course/checklist.md +279 -0
- package/src/modules/bmm/workflows/4-implementation/correct-course/instructions.md +190 -0
- package/src/modules/bmm/workflows/4-implementation/correct-course/workflow.yaml +35 -0
- package/src/modules/bmm/workflows/4-implementation/create-story/README.md +42 -0
- package/src/modules/bmm/workflows/4-implementation/create-story/checklist.md +39 -0
- package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +81 -0
- package/src/modules/bmm/workflows/4-implementation/create-story/template.md +57 -0
- package/src/modules/bmm/workflows/4-implementation/create-story/workflow.yaml +72 -0
- package/src/modules/bmm/workflows/4-implementation/dev-story/README.md +84 -0
- package/src/modules/bmm/workflows/4-implementation/dev-story/checklist.md +38 -0
- package/src/modules/bmm/workflows/4-implementation/dev-story/instructions.md +87 -0
- package/src/modules/bmm/workflows/4-implementation/dev-story/workflow.yaml +53 -0
- package/src/modules/bmm/workflows/4-implementation/retrospective/instructions.md +391 -0
- package/src/modules/bmm/workflows/4-implementation/retrospective/workflow.yaml +41 -0
- package/src/modules/bmm/workflows/4-implementation/review-story/README.md +72 -0
- package/src/modules/bmm/workflows/4-implementation/review-story/backlog_template.md +12 -0
- package/src/modules/bmm/workflows/4-implementation/review-story/checklist.md +22 -0
- package/src/modules/bmm/workflows/4-implementation/review-story/instructions.md +176 -0
- package/src/modules/bmm/workflows/4-implementation/review-story/workflow.yaml +99 -0
- package/src/modules/bmm/workflows/4-implementation/story-context/README.md +234 -0
- package/src/modules/bmm/workflows/4-implementation/story-context/checklist.md +16 -0
- package/src/modules/bmm/workflows/4-implementation/story-context/context-template.xml +34 -0
- package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +76 -0
- package/src/modules/bmm/workflows/4-implementation/story-context/workflow.yaml +56 -0
- package/src/modules/cis/_module-installer/install-menu-config.yaml +14 -0
- package/src/modules/cis/_module-installer/installer.js +92 -0
- package/src/modules/cis/agents/README.md +104 -0
- package/src/modules/cis/agents/brainstorming-coach.md +24 -0
- package/src/modules/cis/agents/creative-problem-solver.md +24 -0
- package/src/modules/cis/agents/design-thinking-coach.md +24 -0
- package/src/modules/cis/agents/innovation-strategist.md +24 -0
- package/src/modules/cis/agents/storyteller.md +24 -0
- package/src/modules/cis/readme.md +86 -0
- package/src/modules/cis/teams/creative-squad.yaml +6 -0
- package/src/modules/cis/workflows/README.md +67 -0
- package/src/modules/cis/workflows/brainstorming/README.md +271 -0
- package/src/modules/cis/workflows/brainstorming/brain-methods.csv +36 -0
- package/src/modules/cis/workflows/brainstorming/instructions.md +310 -0
- package/src/modules/cis/workflows/brainstorming/template.md +102 -0
- package/src/modules/cis/workflows/brainstorming/workflow.yaml +30 -0
- package/src/modules/cis/workflows/design-thinking/README.md +56 -0
- package/src/modules/cis/workflows/design-thinking/design-methods.csv +31 -0
- package/src/modules/cis/workflows/design-thinking/instructions.md +200 -0
- package/src/modules/cis/workflows/design-thinking/template.md +111 -0
- package/src/modules/cis/workflows/design-thinking/workflow.yaml +29 -0
- package/src/modules/cis/workflows/innovation-strategy/README.md +56 -0
- package/src/modules/cis/workflows/innovation-strategy/innovation-frameworks.csv +31 -0
- package/src/modules/cis/workflows/innovation-strategy/instructions.md +274 -0
- package/src/modules/cis/workflows/innovation-strategy/template.md +189 -0
- package/src/modules/cis/workflows/innovation-strategy/workflow.yaml +29 -0
- package/src/modules/cis/workflows/problem-solving/README.md +56 -0
- package/src/modules/cis/workflows/problem-solving/instructions.md +250 -0
- package/src/modules/cis/workflows/problem-solving/solving-methods.csv +31 -0
- package/src/modules/cis/workflows/problem-solving/template.md +165 -0
- package/src/modules/cis/workflows/problem-solving/workflow.yaml +29 -0
- package/src/modules/cis/workflows/storytelling/README.md +58 -0
- package/src/modules/cis/workflows/storytelling/instructions.md +275 -0
- package/src/modules/cis/workflows/storytelling/story-types.csv +26 -0
- package/src/modules/cis/workflows/storytelling/template.md +113 -0
- package/src/modules/cis/workflows/storytelling/workflow.yaml +29 -0
- package/src/utility/models/agent-activation-ide.xml +51 -0
- package/src/utility/models/agent-config-template.md +23 -0
- package/tools/cli/bmad-cli.js +42 -0
- package/tools/cli/bundlers/bundle-web.js +157 -0
- package/tools/cli/bundlers/test-analyst.js +28 -0
- package/tools/cli/bundlers/test-bundler.js +118 -0
- package/tools/cli/bundlers/web-bundler.js +880 -0
- package/tools/cli/commands/install.js +41 -0
- package/tools/cli/commands/list.js +28 -0
- package/tools/cli/commands/status.js +47 -0
- package/tools/cli/commands/uninstall.js +44 -0
- package/tools/cli/commands/update.js +28 -0
- package/tools/cli/installers/lib/core/config-collector.js +383 -0
- package/tools/cli/installers/lib/core/dependency-resolver.js +721 -0
- package/tools/cli/installers/lib/core/detector.js +208 -0
- package/tools/cli/installers/lib/core/installer.js +1070 -0
- package/tools/cli/installers/lib/core/manifest-generator.js +385 -0
- package/tools/cli/installers/lib/core/manifest.js +484 -0
- package/tools/cli/installers/lib/ide/_base-ide.js +281 -0
- package/tools/cli/installers/lib/ide/auggie.js +271 -0
- package/tools/cli/installers/lib/ide/claude-code.js +625 -0
- package/tools/cli/installers/lib/ide/cline.js +301 -0
- package/tools/cli/installers/lib/ide/codex.js +267 -0
- package/tools/cli/installers/lib/ide/crush.js +204 -0
- package/tools/cli/installers/lib/ide/cursor.js +224 -0
- package/tools/cli/installers/lib/ide/gemini.js +160 -0
- package/tools/cli/installers/lib/ide/github-copilot.js +289 -0
- package/tools/cli/installers/lib/ide/iflow.js +142 -0
- package/tools/cli/installers/lib/ide/kilo.js +171 -0
- package/tools/cli/installers/lib/ide/manager.js +203 -0
- package/tools/cli/installers/lib/ide/qwen.js +188 -0
- package/tools/cli/installers/lib/ide/roo.js +288 -0
- package/tools/cli/installers/lib/ide/trae.js +182 -0
- package/tools/cli/installers/lib/ide/windsurf.js +149 -0
- package/tools/cli/installers/lib/ide/workflow-command-generator.js +162 -0
- package/tools/cli/installers/lib/ide/workflow-command-template.md +11 -0
- package/tools/cli/installers/lib/modules/manager.js +452 -0
- package/tools/cli/lib/agent-party-generator.js +206 -0
- package/tools/cli/lib/cli-utils.js +208 -0
- package/tools/cli/lib/config.js +210 -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 +71 -0
- package/tools/cli/lib/replace-project-root.js +239 -0
- package/tools/cli/lib/ui.js +516 -0
- package/tools/cli/lib/xml-handler.js +183 -0
- package/tools/cli/lib/xml-to-markdown.js +82 -0
- package/tools/{yaml-format.js → cli/lib/yaml-format.js} +3 -10
- package/tools/cli/regenerate-manifests.js +28 -0
- package/tools/flattener/ignoreRules.js +2 -6
- package/tools/flattener/main.js +31 -121
- package/tools/flattener/projectRoot.js +3 -8
- package/tools/flattener/stats.helpers.js +8 -35
- package/tools/flattener/stats.js +1 -6
- package/tools/flattener/test-matrix.js +1 -5
- package/tools/platform-codes.yaml +127 -0
- package/tools/test-agents/captain-kirk-commander.md +110 -0
- package/tools/test-agents/data-operations-android.md +123 -0
- package/tools/test-agents/geordi-chief-engineer.md +135 -0
- package/tools/test-agents/isabella-martinez-ethicist.md +109 -0
- package/tools/test-agents/marcus-thompson-security.md +109 -0
- package/tools/test-agents/maya-patel-pragmatist.md +82 -0
- package/tools/test-agents/picard-diplomat-captain.md +134 -0
- package/tools/test-agents/spock-science-officer.md +124 -0
- package/tools/test-agents/william-smithers-technocrat.md +71 -0
- package/tools/test-agents/zara-chen-designer.md +94 -0
- package/tools/validate-bundles.js +87 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
- package/README.md +0 -221
- package/bmad-core/agent-teams/team-all.yaml +0 -14
- package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
- package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
- package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
- package/bmad-core/agents/analyst.md +0 -81
- package/bmad-core/agents/architect.md +0 -83
- package/bmad-core/agents/bmad-master.md +0 -107
- package/bmad-core/agents/bmad-orchestrator.md +0 -149
- package/bmad-core/agents/dev.md +0 -75
- package/bmad-core/agents/pm.md +0 -81
- package/bmad-core/agents/po.md +0 -76
- package/bmad-core/agents/qa.md +0 -88
- package/bmad-core/agents/sm.md +0 -62
- package/bmad-core/agents/ux-expert.md +0 -66
- package/bmad-core/checklists/architect-checklist.md +0 -438
- package/bmad-core/checklists/change-checklist.md +0 -182
- package/bmad-core/checklists/pm-checklist.md +0 -370
- package/bmad-core/checklists/po-master-checklist.md +0 -432
- package/bmad-core/checklists/story-dod-checklist.md +0 -94
- package/bmad-core/checklists/story-draft-checklist.md +0 -153
- package/bmad-core/core-config.yaml +0 -20
- package/bmad-core/data/bmad-kb.md +0 -806
- package/bmad-core/data/brainstorming-techniques.md +0 -36
- package/bmad-core/data/elicitation-methods.md +0 -154
- package/bmad-core/data/technical-preferences.md +0 -3
- package/bmad-core/tasks/advanced-elicitation.md +0 -117
- package/bmad-core/tasks/brownfield-create-epic.md +0 -160
- package/bmad-core/tasks/brownfield-create-story.md +0 -147
- package/bmad-core/tasks/correct-course.md +0 -70
- package/bmad-core/tasks/create-brownfield-story.md +0 -312
- package/bmad-core/tasks/create-deep-research-prompt.md +0 -278
- package/bmad-core/tasks/create-next-story.md +0 -112
- package/bmad-core/tasks/document-project.md +0 -343
- package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
- package/bmad-core/tasks/index-docs.md +0 -173
- package/bmad-core/tasks/kb-mode-interaction.md +0 -75
- package/bmad-core/tasks/nfr-assess.md +0 -343
- package/bmad-core/tasks/qa-gate.md +0 -159
- package/bmad-core/tasks/review-story.md +0 -314
- package/bmad-core/tasks/risk-profile.md +0 -353
- package/bmad-core/tasks/shard-doc.md +0 -185
- package/bmad-core/tasks/test-design.md +0 -174
- package/bmad-core/tasks/trace-requirements.md +0 -264
- package/bmad-core/tasks/validate-next-story.md +0 -134
- package/bmad-core/templates/architecture-tmpl.yaml +0 -650
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -306
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -218
- package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -823
- package/bmad-core/templates/market-research-tmpl.yaml +0 -252
- package/bmad-core/templates/prd-tmpl.yaml +0 -202
- package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
- package/bmad-core/templates/qa-gate-tmpl.yaml +0 -102
- package/bmad-core/templates/story-tmpl.yaml +0 -137
- package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
- package/bmad-core/workflows/brownfield-service.yaml +0 -187
- package/bmad-core/workflows/brownfield-ui.yaml +0 -197
- package/bmad-core/workflows/greenfield-fullstack.yaml +0 -240
- package/bmad-core/workflows/greenfield-service.yaml +0 -206
- package/bmad-core/workflows/greenfield-ui.yaml +0 -235
- package/common/tasks/create-doc.md +0 -101
- package/common/tasks/execute-checklist.md +0 -86
- package/common/utils/bmad-doc-template.md +0 -325
- package/common/utils/workflow-management.md +0 -69
- package/dist/agents/analyst.txt +0 -2889
- package/dist/agents/architect.txt +0 -3552
- package/dist/agents/bmad-master.txt +0 -8769
- package/dist/agents/bmad-orchestrator.txt +0 -1513
- package/dist/agents/dev.txt +0 -414
- package/dist/agents/pm.txt +0 -2204
- package/dist/agents/po.txt +0 -1346
- package/dist/agents/qa.txt +0 -1987
- package/dist/agents/sm.txt +0 -658
- package/dist/agents/ux-expert.txt +0 -694
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2371
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1620
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -815
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -10952
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +0 -4012
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +0 -3698
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +0 -450
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +0 -973
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +0 -15376
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2075
- package/dist/teams/team-all.txt +0 -12682
- package/dist/teams/team-fullstack.txt +0 -10421
- package/dist/teams/team-ide-minimal.txt +0 -5103
- package/dist/teams/team-no-ui.txt +0 -8980
- package/docs/GUIDING-PRINCIPLES.md +0 -91
- package/docs/core-architecture.md +0 -219
- package/docs/enhanced-ide-development-workflow.md +0 -248
- package/docs/expansion-packs.md +0 -280
- package/docs/how-to-contribute-with-pull-requests.md +0 -158
- package/docs/user-guide.md +0 -504
- package/docs/versioning-and-releases.md +0 -147
- package/docs/versions.md +0 -48
- package/docs/working-in-the-brownfield.md +0 -597
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +0 -102
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash copy.txt +0 -13
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.1 Google Cloud Project Setup/1.1.1 - Initial Project Configuration - bash.txt +0 -13
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.2 Agent Development Kit Installation/1.2.2 - Basic Project Structure - txt.txt +0 -25
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.1 - settings.py +0 -34
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.3 Core Configuration Files/1.3.2 - main.py - Base Application.py +0 -70
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.4 Deployment Configuration/1.4.2 - cloudbuild.yaml +0 -26
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +0 -109
- package/expansion-packs/README.md +0 -3
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -71
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -78
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -64
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -8
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -250
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -647
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -110
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -290
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
- package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +0 -14
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +0 -80
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +0 -77
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +0 -78
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +0 -65
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +0 -391
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +0 -203
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +0 -201
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +0 -124
- package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +0 -6
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +0 -769
- package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +0 -586
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +0 -110
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +0 -141
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +0 -184
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +0 -290
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +0 -200
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +0 -1030
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +0 -356
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +0 -705
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +0 -256
- package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +0 -183
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +0 -175
- package/expansion-packs/bmad-infrastructure-devops/README.md +0 -147
- package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +0 -71
- package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +0 -484
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -9
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -305
- package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +0 -159
- package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +0 -153
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
- package/release_notes.md +0 -32
- package/tools/bmad-npx-wrapper.js +0 -39
- package/tools/builders/web-builder.js +0 -675
- package/tools/bump-all-versions.js +0 -115
- package/tools/bump-expansion-version.js +0 -90
- package/tools/cli.js +0 -152
- package/tools/installer/README.md +0 -8
- package/tools/installer/bin/bmad.js +0 -585
- package/tools/installer/config/ide-agent-config.yaml +0 -58
- package/tools/installer/config/install.config.yaml +0 -123
- package/tools/installer/lib/config-loader.js +0 -257
- package/tools/installer/lib/file-manager.js +0 -389
- package/tools/installer/lib/ide-base-setup.js +0 -228
- package/tools/installer/lib/ide-setup.js +0 -1441
- package/tools/installer/lib/installer.js +0 -1995
- package/tools/installer/lib/memory-profiler.js +0 -225
- package/tools/installer/lib/module-manager.js +0 -114
- package/tools/installer/lib/resource-locator.js +0 -308
- package/tools/installer/package.json +0 -44
- package/tools/lib/dependency-resolver.js +0 -175
- package/tools/lib/yaml-utils.js +0 -29
- package/tools/md-assets/web-agent-startup-instructions.md +0 -39
- package/tools/preview-release-notes.js +0 -66
- package/tools/shared/bannerArt.js +0 -105
- package/tools/sync-installer-version.js +0 -32
- package/tools/update-expansion-version.js +0 -53
- package/tools/upgraders/v3-to-v4-upgrader.js +0 -672
- package/tools/version-bump.js +0 -94
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# ReDoc Workflow Validation Checklist
|
|
2
|
+
|
|
3
|
+
## Initialization & Setup
|
|
4
|
+
|
|
5
|
+
- [ ] All BMAD convention documents loaded and understood
|
|
6
|
+
- [ ] Target path validated and exists
|
|
7
|
+
- [ ] Target type correctly identified (module/workflow/agent/folder)
|
|
8
|
+
- [ ] Documentation execution plan created with reverse-tree order
|
|
9
|
+
|
|
10
|
+
## File Analysis
|
|
11
|
+
|
|
12
|
+
- [ ] All files in target scope read completely (no offset/limit usage)
|
|
13
|
+
- [ ] Existing README.md files detected and last-redoc-date parsed
|
|
14
|
+
- [ ] Massive folders (>10 items) identified for catalog document creation
|
|
15
|
+
- [ ] Documentation depth levels calculated correctly
|
|
16
|
+
|
|
17
|
+
## Leaf-Level Documentation (Workflows)
|
|
18
|
+
|
|
19
|
+
- [ ] Each workflow's ALL files read: workflow.yaml, instructions.md, template.md, checklist.md
|
|
20
|
+
- [ ] README.md includes frontmatter with current last-redoc-date
|
|
21
|
+
- [ ] Description is 2-4 paragraphs of technical writer quality
|
|
22
|
+
- [ ] Focuses on DISTINCTIVE features, not BMAD boilerplate conventions
|
|
23
|
+
- [ ] Includes "Usage" section with invocation command
|
|
24
|
+
- [ ] Includes "Inputs" and "Outputs" sections where applicable
|
|
25
|
+
- [ ] Succinct and precise language used throughout
|
|
26
|
+
|
|
27
|
+
## Leaf-Level Documentation (Agents)
|
|
28
|
+
|
|
29
|
+
- [ ] Each agent file read completely including XML structure, commands, persona
|
|
30
|
+
- [ ] README.md includes frontmatter with current last-redoc-date
|
|
31
|
+
- [ ] Description is 1-3 paragraphs of technical writer quality
|
|
32
|
+
- [ ] Lists all available commands clearly
|
|
33
|
+
- [ ] Explains when to use this agent
|
|
34
|
+
- [ ] Highlights unique capabilities vs standard agent patterns
|
|
35
|
+
|
|
36
|
+
## Mid-Level Documentation (Folders)
|
|
37
|
+
|
|
38
|
+
- [ ] All child README.md files read before generating folder README
|
|
39
|
+
- [ ] Workflows categorized logically if massive folder (>10 items)
|
|
40
|
+
- [ ] Agents categorized by type if massive folder (>10 items)
|
|
41
|
+
- [ ] Catalog documents (WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md) created for massive folders
|
|
42
|
+
- [ ] Catalog documents include frontmatter with last-redoc-date
|
|
43
|
+
- [ ] Folder README.md references catalog if one exists
|
|
44
|
+
- [ ] Folder README.md is succinct (1-2 paragraphs + listings/links)
|
|
45
|
+
- [ ] Notable/commonly-used items highlighted
|
|
46
|
+
|
|
47
|
+
## Root Module Documentation
|
|
48
|
+
|
|
49
|
+
- [ ] Module config.yaml read and understood
|
|
50
|
+
- [ ] Workflows and agents folder READMEs read before creating root README
|
|
51
|
+
- [ ] Root README includes frontmatter with current last-redoc-date
|
|
52
|
+
- [ ] Module purpose clearly stated in 2-3 sentences
|
|
53
|
+
- [ ] Links to /workflows/README.md and /agents/README.md included
|
|
54
|
+
- [ ] 2-3 key workflows mentioned with context
|
|
55
|
+
- [ ] 2-3 key agents mentioned with context
|
|
56
|
+
- [ ] Configuration section highlights UNIQUE settings only
|
|
57
|
+
- [ ] Usage section explains invocation patterns
|
|
58
|
+
- [ ] BMAD convention knowledge applied (describes only distinctive aspects)
|
|
59
|
+
|
|
60
|
+
## Quality Standards
|
|
61
|
+
|
|
62
|
+
- [ ] All documentation uses proper BMAD terminology
|
|
63
|
+
- [ ] Technical writer quality: clear, concise, professional
|
|
64
|
+
- [ ] No placeholder text or generic descriptions remain
|
|
65
|
+
- [ ] All links are valid and correctly formatted
|
|
66
|
+
- [ ] Frontmatter syntax is correct and dates are current
|
|
67
|
+
- [ ] No redundant explanation of standard BMAD patterns
|
|
68
|
+
|
|
69
|
+
## Validation & Reporting
|
|
70
|
+
|
|
71
|
+
- [ ] All planned documentation items created/updated
|
|
72
|
+
- [ ] Frontmatter dates verified as current across all files
|
|
73
|
+
- [ ] File paths and internal links validated
|
|
74
|
+
- [ ] Summary report generated with counts and coverage
|
|
75
|
+
- [ ] Files skipped (if any) documented with reasons
|
|
76
|
+
|
|
77
|
+
## Git Diff Analysis (Optional Step)
|
|
78
|
+
|
|
79
|
+
- [ ] last-redoc-date timestamps extracted correctly
|
|
80
|
+
- [ ] Git log queried for changes since last redoc
|
|
81
|
+
- [ ] Modified files identified and reported
|
|
82
|
+
- [ ] Findings presented clearly to user
|
|
83
|
+
|
|
84
|
+
## Final Validation
|
|
85
|
+
|
|
86
|
+
- [ ] Documentation Coverage
|
|
87
|
+
- All README.md files in scope created/updated
|
|
88
|
+
- Catalog documents created where needed
|
|
89
|
+
- No documentation gaps identified
|
|
90
|
+
|
|
91
|
+
- [ ] Execution Quality
|
|
92
|
+
- Reverse-tree order followed (leaf → root)
|
|
93
|
+
- Autonomous execution (minimal user prompts)
|
|
94
|
+
- Only clarification questions asked when truly necessary
|
|
95
|
+
|
|
96
|
+
- [ ] Output Quality
|
|
97
|
+
- Technical precision maintained throughout
|
|
98
|
+
- Succinct descriptions (no verbose explanations)
|
|
99
|
+
- Professional documentation standards met
|
|
@@ -0,0 +1,255 @@
|
|
|
1
|
+
# ReDoc Workflow Instructions
|
|
2
|
+
|
|
3
|
+
<workflow>
|
|
4
|
+
|
|
5
|
+
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
|
|
6
|
+
<critical>You MUST have already loaded and processed: {project_root}/src/modules/bmb/workflows/redoc/workflow.yaml</critical>
|
|
7
|
+
<critical>This is an AUTONOMOUS workflow - minimize user interaction unless clarification is absolutely required</critical>
|
|
8
|
+
|
|
9
|
+
<step n="1" goal="Load BMAD conventions and initialize">
|
|
10
|
+
<action>Load ALL BMAD convention documents from {bmad_conventions}:
|
|
11
|
+
- agent_architecture.md - Understand agent XML structure and patterns
|
|
12
|
+
- agent_command_patterns.md - Command syntax and activation patterns
|
|
13
|
+
- agent_types.md - Standard agent categories and purposes
|
|
14
|
+
- module_structure.md - Module organization and folder conventions
|
|
15
|
+
- workflow_guide.md - Workflow structure and best practices
|
|
16
|
+
</action>
|
|
17
|
+
|
|
18
|
+
<action>Internalize these conventions so you can:
|
|
19
|
+
|
|
20
|
+
- Recognize standard patterns vs unique implementations
|
|
21
|
+
- Describe only what's distinctive about each component
|
|
22
|
+
- Use proper terminology consistently
|
|
23
|
+
- Write with technical precision
|
|
24
|
+
</action>
|
|
25
|
+
|
|
26
|
+
<action>Get target path from user:
|
|
27
|
+
|
|
28
|
+
- Ask: "What do you want to document? (module path, workflow path, agent path, or folder path)"
|
|
29
|
+
- Store as {{target_path}}
|
|
30
|
+
</action>
|
|
31
|
+
|
|
32
|
+
<action>Validate target path exists and determine target type:
|
|
33
|
+
|
|
34
|
+
- Module root (contains config.yaml, /workflows, /agents folders)
|
|
35
|
+
- Workflows folder (contains multiple workflow folders)
|
|
36
|
+
- Agents folder (contains multiple agent .md files)
|
|
37
|
+
- Single workflow folder (contains workflow.yaml)
|
|
38
|
+
- Single agent file (.md)
|
|
39
|
+
</action>
|
|
40
|
+
|
|
41
|
+
<action>Store target type as {{target_type}} for conditional processing</action>
|
|
42
|
+
</step>
|
|
43
|
+
|
|
44
|
+
<step n="2" goal="Analyze directory structure and existing documentation">
|
|
45
|
+
<action>Build complete tree structure of {{target_path}} using Glob and file system tools</action>
|
|
46
|
+
|
|
47
|
+
<action>Identify all documentation points:
|
|
48
|
+
|
|
49
|
+
- List all folders requiring README.md files
|
|
50
|
+
- Detect existing README.md files
|
|
51
|
+
- Parse frontmatter from existing READMEs to extract last-redoc-date
|
|
52
|
+
- Calculate documentation depth (how many levels deep)
|
|
53
|
+
</action>
|
|
54
|
+
|
|
55
|
+
<action>Create documentation map with execution order (deepest → shallowest):
|
|
56
|
+
|
|
57
|
+
- Level 0 (deepest): Individual workflow folders, individual agent files
|
|
58
|
+
- Level 1: /workflows folder, /agents folder
|
|
59
|
+
- Level 2 (root): Module root README.md
|
|
60
|
+
</action>
|
|
61
|
+
|
|
62
|
+
<action>Detect "massive folders" requiring child catalog documents:
|
|
63
|
+
|
|
64
|
+
- Threshold: >10 items or complex categorization needed
|
|
65
|
+
- Mark folders for catalog document creation (e.g., WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md)
|
|
66
|
+
</action>
|
|
67
|
+
|
|
68
|
+
<critical>Store execution order as {{doc_execution_plan}} - this ensures reverse-tree processing</critical>
|
|
69
|
+
</step>
|
|
70
|
+
|
|
71
|
+
<step n="3" goal="Process leaf-level documentation" repeat="for-each-leaf-item">
|
|
72
|
+
<action>For each individual workflow folder in execution plan:
|
|
73
|
+
1. Read ALL files completely:
|
|
74
|
+
- workflow.yaml (metadata, purpose, configuration)
|
|
75
|
+
- instructions.md (step structure, goals)
|
|
76
|
+
- template.md (output structure) if exists
|
|
77
|
+
- checklist.md (validation criteria) if exists
|
|
78
|
+
- Any supporting data files
|
|
79
|
+
|
|
80
|
+
2. Synthesize understanding:
|
|
81
|
+
- Core purpose and use case
|
|
82
|
+
- Input requirements
|
|
83
|
+
- Output produced
|
|
84
|
+
- Unique characteristics (vs standard BMAD workflow patterns)
|
|
85
|
+
- Key steps or special features
|
|
86
|
+
|
|
87
|
+
3. Generate/update README.md:
|
|
88
|
+
- Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
|
|
89
|
+
- Write 2-4 paragraph technical description
|
|
90
|
+
- Include "Usage" section with invocation command
|
|
91
|
+
- Include "Inputs" section if applicable
|
|
92
|
+
- Include "Outputs" section
|
|
93
|
+
- Be succinct and precise - technical writer quality
|
|
94
|
+
- Focus on DISTINCTIVE features, not boilerplate
|
|
95
|
+
|
|
96
|
+
4. Save README.md to workflow folder
|
|
97
|
+
</action>
|
|
98
|
+
|
|
99
|
+
<action>For each individual agent file in execution plan:
|
|
100
|
+
|
|
101
|
+
1. Read agent definition file completely:
|
|
102
|
+
- XML structure and metadata
|
|
103
|
+
- Commands and their purposes
|
|
104
|
+
- Activation patterns
|
|
105
|
+
- Persona and communication style
|
|
106
|
+
- Critical actions and workflows invoked
|
|
107
|
+
|
|
108
|
+
2. Synthesize understanding:
|
|
109
|
+
- Agent purpose and role
|
|
110
|
+
- Available commands
|
|
111
|
+
- When to use this agent
|
|
112
|
+
- Unique capabilities
|
|
113
|
+
|
|
114
|
+
3. Generate/update README.md (or agent-name-README.md if in shared folder):
|
|
115
|
+
- Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
|
|
116
|
+
- Write 1-3 paragraph technical description
|
|
117
|
+
- Include "Commands" section listing available commands
|
|
118
|
+
- Include "Usage" section
|
|
119
|
+
- Focus on distinctive features
|
|
120
|
+
|
|
121
|
+
4. Save README.md
|
|
122
|
+
</action>
|
|
123
|
+
|
|
124
|
+
<check>If clarification needed about purpose or unique features → Ask user briefly, then continue</check>
|
|
125
|
+
</step>
|
|
126
|
+
|
|
127
|
+
<step n="4" goal="Process mid-level folder documentation" if="target_type requires folder docs">
|
|
128
|
+
<action>For /workflows folder:
|
|
129
|
+
1. Read ALL workflow README.md files created in Step 3
|
|
130
|
+
2. Categorize workflows by purpose/type if folder is massive (>10 workflows):
|
|
131
|
+
- Document generation workflows
|
|
132
|
+
- Action workflows
|
|
133
|
+
- Meta-workflows
|
|
134
|
+
- Interactive workflows
|
|
135
|
+
|
|
136
|
+
3. If massive folder detected:
|
|
137
|
+
- Create WORKFLOWS-CATALOG.md with categorized listings
|
|
138
|
+
- Each entry: workflow name, 1-sentence description, link to folder
|
|
139
|
+
- Add frontmatter with last-redoc-date
|
|
140
|
+
|
|
141
|
+
4. Generate/update /workflows/README.md:
|
|
142
|
+
- Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
|
|
143
|
+
- High-level summary of workflow collection
|
|
144
|
+
- If catalog exists: reference it
|
|
145
|
+
- If not massive: list all workflows with brief descriptions and links
|
|
146
|
+
- Highlight notable or commonly-used workflows
|
|
147
|
+
- Keep succinct (1-2 paragraphs + list)
|
|
148
|
+
|
|
149
|
+
5. Save README.md
|
|
150
|
+
</action>
|
|
151
|
+
|
|
152
|
+
<action>For /agents folder:
|
|
153
|
+
|
|
154
|
+
1. Read ALL agent README.md files
|
|
155
|
+
2. Categorize agents by type if massive folder (>10 agents):
|
|
156
|
+
- Task agents
|
|
157
|
+
- Meta agents
|
|
158
|
+
- Specialized agents
|
|
159
|
+
- Utility agents
|
|
160
|
+
|
|
161
|
+
3. If massive folder detected:
|
|
162
|
+
- Create AGENTS-CATALOG.md with categorized listings
|
|
163
|
+
- Each entry: agent name, 1-sentence description, link
|
|
164
|
+
- Add frontmatter with last-redoc-date
|
|
165
|
+
|
|
166
|
+
4. Generate/update /agents/README.md:
|
|
167
|
+
- Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
|
|
168
|
+
- High-level summary of agent collection
|
|
169
|
+
- If catalog exists: reference it
|
|
170
|
+
- If not massive: list all agents with brief descriptions
|
|
171
|
+
- Highlight key agents and their purposes
|
|
172
|
+
- Keep succinct
|
|
173
|
+
|
|
174
|
+
5. Save README.md
|
|
175
|
+
</action>
|
|
176
|
+
</step>
|
|
177
|
+
|
|
178
|
+
<step n="5" goal="Process root module documentation" if="target_type is module root">
|
|
179
|
+
<action>For module root README.md:
|
|
180
|
+
1. Read module config.yaml for metadata and configuration
|
|
181
|
+
2. Read /workflows/README.md and /agents/README.md created in Step 4
|
|
182
|
+
3. Identify module's unique purpose within BMAD ecosystem
|
|
183
|
+
|
|
184
|
+
4. Generate/update module README.md:
|
|
185
|
+
- Add frontmatter: `---\nlast-redoc-date: {{date}}\n---\n`
|
|
186
|
+
|
|
187
|
+
Structure:
|
|
188
|
+
- # Module Name
|
|
189
|
+
- **Purpose**: 2-3 sentence high-level module purpose
|
|
190
|
+
- **Overview**: 1-2 paragraphs describing what this module provides
|
|
191
|
+
|
|
192
|
+
- ## Workflows
|
|
193
|
+
- Link to /workflows/README.md with 1-sentence summary
|
|
194
|
+
- Mention count and highlight 2-3 key workflows
|
|
195
|
+
|
|
196
|
+
- ## Agents
|
|
197
|
+
- Link to /agents/README.md with 1-sentence summary
|
|
198
|
+
- Mention count and highlight 2-3 key agents
|
|
199
|
+
|
|
200
|
+
- ## Configuration
|
|
201
|
+
- Notable config.yaml settings if unique/important
|
|
202
|
+
- Reference paths and conventions
|
|
203
|
+
|
|
204
|
+
- ## Usage
|
|
205
|
+
- How to invoke workflows or agents from this module
|
|
206
|
+
- Prerequisites if any
|
|
207
|
+
|
|
208
|
+
Focus on UNIQUE aspects using BMAD convention knowledge:
|
|
209
|
+
- Don't explain standard BMAD patterns
|
|
210
|
+
- Highlight what makes THIS module distinctive
|
|
211
|
+
- Use proper BMAD terminology
|
|
212
|
+
|
|
213
|
+
5. Save README.md to module root
|
|
214
|
+
</action>
|
|
215
|
+
</step>
|
|
216
|
+
|
|
217
|
+
<step n="6" goal="Validation and summary report">
|
|
218
|
+
<action>Verify all planned documentation was created/updated:
|
|
219
|
+
- Check each item in {{doc_execution_plan}}
|
|
220
|
+
- Confirm frontmatter dates are current
|
|
221
|
+
- Validate file paths and links
|
|
222
|
+
</action>
|
|
223
|
+
|
|
224
|
+
<action>Generate summary report showing:
|
|
225
|
+
|
|
226
|
+
- Target documented: {{target_path}}
|
|
227
|
+
- Target type: {{target_type}}
|
|
228
|
+
- Documentation files created/updated (count and list)
|
|
229
|
+
- Any catalog files created
|
|
230
|
+
- Files skipped or requiring manual review (if any)
|
|
231
|
+
- Coverage: X% of items documented
|
|
232
|
+
</action>
|
|
233
|
+
|
|
234
|
+
<action>Display summary to user</action>
|
|
235
|
+
</step>
|
|
236
|
+
|
|
237
|
+
<step n="7" goal="Optional git diff analysis" optional="true">
|
|
238
|
+
<ask>Would you like to see what changed since the last redoc run? [y/n]</ask>
|
|
239
|
+
|
|
240
|
+
<action if="user_response == 'y'">
|
|
241
|
+
For each README with last-redoc-date frontmatter:
|
|
242
|
+
1. Extract last-redoc-date timestamp
|
|
243
|
+
2. Use git log to find files modified since that date in the documented folder
|
|
244
|
+
3. Highlight files that changed but may need documentation updates
|
|
245
|
+
4. Report findings to user
|
|
246
|
+
</action>
|
|
247
|
+
</step>
|
|
248
|
+
|
|
249
|
+
<step n="8" goal="Completion">
|
|
250
|
+
<action>Confirm autonomous workflow execution complete</action>
|
|
251
|
+
<action>Provide path to all updated documentation</action>
|
|
252
|
+
<action>Suggest next steps if needed (e.g., "Run redoc on parent module to update references")</action>
|
|
253
|
+
</step>
|
|
254
|
+
|
|
255
|
+
</workflow>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# ReDoc - Reverse-Tree Documentation Engine
|
|
2
|
+
name: "redoc"
|
|
3
|
+
description: "Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output."
|
|
4
|
+
author: "BMad"
|
|
5
|
+
|
|
6
|
+
# Critical variables
|
|
7
|
+
config_source: "{project-root}/bmad/bmb/config.yaml"
|
|
8
|
+
output_folder: "{config_source}:output_folder"
|
|
9
|
+
user_name: "{config_source}:user_name"
|
|
10
|
+
date: system-generated
|
|
11
|
+
|
|
12
|
+
# Required knowledge base - BMAD conventions and patterns
|
|
13
|
+
bmad_conventions:
|
|
14
|
+
agent_architecture: "{project-root}/src/modules/bmb/workflows/create-agent/agent-architecture.md"
|
|
15
|
+
agent_command_patterns: "{project-root}/src/modules/bmb/workflows/create-agent/agent-command-patterns.md"
|
|
16
|
+
agent_types: "{project-root}/src/modules/bmb/workflows/create-agent/agent-types.md"
|
|
17
|
+
module_structure: "{project-root}/src/modules/bmb/workflows/create-module/module-structure.md"
|
|
18
|
+
workflow_guide: "{project-root}/src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md"
|
|
19
|
+
|
|
20
|
+
# Runtime inputs
|
|
21
|
+
target_path: "" # User specifies: module path, workflow path, agent path, or folder path
|
|
22
|
+
|
|
23
|
+
# Module path and component files
|
|
24
|
+
installed_path: "{project-root}/src/modules/bmb/workflows/redoc"
|
|
25
|
+
template: false # Action workflow - updates files in place
|
|
26
|
+
instructions: "{installed_path}/instructions.md"
|
|
27
|
+
validation: "{installed_path}/checklist.md"
|
|
28
|
+
|
|
29
|
+
# Configuration
|
|
30
|
+
autonomous: true # Runs without user checkpoints unless clarification needed
|
|
31
|
+
|
|
32
|
+
# Tool Requirements - Using built-in file system tools
|
|
33
|
+
required_tools: []
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# BMad Method Master Knowledge Base Index
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Technical Decisions Log
|
|
2
|
+
|
|
3
|
+
_Auto-updated during discovery and planning sessions - you can also add information here yourself_
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This document captures technical decisions, preferences, and constraints discovered during project discussions. It serves as input for architecture.md and solution design documents.
|
|
8
|
+
|
|
9
|
+
## Confirmed Decisions
|
|
10
|
+
|
|
11
|
+
<!-- Technical choices explicitly confirmed by the team/user -->
|
|
12
|
+
|
|
13
|
+
## Preferences
|
|
14
|
+
|
|
15
|
+
<!-- Non-binding preferences mentioned during discussions -->
|
|
16
|
+
|
|
17
|
+
## Constraints
|
|
18
|
+
|
|
19
|
+
<!-- Hard requirements from infrastructure, compliance, or integration needs -->
|
|
20
|
+
|
|
21
|
+
## To Investigate
|
|
22
|
+
|
|
23
|
+
<!-- Technical questions that need research or architect input -->
|
|
24
|
+
|
|
25
|
+
## Notes
|
|
26
|
+
|
|
27
|
+
- This file is automatically updated when technical information is mentioned
|
|
28
|
+
- Decisions here are inputs, not final architecture
|
|
29
|
+
- Final technical decisions belong in architecture.md
|
|
30
|
+
- Implementation details belong in solutions/\*.md and story context or dev notes.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# BMAD™ Method Core Configuration
|
|
2
|
+
|
|
3
|
+
code: bmm
|
|
4
|
+
name: "BMM: BMad Method Agile-AI Driven-Development"
|
|
5
|
+
default_selected: true # This module will be selected by default for new installations
|
|
6
|
+
|
|
7
|
+
prompt:
|
|
8
|
+
- "Thank you for choosing the BMAD™ Method, your gateway to dreaming, planning"
|
|
9
|
+
- "and building with real world proven techniques."
|
|
10
|
+
- "All paths are relative to project root, with no leading slash."
|
|
11
|
+
|
|
12
|
+
# Variables from Core Config inserted:
|
|
13
|
+
## user_name
|
|
14
|
+
## communication_language
|
|
15
|
+
## output_folder
|
|
16
|
+
|
|
17
|
+
project_name:
|
|
18
|
+
prompt: "What is the title of your project you will be working on?"
|
|
19
|
+
default: "My Project"
|
|
20
|
+
result: "{value}"
|
|
21
|
+
|
|
22
|
+
tech_docs:
|
|
23
|
+
prompt: "Where is Technical Documentation located within the project?"
|
|
24
|
+
default: "docs"
|
|
25
|
+
result: "{project-root}/{value}"
|
|
26
|
+
|
|
27
|
+
dev_story_location:
|
|
28
|
+
prompt: "Where should development stories be stored?"
|
|
29
|
+
default: "docs/stories"
|
|
30
|
+
result: "{project-root}/{value}"
|
|
31
|
+
|
|
32
|
+
kb_location:
|
|
33
|
+
prompt: "Where should bmad knowledge base articles be stored?"
|
|
34
|
+
default: "~/bmad/bmm/kb.md"
|
|
35
|
+
result: "{value}"
|
|
36
|
+
|
|
37
|
+
desired_mcp_tools:
|
|
38
|
+
prompt:
|
|
39
|
+
- "Which MCP Tools will you be using? (Select all that apply)"
|
|
40
|
+
- "Note: You will need to install these separately. Bindings will come post ALPHA along with other choices."
|
|
41
|
+
result: "{value}"
|
|
42
|
+
multi-select:
|
|
43
|
+
- "Chrome Official MCP"
|
|
44
|
+
- "Playwright"
|
|
45
|
+
- "Context 7"
|
|
46
|
+
- "Tavily"
|
|
47
|
+
- "Perplexity"
|
|
48
|
+
- "Jira"
|
|
49
|
+
- "Trello"
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
const fs = require('fs-extra');
|
|
2
|
+
const path = require('node:path');
|
|
3
|
+
const chalk = require('chalk');
|
|
4
|
+
const platformCodes = require(path.join(__dirname, '../../../../tools/cli/lib/platform-codes'));
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* BMM Module Installer
|
|
8
|
+
* Standard module installer function that executes after IDE installations
|
|
9
|
+
*
|
|
10
|
+
* @param {Object} options - Installation options
|
|
11
|
+
* @param {string} options.projectRoot - The root directory of the target project
|
|
12
|
+
* @param {Object} options.config - Module configuration from install-menu-config.yaml
|
|
13
|
+
* @param {Array<string>} options.installedIDEs - Array of IDE codes that were installed
|
|
14
|
+
* @param {Object} options.logger - Logger instance for output
|
|
15
|
+
* @returns {Promise<boolean>} - Success status
|
|
16
|
+
*/
|
|
17
|
+
async function install(options) {
|
|
18
|
+
const { projectRoot, config, installedIDEs, logger } = options;
|
|
19
|
+
|
|
20
|
+
try {
|
|
21
|
+
logger.log(chalk.blue('🚀 Installing BMM Module...'));
|
|
22
|
+
|
|
23
|
+
// Check and create tech_docs directory if configured
|
|
24
|
+
if (config['tech_docs']) {
|
|
25
|
+
// Strip {project-root}/ prefix if present
|
|
26
|
+
const techDocsConfig = config['tech_docs'].replace('{project-root}/', '');
|
|
27
|
+
const techDocsPath = path.join(projectRoot, techDocsConfig);
|
|
28
|
+
|
|
29
|
+
if (await fs.pathExists(techDocsPath)) {
|
|
30
|
+
// Check if template exists, add if missing
|
|
31
|
+
const templateDest = path.join(techDocsPath, 'technical-decisions-template.md');
|
|
32
|
+
if (!(await fs.pathExists(templateDest))) {
|
|
33
|
+
const templateSource = path.join(__dirname, 'assets', 'technical-decisions-template.md');
|
|
34
|
+
if (await fs.pathExists(templateSource)) {
|
|
35
|
+
await fs.copy(templateSource, templateDest);
|
|
36
|
+
logger.log(chalk.green('✓ Added technical decisions template to existing directory'));
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
} else {
|
|
40
|
+
logger.log(chalk.yellow(`Creating technical documentation directory: ${techDocsConfig}`));
|
|
41
|
+
await fs.ensureDir(techDocsPath);
|
|
42
|
+
|
|
43
|
+
// Copy technical decisions template
|
|
44
|
+
const templateSource = path.join(__dirname, 'assets', 'technical-decisions-template.md');
|
|
45
|
+
const templateDest = path.join(techDocsPath, 'technical-decisions-template.md');
|
|
46
|
+
|
|
47
|
+
if (await fs.pathExists(templateSource)) {
|
|
48
|
+
await fs.copy(templateSource, templateDest, { overwrite: false });
|
|
49
|
+
logger.log(chalk.green('✓ Added technical decisions template'));
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// Create output directory if configured
|
|
55
|
+
if (config['output_folder']) {
|
|
56
|
+
// Strip {project-root}/ prefix if present
|
|
57
|
+
const outputConfig = config['output_folder'].replace('{project-root}/', '');
|
|
58
|
+
const outputPath = path.join(projectRoot, outputConfig);
|
|
59
|
+
if (!(await fs.pathExists(outputPath))) {
|
|
60
|
+
logger.log(chalk.yellow(`Creating output directory: ${outputConfig}`));
|
|
61
|
+
await fs.ensureDir(outputPath);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// Create dev story location if configured
|
|
66
|
+
if (config['dev_story_location']) {
|
|
67
|
+
// Strip {project-root}/ prefix if present
|
|
68
|
+
const storyConfig = config['dev_story_location'].replace('{project-root}/', '');
|
|
69
|
+
const storyPath = path.join(projectRoot, storyConfig);
|
|
70
|
+
if (!(await fs.pathExists(storyPath))) {
|
|
71
|
+
logger.log(chalk.yellow(`Creating story directory: ${storyConfig}`));
|
|
72
|
+
await fs.ensureDir(storyPath);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// Handle IDE-specific configurations if needed
|
|
77
|
+
if (installedIDEs && installedIDEs.length > 0) {
|
|
78
|
+
logger.log(chalk.cyan(`Configuring BMM for IDEs: ${installedIDEs.join(', ')}`));
|
|
79
|
+
|
|
80
|
+
// Add any IDE-specific BMM configurations here
|
|
81
|
+
for (const ide of installedIDEs) {
|
|
82
|
+
await configureForIDE(ide, projectRoot, config, logger);
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
logger.log(chalk.green('✓ BMM Module installation complete'));
|
|
87
|
+
return true;
|
|
88
|
+
} catch (error) {
|
|
89
|
+
logger.error(chalk.red(`Error installing BMM module: ${error.message}`));
|
|
90
|
+
return false;
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Configure BMM module for specific platform/IDE
|
|
96
|
+
* @private
|
|
97
|
+
*/
|
|
98
|
+
async function configureForIDE(ide, projectRoot, config, logger) {
|
|
99
|
+
// Validate platform code
|
|
100
|
+
if (!platformCodes.isValidPlatform(ide)) {
|
|
101
|
+
logger.warn(chalk.yellow(` Warning: Unknown platform code '${ide}'. Skipping BMM configuration.`));
|
|
102
|
+
return;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
const platformName = platformCodes.getDisplayName(ide);
|
|
106
|
+
|
|
107
|
+
// Try to load platform-specific handler
|
|
108
|
+
const platformSpecificPath = path.join(__dirname, 'platform-specifics', `${ide}.js`);
|
|
109
|
+
|
|
110
|
+
try {
|
|
111
|
+
if (await fs.pathExists(platformSpecificPath)) {
|
|
112
|
+
const platformHandler = require(platformSpecificPath);
|
|
113
|
+
|
|
114
|
+
if (typeof platformHandler.install === 'function') {
|
|
115
|
+
await platformHandler.install({
|
|
116
|
+
projectRoot,
|
|
117
|
+
config,
|
|
118
|
+
logger,
|
|
119
|
+
platformInfo: platformCodes.getPlatform(ide), // Pass platform metadata
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
} else {
|
|
123
|
+
// No platform-specific handler for this IDE
|
|
124
|
+
logger.log(chalk.dim(` No BMM-specific configuration for ${platformName}`));
|
|
125
|
+
}
|
|
126
|
+
} catch (error) {
|
|
127
|
+
logger.warn(chalk.yellow(` Warning: Could not load BMM platform-specific handler for ${platformName}: ${error.message}`));
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
module.exports = { install };
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
const chalk = require('chalk');
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* BMM Platform-specific installer for Claude Code
|
|
5
|
+
*
|
|
6
|
+
* @param {Object} options - Installation options
|
|
7
|
+
* @param {string} options.projectRoot - The root directory of the target project
|
|
8
|
+
* @param {Object} options.config - Module configuration from install-menu-config.yaml
|
|
9
|
+
* @param {Object} options.logger - Logger instance for output
|
|
10
|
+
* @param {Object} options.platformInfo - Platform metadata from global config
|
|
11
|
+
* @returns {Promise<boolean>} - Success status
|
|
12
|
+
*/
|
|
13
|
+
async function install(options) {
|
|
14
|
+
const { logger, platformInfo } = options;
|
|
15
|
+
// projectRoot and config available for future use
|
|
16
|
+
|
|
17
|
+
try {
|
|
18
|
+
const platformName = platformInfo ? platformInfo.name : 'Claude Code';
|
|
19
|
+
logger.log(chalk.cyan(` BMM-${platformName} Specifics installed`));
|
|
20
|
+
|
|
21
|
+
// Add Claude Code specific BMM configurations here
|
|
22
|
+
// For example:
|
|
23
|
+
// - Custom command configurations
|
|
24
|
+
// - Agent party configurations
|
|
25
|
+
// - Workflow integrations
|
|
26
|
+
// - Template mappings
|
|
27
|
+
|
|
28
|
+
return true;
|
|
29
|
+
} catch (error) {
|
|
30
|
+
logger.error(chalk.red(`Error installing BMM Claude Code specifics: ${error.message}`));
|
|
31
|
+
return false;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
module.exports = { install };
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
const chalk = require('chalk');
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* BMM Platform-specific installer for Windsurf
|
|
5
|
+
*
|
|
6
|
+
* @param {Object} options - Installation options
|
|
7
|
+
* @param {string} options.projectRoot - The root directory of the target project
|
|
8
|
+
* @param {Object} options.config - Module configuration from install-menu-config.yaml
|
|
9
|
+
* @param {Object} options.logger - Logger instance for output
|
|
10
|
+
* @returns {Promise<boolean>} - Success status
|
|
11
|
+
*/
|
|
12
|
+
async function install(options) {
|
|
13
|
+
const { logger } = options;
|
|
14
|
+
// projectRoot and config available for future use
|
|
15
|
+
|
|
16
|
+
try {
|
|
17
|
+
logger.log(chalk.cyan(' BMM-Windsurf Specifics installed'));
|
|
18
|
+
|
|
19
|
+
// Add Windsurf specific BMM configurations here
|
|
20
|
+
// For example:
|
|
21
|
+
// - Custom cascades
|
|
22
|
+
// - Workflow adaptations
|
|
23
|
+
// - Template configurations
|
|
24
|
+
|
|
25
|
+
return true;
|
|
26
|
+
} catch (error) {
|
|
27
|
+
logger.error(chalk.red(`Error installing BMM Windsurf specifics: ${error.message}`));
|
|
28
|
+
return false;
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
module.exports = { install };
|