@zeyue0329/xiaoma-cli 1.0.7 → 1.0.10
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/FORK_GUIDE.md +106 -0
- package/.github/FUNDING.yaml +15 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- package/.github/workflows/discord.yaml +26 -0
- package/.github/workflows/format-check.yaml +44 -0
- package/.github/workflows/manual-release.yaml +174 -0
- package/.github/workflows/pr-validation.yaml +55 -0
- package/.husky/pre-commit +3 -0
- package/.vscode/settings.json +26 -1
- package/CHANGELOG.md +686 -0
- package/CONTRIBUTING.md +250 -0
- package/LICENSE +6 -1
- package/common/tasks/create-doc.md +2 -0
- package/common/tasks/execute-checklist.md +2 -7
- package/common/utils/bmad-doc-template.md +7 -5
- package/common/utils/workflow-management.md +2 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2103 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +1627 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +822 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +8486 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +3210 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +3244 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +317 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +982 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +12854 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/beta-reader.txt +921 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/book-critic.txt +81 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/character-psychologist.txt +886 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/cover-designer.txt +85 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/dialog-specialist.txt +903 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/editor.txt +837 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/genre-specialist.txt +989 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/narrative-designer.txt +888 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/plot-architect.txt +1173 -0
- package/dist/expansion-packs/bmad-creative-writing/agents/world-builder.txt +914 -0
- package/dist/expansion-packs/bmad-creative-writing/teams/agent-team.txt +6071 -0
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +2079 -0
- package/docs/GUIDING-PRINCIPLES.md +91 -0
- package/docs/core-architecture.md +219 -0
- package/docs/enhanced-ide-development-workflow.md +248 -0
- package/docs/expansion-packs.md +200 -0
- package/docs/how-to-contribute-with-pull-requests.md +158 -0
- package/docs/user-guide.md +530 -0
- package/docs/versioning-and-releases.md +155 -0
- package/docs/versions.md +48 -0
- package/docs/working-in-the-brownfield.md +597 -0
- package/eslint.config.mjs +119 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +14 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +73 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +80 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +66 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +203 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +162 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +9 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +252 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +649 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +112 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +218 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +292 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +614 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +357 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +344 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +254 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +485 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +184 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +176 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +15 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +82 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +79 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +80 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +67 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +393 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +205 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +203 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +126 -0
- package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +7 -0
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +771 -0
- package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +588 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +112 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +143 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +186 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +292 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +202 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +1031 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +357 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +706 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +257 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +485 -0
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +184 -0
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +176 -0
- package/expansion-packs/bmad-creative-writing/README.md +146 -0
- package/expansion-packs/bmad-creative-writing/agent-teams/agent-team.yaml +20 -0
- package/expansion-packs/bmad-creative-writing/agents/beta-reader.md +94 -0
- package/expansion-packs/bmad-creative-writing/agents/book-critic.md +40 -0
- package/expansion-packs/bmad-creative-writing/agents/character-psychologist.md +93 -0
- package/expansion-packs/bmad-creative-writing/agents/cover-designer.md +46 -0
- package/expansion-packs/bmad-creative-writing/agents/dialog-specialist.md +92 -0
- package/expansion-packs/bmad-creative-writing/agents/editor.md +93 -0
- package/expansion-packs/bmad-creative-writing/agents/genre-specialist.md +95 -0
- package/expansion-packs/bmad-creative-writing/agents/narrative-designer.md +93 -0
- package/expansion-packs/bmad-creative-writing/agents/plot-architect.md +95 -0
- package/expansion-packs/bmad-creative-writing/agents/world-builder.md +94 -0
- package/expansion-packs/bmad-creative-writing/checklists/beta-feedback-closure-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/character-consistency-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/comedic-timing-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/cyberpunk-aesthetic-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/ebook-formatting-checklist.md +21 -0
- package/expansion-packs/bmad-creative-writing/checklists/epic-poetry-meter-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/fantasy-magic-system-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/foreshadowing-payoff-checklist.md +22 -0
- package/expansion-packs/bmad-creative-writing/checklists/genre-tropes-checklist.md +22 -0
- package/expansion-packs/bmad-creative-writing/checklists/historical-accuracy-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/horror-suspense-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/kdp-cover-ready-checklist.md +25 -0
- package/expansion-packs/bmad-creative-writing/checklists/line-edit-quality-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/marketing-copy-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/mystery-clue-trail-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/orbital-mechanics-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/plot-structure-checklist.md +59 -0
- package/expansion-packs/bmad-creative-writing/checklists/publication-readiness-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/romance-emotional-beats-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/scene-quality-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/scifi-technology-plausibility-checklist.md +22 -0
- package/expansion-packs/bmad-creative-writing/checklists/sensitivity-representation-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/steampunk-gadget-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/thriller-pacing-stakes-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/timeline-continuity-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/world-building-continuity-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/checklists/ya-appropriateness-checklist.md +23 -0
- package/expansion-packs/bmad-creative-writing/config.yaml +12 -0
- package/expansion-packs/bmad-creative-writing/data/bmad-kb.md +209 -0
- package/expansion-packs/bmad-creative-writing/data/story-structures.md +67 -0
- package/expansion-packs/bmad-creative-writing/docs/brief.md +212 -0
- package/expansion-packs/bmad-creative-writing/tasks/advanced-elicitation.md +119 -0
- package/expansion-packs/bmad-creative-writing/tasks/analyze-reader-feedback.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/analyze-story-structure.md +67 -0
- package/expansion-packs/bmad-creative-writing/tasks/assemble-kdp-package.md +29 -0
- package/expansion-packs/bmad-creative-writing/tasks/brainstorm-premise.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/build-world.md +24 -0
- package/expansion-packs/bmad-creative-writing/tasks/character-depth-pass.md +22 -0
- package/expansion-packs/bmad-creative-writing/tasks/create-doc.md +103 -0
- package/expansion-packs/bmad-creative-writing/tasks/create-draft-section.md +26 -0
- package/expansion-packs/bmad-creative-writing/tasks/critical-review.md +26 -0
- package/expansion-packs/bmad-creative-writing/tasks/develop-character.md +24 -0
- package/expansion-packs/bmad-creative-writing/tasks/execute-checklist.md +88 -0
- package/expansion-packs/bmad-creative-writing/tasks/expand-premise.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/expand-synopsis.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/final-polish.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-cover-brief.md +25 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-cover-prompts.md +26 -0
- package/expansion-packs/bmad-creative-writing/tasks/generate-scene-list.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/incorporate-feedback.md +25 -0
- package/expansion-packs/bmad-creative-writing/tasks/outline-scenes.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/provide-feedback.md +24 -0
- package/expansion-packs/bmad-creative-writing/tasks/publish-chapter.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/quick-feedback.md +22 -0
- package/expansion-packs/bmad-creative-writing/tasks/select-next-arc.md +23 -0
- package/expansion-packs/bmad-creative-writing/tasks/workshop-dialog.md +64 -0
- package/expansion-packs/bmad-creative-writing/templates/beta-feedback-form.yaml +97 -0
- package/expansion-packs/bmad-creative-writing/templates/chapter-draft-tmpl.yaml +82 -0
- package/expansion-packs/bmad-creative-writing/templates/character-profile-tmpl.yaml +92 -0
- package/expansion-packs/bmad-creative-writing/templates/cover-design-brief-tmpl.yaml +98 -0
- package/expansion-packs/bmad-creative-writing/templates/premise-brief-tmpl.yaml +78 -0
- package/expansion-packs/bmad-creative-writing/templates/scene-list-tmpl.yaml +55 -0
- package/expansion-packs/bmad-creative-writing/templates/story-outline-tmpl.yaml +96 -0
- package/expansion-packs/bmad-creative-writing/templates/world-guide-tmpl.yaml +89 -0
- package/expansion-packs/bmad-creative-writing/workflows/book-cover-design-workflow.md +218 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-greenfield-workflow.yaml +56 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-serial-workflow.yaml +50 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-snowflake-workflow.yaml +69 -0
- package/expansion-packs/bmad-creative-writing/workflows/novel-writing.yaml +91 -0
- package/expansion-packs/bmad-creative-writing/workflows/screenplay-development.yaml +85 -0
- package/expansion-packs/bmad-creative-writing/workflows/series-planning.yaml +78 -0
- package/expansion-packs/bmad-creative-writing/workflows/short-story-creation.yaml +64 -0
- package/expansion-packs/bmad-infrastructure-devops/README.md +147 -0
- package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +73 -0
- package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +486 -0
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +10 -0
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +307 -0
- package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +161 -0
- package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +155 -0
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +425 -0
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +630 -0
- package/implement-fork-friendly-ci.sh +229 -0
- package/package.json +75 -45
- package/prettier.config.mjs +32 -0
- package/test.md +1 -0
- package/tools/builders/web-builder.js +143 -149
- package/tools/bump-all-versions.js +42 -33
- package/tools/bump-expansion-version.js +23 -16
- package/tools/cli.js +15 -15
- package/tools/flattener/aggregate.js +76 -0
- package/tools/flattener/binary.js +80 -0
- package/tools/flattener/discovery.js +71 -0
- package/tools/flattener/files.js +35 -0
- package/tools/flattener/ignoreRules.js +176 -0
- package/tools/flattener/main.js +458 -460
- package/tools/flattener/projectRoot.js +206 -0
- package/tools/flattener/prompts.js +44 -0
- package/tools/flattener/stats.helpers.js +395 -0
- package/tools/flattener/stats.js +80 -0
- package/tools/flattener/test-matrix.js +413 -0
- package/tools/flattener/xml.js +88 -0
- package/tools/installer/README.md +1 -1
- package/tools/installer/bin/xiaoma.js +392 -99
- package/tools/installer/config/ide-agent-config.yaml +1 -1
- package/tools/installer/config/install.config.yaml +60 -9
- package/tools/installer/lib/config-loader.js +55 -51
- package/tools/installer/lib/file-manager.js +92 -114
- package/tools/installer/lib/ide-base-setup.js +57 -56
- package/tools/installer/lib/ide-setup.js +821 -414
- package/tools/installer/lib/installer.js +924 -696
- package/tools/installer/lib/memory-profiler.js +54 -53
- package/tools/installer/lib/module-manager.js +19 -15
- package/tools/installer/lib/resource-locator.js +31 -33
- package/tools/installer/package.json +24 -23
- package/tools/lib/dependency-resolver.js +39 -43
- package/tools/lib/yaml-utils.js +7 -7
- package/tools/md-assets/web-agent-startup-instructions.md +6 -6
- package/tools/preview-release-notes.js +66 -0
- package/tools/setup-hooks.sh +37 -0
- package/tools/shared/bannerArt.js +105 -0
- package/tools/sync-installer-version.js +7 -9
- package/tools/sync-version.sh +23 -0
- package/tools/update-expansion-version.js +14 -15
- package/tools/upgraders/v3-to-v4-upgrader.js +203 -294
- package/tools/version-bump.js +41 -26
- package/tools/xiaoma-npx-wrapper.js +14 -14
- package/tools/yaml-format.js +56 -43
- package/xiaoma-core/agent-teams/team-all.yaml +3 -2
- package/xiaoma-core/agent-teams/team-fullstack.yaml +2 -1
- package/xiaoma-core/agent-teams/team-ide-minimal.yaml +1 -0
- package/xiaoma-core/agent-teams/team-no-ui.yaml +2 -1
- package/xiaoma-core/agents/analyst.md +20 -17
- package/xiaoma-core/agents/architect.md +15 -14
- package/xiaoma-core/agents/{xiaoma-master.md → bmad-master.md} +29 -27
- package/xiaoma-core/agents/{xiaoma-orchestrator.md → bmad-orchestrator.md} +36 -39
- package/xiaoma-core/agents/dev.md +23 -18
- package/xiaoma-core/agents/pm.md +18 -15
- package/xiaoma-core/agents/po.md +13 -10
- package/xiaoma-core/agents/qa.md +46 -24
- package/xiaoma-core/agents/sm.md +11 -8
- package/xiaoma-core/agents/ux-expert.md +10 -7
- package/xiaoma-core/checklists/architect-checklist.md +2 -5
- package/xiaoma-core/checklists/change-checklist.md +4 -2
- package/xiaoma-core/checklists/pm-checklist.md +2 -5
- package/xiaoma-core/checklists/po-master-checklist.md +2 -9
- package/xiaoma-core/checklists/story-dod-checklist.md +2 -7
- package/xiaoma-core/checklists/story-draft-checklist.md +2 -3
- package/xiaoma-core/core-config.yaml +4 -1
- package/xiaoma-core/data/{xiaoma-kb.md → bmad-kb.md} +48 -42
- package/xiaoma-core/data/brainstorming-techniques.md +2 -0
- package/xiaoma-core/data/elicitation-methods.md +22 -0
- package/xiaoma-core/data/technical-preferences.md +2 -0
- package/xiaoma-core/data/test-levels-framework.md +148 -0
- package/xiaoma-core/data/test-priorities-matrix.md +174 -0
- package/xiaoma-core/tasks/advanced-elicitation.md +2 -0
- package/xiaoma-core/tasks/apply-qa-fixes.md +150 -0
- package/xiaoma-core/tasks/brownfield-create-epic.md +2 -0
- package/xiaoma-core/tasks/brownfield-create-story.md +2 -0
- package/xiaoma-core/tasks/correct-course.md +2 -0
- package/xiaoma-core/tasks/create-brownfield-story.md +14 -4
- package/xiaoma-core/tasks/create-deep-research-prompt.md +2 -11
- package/xiaoma-core/tasks/create-next-story.md +3 -1
- package/xiaoma-core/tasks/document-project.md +17 -13
- package/xiaoma-core/tasks/facilitate-brainstorming-session.md +5 -3
- package/xiaoma-core/tasks/generate-ai-frontend-prompt.md +2 -0
- package/xiaoma-core/tasks/index-docs.md +2 -6
- package/xiaoma-core/tasks/kb-mode-interaction.md +17 -15
- package/xiaoma-core/tasks/nfr-assess.md +345 -0
- package/xiaoma-core/tasks/qa-gate.md +163 -0
- package/xiaoma-core/tasks/review-story.md +245 -74
- package/xiaoma-core/tasks/risk-profile.md +355 -0
- package/xiaoma-core/tasks/shard-doc.md +2 -2
- package/xiaoma-core/tasks/test-design.md +176 -0
- package/xiaoma-core/tasks/trace-requirements.md +266 -0
- package/xiaoma-core/tasks/validate-next-story.md +5 -3
- package/xiaoma-core/templates/architecture-tmpl.yaml +50 -49
- package/xiaoma-core/templates/brainstorming-output-tmpl.yaml +5 -5
- package/xiaoma-core/templates/brownfield-architecture-tmpl.yaml +32 -31
- package/xiaoma-core/templates/brownfield-prd-tmpl.yaml +14 -13
- package/xiaoma-core/templates/competitor-analysis-tmpl.yaml +20 -6
- package/xiaoma-core/templates/front-end-architecture-tmpl.yaml +22 -9
- package/xiaoma-core/templates/front-end-spec-tmpl.yaml +25 -24
- package/xiaoma-core/templates/fullstack-architecture-tmpl.yaml +123 -104
- package/xiaoma-core/templates/market-research-tmpl.yaml +3 -2
- package/xiaoma-core/templates/prd-tmpl.yaml +10 -9
- package/xiaoma-core/templates/project-brief-tmpl.yaml +5 -4
- package/xiaoma-core/templates/qa-gate-tmpl.yaml +103 -0
- package/xiaoma-core/templates/story-tmpl.yaml +13 -12
- package/xiaoma-core/workflows/brownfield-fullstack.yaml +13 -12
- package/xiaoma-core/workflows/brownfield-service.yaml +5 -4
- package/xiaoma-core/workflows/brownfield-ui.yaml +5 -4
- package/xiaoma-core/workflows/greenfield-fullstack.yaml +7 -6
- package/xiaoma-core/workflows/greenfield-service.yaml +5 -4
- package/xiaoma-core/workflows/greenfield-ui.yaml +6 -5
- package/.releaserc.json +0 -18
- package/README.md +0 -532
- package/dist/agents/analyst.txt +0 -2882
- package/dist/agents/architect.txt +0 -3543
- package/dist/agents/dev.txt +0 -428
- package/dist/agents/pm.txt +0 -2229
- package/dist/agents/po.txt +0 -1364
- package/dist/agents/qa.txt +0 -386
- package/dist/agents/sm.txt +0 -668
- package/dist/agents/ux-expert.txt +0 -701
- package/dist/agents/xiaoma-master.txt +0 -8756
- package/dist/agents/xiaoma-orchestrator.txt +0 -1490
- package/dist/teams/team-all.txt +0 -11062
- package/dist/teams/team-fullstack.txt +0 -10392
- package/dist/teams/team-ide-minimal.txt +0 -3507
- package/dist/teams/team-no-ui.txt +0 -8951
- package/docs/quick-start.md +0 -179
- package/tools/bmad-npx-wrapper.js +0 -39
- package/tools/installer/package-lock.json +0 -704
- package/tools/semantic-release-sync-installer.js +0 -30
- package/xiaoma-core/bmad-core/user-guide.md +0 -0
- package/xiaoma-core/enhanced-ide-development-workflow.md +0 -43
- package/xiaoma-core/user-guide.md +0 -251
- package/xiaoma-core/working-in-the-brownfield.md +0 -364
package/xiaoma-core/agents/sm.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# sm
|
|
2
4
|
|
|
3
5
|
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
|
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
|
|
17
19
|
activation-instructions:
|
|
18
20
|
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
|
19
21
|
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
|
20
|
-
- STEP 3:
|
|
22
|
+
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
|
23
|
+
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
|
|
21
24
|
- DO NOT: Load any other agent files during activation
|
|
22
25
|
- ONLY load dependency files when user selects them for execution via command or request of a task
|
|
23
26
|
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
|
@@ -26,9 +29,9 @@ activation-instructions:
|
|
|
26
29
|
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
|
27
30
|
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
28
31
|
- STAY IN CHARACTER!
|
|
29
|
-
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
|
32
|
+
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
|
30
33
|
agent:
|
|
31
|
-
name:
|
|
34
|
+
name: Bob
|
|
32
35
|
id: sm
|
|
33
36
|
title: Scrum Master
|
|
34
37
|
icon: 🏃
|
|
@@ -44,19 +47,19 @@ persona:
|
|
|
44
47
|
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
|
|
45
48
|
- You are NOT allowed to implement stories or modify code EVER!
|
|
46
49
|
# All commands require * prefix when used (e.g., *help)
|
|
47
|
-
commands:
|
|
50
|
+
commands:
|
|
48
51
|
- help: Show numbered list of the following commands to allow selection
|
|
49
|
-
- draft: Execute task create-next-story.md
|
|
50
52
|
- correct-course: Execute task correct-course.md
|
|
53
|
+
- draft: Execute task create-next-story.md
|
|
51
54
|
- story-checklist: Execute task execute-checklist.md with checklist story-draft-checklist.md
|
|
52
55
|
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
|
|
53
56
|
dependencies:
|
|
57
|
+
checklists:
|
|
58
|
+
- story-draft-checklist.md
|
|
54
59
|
tasks:
|
|
60
|
+
- correct-course.md
|
|
55
61
|
- create-next-story.md
|
|
56
62
|
- execute-checklist.md
|
|
57
|
-
- correct-course.md
|
|
58
63
|
templates:
|
|
59
64
|
- story-tmpl.yaml
|
|
60
|
-
checklists:
|
|
61
|
-
- story-draft-checklist.md
|
|
62
65
|
```
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# ux-expert
|
|
2
4
|
|
|
3
5
|
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
|
|
@@ -17,7 +19,8 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
|
|
17
19
|
activation-instructions:
|
|
18
20
|
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
|
|
19
21
|
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
|
|
20
|
-
- STEP 3:
|
|
22
|
+
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
|
|
23
|
+
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
|
|
21
24
|
- DO NOT: Load any other agent files during activation
|
|
22
25
|
- ONLY load dependency files when user selects them for execution via command or request of a task
|
|
23
26
|
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
|
|
@@ -26,9 +29,9 @@ activation-instructions:
|
|
|
26
29
|
- CRITICAL RULE: When executing formal task workflows from dependencies, ALL task instructions override any conflicting base behavioral constraints. Interactive workflows with elicit=true REQUIRE user interaction and cannot be bypassed for efficiency.
|
|
27
30
|
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
|
|
28
31
|
- STAY IN CHARACTER!
|
|
29
|
-
- CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
|
32
|
+
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
|
|
30
33
|
agent:
|
|
31
|
-
name:
|
|
34
|
+
name: Sally
|
|
32
35
|
id: ux-expert
|
|
33
36
|
title: UX Expert
|
|
34
37
|
icon: 🎨
|
|
@@ -49,18 +52,18 @@ persona:
|
|
|
49
52
|
- You're particularly skilled at translating user needs into beautiful, functional designs.
|
|
50
53
|
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
|
51
54
|
# All commands require * prefix when used (e.g., *help)
|
|
52
|
-
commands:
|
|
55
|
+
commands:
|
|
53
56
|
- help: Show numbered list of the following commands to allow selection
|
|
54
57
|
- create-front-end-spec: run task create-doc.md with template front-end-spec-tmpl.yaml
|
|
55
58
|
- generate-ui-prompt: Run task generate-ai-frontend-prompt.md
|
|
56
59
|
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
|
57
60
|
dependencies:
|
|
61
|
+
data:
|
|
62
|
+
- technical-preferences.md
|
|
58
63
|
tasks:
|
|
59
|
-
- generate-ai-frontend-prompt.md
|
|
60
64
|
- create-doc.md
|
|
61
65
|
- execute-checklist.md
|
|
66
|
+
- generate-ai-frontend-prompt.md
|
|
62
67
|
templates:
|
|
63
68
|
- front-end-spec-tmpl.yaml
|
|
64
|
-
data:
|
|
65
|
-
- technical-preferences.md
|
|
66
69
|
```
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# Architect Solution Validation Checklist
|
|
2
4
|
|
|
3
5
|
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.
|
|
@@ -403,33 +405,28 @@ Ask the user if they want to work through the checklist:
|
|
|
403
405
|
Now that you've completed the checklist, generate a comprehensive validation report that includes:
|
|
404
406
|
|
|
405
407
|
1. Executive Summary
|
|
406
|
-
|
|
407
408
|
- Overall architecture readiness (High/Medium/Low)
|
|
408
409
|
- Critical risks identified
|
|
409
410
|
- Key strengths of the architecture
|
|
410
411
|
- Project type (Full-stack/Frontend/Backend) and sections evaluated
|
|
411
412
|
|
|
412
413
|
2. Section Analysis
|
|
413
|
-
|
|
414
414
|
- Pass rate for each major section (percentage of items passed)
|
|
415
415
|
- Most concerning failures or gaps
|
|
416
416
|
- Sections requiring immediate attention
|
|
417
417
|
- Note any sections skipped due to project type
|
|
418
418
|
|
|
419
419
|
3. Risk Assessment
|
|
420
|
-
|
|
421
420
|
- Top 5 risks by severity
|
|
422
421
|
- Mitigation recommendations for each
|
|
423
422
|
- Timeline impact of addressing issues
|
|
424
423
|
|
|
425
424
|
4. Recommendations
|
|
426
|
-
|
|
427
425
|
- Must-fix items before development
|
|
428
426
|
- Should-fix items for better quality
|
|
429
427
|
- Nice-to-have improvements
|
|
430
428
|
|
|
431
429
|
5. AI Implementation Readiness
|
|
432
|
-
|
|
433
430
|
- Specific concerns for AI agent implementation
|
|
434
431
|
- Areas needing additional clarification
|
|
435
432
|
- Complexity hotspots to address
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# Change Navigation Checklist
|
|
2
4
|
|
|
3
|
-
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the
|
|
5
|
+
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
|
4
6
|
|
|
5
7
|
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
|
6
8
|
|
|
@@ -75,7 +77,7 @@ Think about both immediate and downstream effects.]]
|
|
|
75
77
|
|
|
76
78
|
## 3. Artifact Conflict & Impact Analysis
|
|
77
79
|
|
|
78
|
-
[[LLM: Documentation drives development in
|
|
80
|
+
[[LLM: Documentation drives development in BMad. Check each artifact:
|
|
79
81
|
|
|
80
82
|
1. Does this change invalidate documented decisions?
|
|
81
83
|
2. Are architectural assumptions still valid?
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# Product Manager (PM) Requirements Checklist
|
|
2
4
|
|
|
3
5
|
This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
|
|
@@ -304,7 +306,6 @@ Ask the user if they want to work through the checklist:
|
|
|
304
306
|
Create a comprehensive validation report that includes:
|
|
305
307
|
|
|
306
308
|
1. Executive Summary
|
|
307
|
-
|
|
308
309
|
- Overall PRD completeness (percentage)
|
|
309
310
|
- MVP scope appropriateness (Too Large/Just Right/Too Small)
|
|
310
311
|
- Readiness for architecture phase (Ready/Nearly Ready/Not Ready)
|
|
@@ -312,26 +313,22 @@ Create a comprehensive validation report that includes:
|
|
|
312
313
|
|
|
313
314
|
2. Category Analysis Table
|
|
314
315
|
Fill in the actual table with:
|
|
315
|
-
|
|
316
316
|
- Status: PASS (90%+ complete), PARTIAL (60-89%), FAIL (<60%)
|
|
317
317
|
- Critical Issues: Specific problems that block progress
|
|
318
318
|
|
|
319
319
|
3. Top Issues by Priority
|
|
320
|
-
|
|
321
320
|
- BLOCKERS: Must fix before architect can proceed
|
|
322
321
|
- HIGH: Should fix for quality
|
|
323
322
|
- MEDIUM: Would improve clarity
|
|
324
323
|
- LOW: Nice to have
|
|
325
324
|
|
|
326
325
|
4. MVP Scope Assessment
|
|
327
|
-
|
|
328
326
|
- Features that might be cut for true MVP
|
|
329
327
|
- Missing features that are essential
|
|
330
328
|
- Complexity concerns
|
|
331
329
|
- Timeline realism
|
|
332
330
|
|
|
333
331
|
5. Technical Readiness
|
|
334
|
-
|
|
335
332
|
- Clarity of technical constraints
|
|
336
333
|
- Identified technical risks
|
|
337
334
|
- Areas needing architect investigation
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# Product Owner (PO) Master Validation Checklist
|
|
2
4
|
|
|
3
5
|
This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
|
|
@@ -8,12 +10,10 @@ PROJECT TYPE DETECTION:
|
|
|
8
10
|
First, determine the project type by checking:
|
|
9
11
|
|
|
10
12
|
1. Is this a GREENFIELD project (new from scratch)?
|
|
11
|
-
|
|
12
13
|
- Look for: New project initialization, no existing codebase references
|
|
13
14
|
- Check for: prd.md, architecture.md, new project setup stories
|
|
14
15
|
|
|
15
16
|
2. Is this a BROWNFIELD project (enhancing existing system)?
|
|
16
|
-
|
|
17
17
|
- Look for: References to existing codebase, enhancement/modification language
|
|
18
18
|
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
|
|
19
19
|
|
|
@@ -347,7 +347,6 @@ Ask the user if they want to work through the checklist:
|
|
|
347
347
|
Generate a comprehensive validation report that adapts to project type:
|
|
348
348
|
|
|
349
349
|
1. Executive Summary
|
|
350
|
-
|
|
351
350
|
- Project type: [Greenfield/Brownfield] with [UI/No UI]
|
|
352
351
|
- Overall readiness (percentage)
|
|
353
352
|
- Go/No-Go recommendation
|
|
@@ -357,42 +356,36 @@ Generate a comprehensive validation report that adapts to project type:
|
|
|
357
356
|
2. Project-Specific Analysis
|
|
358
357
|
|
|
359
358
|
FOR GREENFIELD:
|
|
360
|
-
|
|
361
359
|
- Setup completeness
|
|
362
360
|
- Dependency sequencing
|
|
363
361
|
- MVP scope appropriateness
|
|
364
362
|
- Development timeline feasibility
|
|
365
363
|
|
|
366
364
|
FOR BROWNFIELD:
|
|
367
|
-
|
|
368
365
|
- Integration risk level (High/Medium/Low)
|
|
369
366
|
- Existing system impact assessment
|
|
370
367
|
- Rollback readiness
|
|
371
368
|
- User disruption potential
|
|
372
369
|
|
|
373
370
|
3. Risk Assessment
|
|
374
|
-
|
|
375
371
|
- Top 5 risks by severity
|
|
376
372
|
- Mitigation recommendations
|
|
377
373
|
- Timeline impact of addressing issues
|
|
378
374
|
- [BROWNFIELD] Specific integration risks
|
|
379
375
|
|
|
380
376
|
4. MVP Completeness
|
|
381
|
-
|
|
382
377
|
- Core features coverage
|
|
383
378
|
- Missing essential functionality
|
|
384
379
|
- Scope creep identified
|
|
385
380
|
- True MVP vs over-engineering
|
|
386
381
|
|
|
387
382
|
5. Implementation Readiness
|
|
388
|
-
|
|
389
383
|
- Developer clarity score (1-10)
|
|
390
384
|
- Ambiguous requirements count
|
|
391
385
|
- Missing technical details
|
|
392
386
|
- [BROWNFIELD] Integration point clarity
|
|
393
387
|
|
|
394
388
|
6. Recommendations
|
|
395
|
-
|
|
396
389
|
- Must-fix before development
|
|
397
390
|
- Should-fix for quality
|
|
398
391
|
- Consider for improvement
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# Story Definition of Done (DoD) Checklist
|
|
2
4
|
|
|
3
5
|
## Instructions for Developer Agent
|
|
@@ -25,14 +27,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
25
27
|
1. **Requirements Met:**
|
|
26
28
|
|
|
27
29
|
[[LLM: Be specific - list each requirement and whether it's complete]]
|
|
28
|
-
|
|
29
30
|
- [ ] All functional requirements specified in the story are implemented.
|
|
30
31
|
- [ ] All acceptance criteria defined in the story are met.
|
|
31
32
|
|
|
32
33
|
2. **Coding Standards & Project Structure:**
|
|
33
34
|
|
|
34
35
|
[[LLM: Code quality matters for maintainability. Check each item carefully]]
|
|
35
|
-
|
|
36
36
|
- [ ] All new/modified code strictly adheres to `Operational Guidelines`.
|
|
37
37
|
- [ ] All new/modified code aligns with `Project Structure` (file locations, naming, etc.).
|
|
38
38
|
- [ ] Adherence to `Tech Stack` for technologies/versions used (if story introduces or modifies tech usage).
|
|
@@ -44,7 +44,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
44
44
|
3. **Testing:**
|
|
45
45
|
|
|
46
46
|
[[LLM: Testing proves your code works. Be honest about test coverage]]
|
|
47
|
-
|
|
48
47
|
- [ ] All required unit tests as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
49
48
|
- [ ] All required integration tests (if applicable) as per the story and `Operational Guidelines` Testing Strategy are implemented.
|
|
50
49
|
- [ ] All tests (unit, integration, E2E if applicable) pass successfully.
|
|
@@ -53,14 +52,12 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
53
52
|
4. **Functionality & Verification:**
|
|
54
53
|
|
|
55
54
|
[[LLM: Did you actually run and test your code? Be specific about what you tested]]
|
|
56
|
-
|
|
57
55
|
- [ ] Functionality has been manually verified by the developer (e.g., running the app locally, checking UI, testing API endpoints).
|
|
58
56
|
- [ ] Edge cases and potential error conditions considered and handled gracefully.
|
|
59
57
|
|
|
60
58
|
5. **Story Administration:**
|
|
61
59
|
|
|
62
60
|
[[LLM: Documentation helps the next developer. What should they know?]]
|
|
63
|
-
|
|
64
61
|
- [ ] All tasks within the story file are marked as complete.
|
|
65
62
|
- [ ] Any clarifications or decisions made during development are documented in the story file or linked appropriately.
|
|
66
63
|
- [ ] The story wrap up section has been completed with notes of changes or information relevant to the next story or overall project, the agent model that was primarily used during development, and the changelog of any changes is properly updated.
|
|
@@ -68,7 +65,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
68
65
|
6. **Dependencies, Build & Configuration:**
|
|
69
66
|
|
|
70
67
|
[[LLM: Build issues block everyone. Ensure everything compiles and runs cleanly]]
|
|
71
|
-
|
|
72
68
|
- [ ] Project builds successfully without errors.
|
|
73
69
|
- [ ] Project linting passes
|
|
74
70
|
- [ ] Any new dependencies added were either pre-approved in the story requirements OR explicitly approved by the user during development (approval documented in story file).
|
|
@@ -79,7 +75,6 @@ The goal is quality delivery, not just checking boxes.]]
|
|
|
79
75
|
7. **Documentation (If Applicable):**
|
|
80
76
|
|
|
81
77
|
[[LLM: Good documentation prevents future confusion. What needs explaining?]]
|
|
82
|
-
|
|
83
78
|
- [ ] Relevant inline code documentation (e.g., JSDoc, TSDoc, Python docstrings) for new public APIs or complex logic is complete.
|
|
84
79
|
- [ ] User-facing documentation updated, if changes impact users.
|
|
85
80
|
- [ ] Technical documentation (e.g., READMEs, system diagrams) updated if significant architectural changes were made.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
1
3
|
# Story Draft Checklist
|
|
2
4
|
|
|
3
5
|
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
|
|
@@ -117,19 +119,16 @@ Note: We don't need every file listed - just the important ones.]]
|
|
|
117
119
|
Generate a concise validation report:
|
|
118
120
|
|
|
119
121
|
1. Quick Summary
|
|
120
|
-
|
|
121
122
|
- Story readiness: READY / NEEDS REVISION / BLOCKED
|
|
122
123
|
- Clarity score (1-10)
|
|
123
124
|
- Major gaps identified
|
|
124
125
|
|
|
125
126
|
2. Fill in the validation table with:
|
|
126
|
-
|
|
127
127
|
- PASS: Requirements clearly met
|
|
128
128
|
- PARTIAL: Some gaps but workable
|
|
129
129
|
- FAIL: Critical information missing
|
|
130
130
|
|
|
131
131
|
3. Specific Issues (if any)
|
|
132
|
-
|
|
133
132
|
- List concrete problems to fix
|
|
134
133
|
- Suggest specific improvements
|
|
135
134
|
- Identify any blocking dependencies
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
# <!-- Powered by BMAD™ Core -->
|
|
1
2
|
markdownExploder: true
|
|
3
|
+
qa:
|
|
4
|
+
qaLocation: docs/qa
|
|
2
5
|
prd:
|
|
3
6
|
prdFile: docs/prd.md
|
|
4
7
|
prdVersion: v4
|
|
@@ -17,4 +20,4 @@ devLoadAlwaysFiles:
|
|
|
17
20
|
- docs/architecture/source-tree.md
|
|
18
21
|
devDebugLog: .ai/debug-log.md
|
|
19
22
|
devStoryLocation: docs/stories
|
|
20
|
-
slashPrefix:
|
|
23
|
+
slashPrefix: BMad
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- Powered by BMAD™ Core -->
|
|
2
|
+
|
|
3
|
+
# BMAD™ Knowledge Base
|
|
2
4
|
|
|
3
5
|
## Overview
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
|
|
6
8
|
|
|
7
9
|
### Key Features
|
|
8
10
|
|
|
@@ -12,7 +14,7 @@ XiaoMa-Method (Breakthrough Method of Agile AI-driven Development) is a framewor
|
|
|
12
14
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
13
15
|
- **Slash Command Integration**: Quick agent switching and control
|
|
14
16
|
|
|
15
|
-
### When to Use
|
|
17
|
+
### When to Use BMad
|
|
16
18
|
|
|
17
19
|
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
18
20
|
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
@@ -20,11 +22,11 @@ XiaoMa-Method (Breakthrough Method of Agile AI-driven Development) is a framewor
|
|
|
20
22
|
- **Quality Assurance**: Structured testing and validation
|
|
21
23
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
22
24
|
|
|
23
|
-
## How
|
|
25
|
+
## How BMad Works
|
|
24
26
|
|
|
25
27
|
### The Core Method
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
28
30
|
|
|
29
31
|
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
30
32
|
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
@@ -86,7 +88,7 @@ XiaoMa transforms you into a "Vibe CEO" - directing a team of specialized AI age
|
|
|
86
88
|
|
|
87
89
|
```bash
|
|
88
90
|
# Interactive installation (recommended)
|
|
89
|
-
npx
|
|
91
|
+
npx bmad-method install
|
|
90
92
|
```
|
|
91
93
|
|
|
92
94
|
**Installation Steps**:
|
|
@@ -100,16 +102,17 @@ npx xiaoma-web install
|
|
|
100
102
|
- **Cline**: VS Code extension with AI features
|
|
101
103
|
- **Roo Code**: Web-based IDE with agent support
|
|
102
104
|
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
|
|
105
|
+
- **Auggie CLI (Augment Code)**: AI-powered development environment
|
|
103
106
|
|
|
104
|
-
**Note for VS Code Users**:
|
|
107
|
+
**Note for VS Code Users**: BMAD-METHOD™ assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
|
105
108
|
|
|
106
109
|
**Verify Installation**:
|
|
107
110
|
|
|
108
|
-
- `.
|
|
111
|
+
- `.bmad-core/` folder created with all agents
|
|
109
112
|
- IDE-specific integration files created
|
|
110
113
|
- All agent commands/rules/modes available
|
|
111
114
|
|
|
112
|
-
**Remember**: At its core,
|
|
115
|
+
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
|
|
113
116
|
|
|
114
117
|
### Environment Selection Guide
|
|
115
118
|
|
|
@@ -153,23 +156,23 @@ npx xiaoma-web install
|
|
|
153
156
|
- **Why it matters**: Dev agents are kept lean to maximize coding context
|
|
154
157
|
- **The principle**: "Dev agents code, planning agents plan" - mixing breaks this optimization
|
|
155
158
|
|
|
156
|
-
**About
|
|
159
|
+
**About bmad-master and bmad-orchestrator**:
|
|
157
160
|
|
|
158
|
-
- **
|
|
161
|
+
- **bmad-master**: CAN do any task without switching agents, BUT...
|
|
159
162
|
- **Still use specialized agents for planning**: PM, Architect, and UX Expert have tuned personas that produce better results
|
|
160
163
|
- **Why specialization matters**: Each agent's personality and focus creates higher quality outputs
|
|
161
|
-
- **If using
|
|
164
|
+
- **If using bmad-master/orchestrator**: Fine for planning phases, but...
|
|
162
165
|
|
|
163
166
|
**CRITICAL RULE for Development**:
|
|
164
167
|
|
|
165
|
-
- **ALWAYS use SM agent for story creation** - Never use
|
|
166
|
-
- **ALWAYS use Dev agent for implementation** - Never use
|
|
168
|
+
- **ALWAYS use SM agent for story creation** - Never use bmad-master or bmad-orchestrator
|
|
169
|
+
- **ALWAYS use Dev agent for implementation** - Never use bmad-master or bmad-orchestrator
|
|
167
170
|
- **Why this matters**: SM and Dev agents are specifically optimized for the development workflow
|
|
168
|
-
- **No exceptions**: Even if using
|
|
171
|
+
- **No exceptions**: Even if using bmad-master for everything else, switch to SM → Dev for implementation
|
|
169
172
|
|
|
170
173
|
**Best Practice for IDE-Only**:
|
|
171
174
|
|
|
172
|
-
1. Use PM/Architect/UX agents for planning (better than
|
|
175
|
+
1. Use PM/Architect/UX agents for planning (better than bmad-master)
|
|
173
176
|
2. Create documents directly in project
|
|
174
177
|
3. Shard immediately after creation
|
|
175
178
|
4. **MUST switch to SM agent** for story creation
|
|
@@ -178,11 +181,11 @@ npx xiaoma-web install
|
|
|
178
181
|
|
|
179
182
|
## Core Configuration (core-config.yaml)
|
|
180
183
|
|
|
181
|
-
**New in V4**: The `
|
|
184
|
+
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
182
185
|
|
|
183
186
|
### What is core-config.yaml?
|
|
184
187
|
|
|
185
|
-
This configuration file acts as a map for
|
|
188
|
+
This configuration file acts as a map for BMad agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
|
186
189
|
|
|
187
190
|
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
188
191
|
- **Custom Locations**: Define where your documents and shards live
|
|
@@ -214,7 +217,7 @@ This configuration file acts as a map for XiaoMa agents, telling them exactly wh
|
|
|
214
217
|
|
|
215
218
|
1. **No Forced Migrations**: Keep your existing document structure
|
|
216
219
|
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
217
|
-
3. **Custom Workflows**: Configure
|
|
220
|
+
3. **Custom Workflows**: Configure BMad to match your team's process
|
|
218
221
|
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
219
222
|
|
|
220
223
|
### Common Configurations
|
|
@@ -287,8 +290,8 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
287
290
|
|
|
288
291
|
| Agent | Role | Primary Functions | When to Use |
|
|
289
292
|
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
|
|
290
|
-
| `
|
|
291
|
-
| `
|
|
293
|
+
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
|
|
294
|
+
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
|
|
292
295
|
|
|
293
296
|
### Agent Interaction Commands
|
|
294
297
|
|
|
@@ -296,11 +299,11 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
296
299
|
|
|
297
300
|
**Agent Loading by IDE**:
|
|
298
301
|
|
|
299
|
-
- **Claude Code**: `/agent-name` (e.g., `/
|
|
302
|
+
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
300
303
|
- **Cursor**: `@agent-name` (e.g., `@xiaoma-master`)
|
|
301
|
-
- **Windsurf**:
|
|
304
|
+
- **Windsurf**: `/agent-name` (e.g., `/bmad-master`)
|
|
302
305
|
- **Trae**: `@agent-name` (e.g., `@xiaoma-master`)
|
|
303
|
-
- **Roo Code**: Select mode from mode selector (e.g., `
|
|
306
|
+
- **Roo Code**: Select mode from mode selector (e.g., `bmad-master`)
|
|
304
307
|
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
305
308
|
|
|
306
309
|
**Chat Management Guidelines**:
|
|
@@ -353,24 +356,24 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
353
356
|
|
|
354
357
|
### System Overview
|
|
355
358
|
|
|
356
|
-
The
|
|
359
|
+
The BMAD-METHOD™ is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
|
|
357
360
|
|
|
358
361
|
### Key Architectural Components
|
|
359
362
|
|
|
360
|
-
#### 1. Agents (`
|
|
363
|
+
#### 1. Agents (`bmad-core/agents/`)
|
|
361
364
|
|
|
362
365
|
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
|
|
363
366
|
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
|
|
364
367
|
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
|
|
365
368
|
- **Startup Instructions**: Can load project-specific documentation for immediate context
|
|
366
369
|
|
|
367
|
-
#### 2. Agent Teams (`
|
|
370
|
+
#### 2. Agent Teams (`bmad-core/agent-teams/`)
|
|
368
371
|
|
|
369
372
|
- **Purpose**: Define collections of agents bundled together for specific purposes
|
|
370
373
|
- **Examples**: `team-all.yaml` (comprehensive bundle), `team-fullstack.yaml` (full-stack development)
|
|
371
374
|
- **Usage**: Creates pre-packaged contexts for web UI environments
|
|
372
375
|
|
|
373
|
-
#### 3. Workflows (`
|
|
376
|
+
#### 3. Workflows (`bmad-core/workflows/`)
|
|
374
377
|
|
|
375
378
|
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
|
|
376
379
|
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
|
|
@@ -378,10 +381,10 @@ The XiaoMa-Method is built around a modular architecture centered on the `xiaoma
|
|
|
378
381
|
|
|
379
382
|
#### 4. Reusable Resources
|
|
380
383
|
|
|
381
|
-
- **Templates** (`
|
|
382
|
-
- **Tasks** (`
|
|
383
|
-
- **Checklists** (`
|
|
384
|
-
- **Data** (`
|
|
384
|
+
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
|
|
385
|
+
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
|
|
386
|
+
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
|
|
387
|
+
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
|
|
385
388
|
|
|
386
389
|
### Dual Environment Architecture
|
|
387
390
|
|
|
@@ -401,9 +404,9 @@ The XiaoMa-Method is built around a modular architecture centered on the `xiaoma
|
|
|
401
404
|
|
|
402
405
|
### Template Processing System
|
|
403
406
|
|
|
404
|
-
|
|
407
|
+
BMad employs a sophisticated template system with three key components:
|
|
405
408
|
|
|
406
|
-
1. **Template Format** (`utils/
|
|
409
|
+
1. **Template Format** (`utils/bmad-doc-template.md`): Defines markup language for variable substitution and AI processing directives from yaml templates
|
|
407
410
|
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction to transform yaml spec to final markdown output
|
|
408
411
|
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
|
|
409
412
|
|
|
@@ -425,7 +428,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
|
|
425
428
|
3. Concatenating content into single text files with clear separators
|
|
426
429
|
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
427
430
|
|
|
428
|
-
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes
|
|
431
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
|
429
432
|
|
|
430
433
|
## Complete Development Workflow
|
|
431
434
|
|
|
@@ -542,7 +545,7 @@ Each status change requires user verification and approval before proceeding.
|
|
|
542
545
|
#### Greenfield Development
|
|
543
546
|
|
|
544
547
|
- Business analysis and market research
|
|
545
|
-
- Product requirements and feature definition
|
|
548
|
+
- Product requirements and feature definition
|
|
546
549
|
- System architecture and design
|
|
547
550
|
- Development execution
|
|
548
551
|
- Testing and deployment
|
|
@@ -651,8 +654,11 @@ Templates with Level 2 headings (`##`) can be automatically sharded:
|
|
|
651
654
|
|
|
652
655
|
```markdown
|
|
653
656
|
## Goals and Background Context
|
|
654
|
-
|
|
657
|
+
|
|
658
|
+
## Requirements
|
|
659
|
+
|
|
655
660
|
## User Interface Design Goals
|
|
661
|
+
|
|
656
662
|
## Success Metrics
|
|
657
663
|
```
|
|
658
664
|
|
|
@@ -692,7 +698,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
692
698
|
|
|
693
699
|
### Performance Optimization
|
|
694
700
|
|
|
695
|
-
- Use specific agents vs. `
|
|
701
|
+
- Use specific agents vs. `bmad-master` for focused tasks
|
|
696
702
|
- Choose appropriate team size for project needs
|
|
697
703
|
- Leverage technical preferences for consistency
|
|
698
704
|
- Regular context management and cache clearing
|
|
@@ -700,12 +706,12 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
700
706
|
## Success Tips
|
|
701
707
|
|
|
702
708
|
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
|
703
|
-
- **Use
|
|
709
|
+
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
|
704
710
|
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
|
705
711
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
706
712
|
- **Review everything** - Always review and approve before marking complete
|
|
707
713
|
|
|
708
|
-
## Contributing to
|
|
714
|
+
## Contributing to BMAD-METHOD™
|
|
709
715
|
|
|
710
716
|
### Quick Contribution Guidelines
|
|
711
717
|
|
|
@@ -737,7 +743,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|
|
737
743
|
|
|
738
744
|
### What Are Expansion Packs?
|
|
739
745
|
|
|
740
|
-
Expansion packs extend
|
|
746
|
+
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
|
741
747
|
|
|
742
748
|
### Why Use Expansion Packs?
|
|
743
749
|
|
|
@@ -777,7 +783,7 @@ Expansion packs extend XiaoMa-Method beyond traditional software development int
|
|
|
777
783
|
3. **Install via CLI**:
|
|
778
784
|
|
|
779
785
|
```bash
|
|
780
|
-
npx
|
|
786
|
+
npx bmad-method install
|
|
781
787
|
# Select "Install expansion pack" option
|
|
782
788
|
```
|
|
783
789
|
|