bmad-method 5.0.0 → 5.1.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 +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 +25 -0
- package/.github/workflows/format-check.yaml +42 -0
- package/.github/workflows/manual-release.yaml +173 -0
- package/.husky/pre-commit +3 -2
- package/.vscode/settings.json +67 -74
- package/CHANGELOG.md +564 -19
- package/CONTRIBUTING.md +168 -5
- package/LICENSE +1 -1
- package/README.md +146 -218
- package/bmad-core/agent-teams/team-all.yaml +14 -0
- package/bmad-core/agent-teams/team-fullstack.yaml +18 -0
- package/bmad-core/agent-teams/team-ide-minimal.yaml +10 -0
- package/bmad-core/agent-teams/team-no-ui.yaml +13 -0
- package/bmad-core/agents/analyst.md +81 -0
- package/bmad-core/agents/architect.md +83 -0
- package/bmad-core/agents/bmad-master.md +107 -0
- package/bmad-core/agents/bmad-orchestrator.md +149 -0
- package/bmad-core/agents/dev.md +75 -0
- package/bmad-core/agents/pm.md +81 -0
- package/bmad-core/agents/po.md +76 -0
- package/bmad-core/agents/qa.md +88 -0
- package/bmad-core/agents/sm.md +62 -0
- package/bmad-core/agents/ux-expert.md +66 -0
- package/{.bmad-core → bmad-core}/checklists/architect-checklist.md +0 -5
- package/{.bmad-core → bmad-core}/checklists/change-checklist.md +2 -2
- package/{.bmad-core → bmad-core}/checklists/pm-checklist.md +0 -5
- package/{.bmad-core → bmad-core}/checklists/po-master-checklist.md +0 -9
- package/{.bmad-core → bmad-core}/checklists/story-dod-checklist.md +0 -7
- package/{.bmad-core → bmad-core}/checklists/story-draft-checklist.md +1 -4
- package/bmad-core/core-config.yaml +20 -0
- package/bmad-core/data/bmad-kb.md +806 -0
- package/bmad-core/data/brainstorming-techniques.md +36 -0
- package/bmad-core/data/elicitation-methods.md +154 -0
- package/bmad-core/data/test-levels-framework.md +146 -0
- package/bmad-core/data/test-priorities-matrix.md +172 -0
- package/bmad-core/tasks/advanced-elicitation.md +117 -0
- package/{.bmad-core → bmad-core}/tasks/correct-course.md +9 -12
- package/bmad-core/tasks/create-brownfield-story.md +312 -0
- package/{.bmad-core → bmad-core}/tasks/create-deep-research-prompt.md +4 -27
- package/bmad-core/tasks/create-next-story.md +112 -0
- package/bmad-core/tasks/document-project.md +343 -0
- package/bmad-core/tasks/facilitate-brainstorming-session.md +136 -0
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +51 -0
- package/{.bmad-core → bmad-core}/tasks/index-docs.md +3 -13
- package/bmad-core/tasks/kb-mode-interaction.md +75 -0
- package/bmad-core/tasks/nfr-assess.md +343 -0
- package/bmad-core/tasks/qa-gate.md +159 -0
- package/bmad-core/tasks/review-story.md +314 -0
- package/bmad-core/tasks/risk-profile.md +353 -0
- package/{.bmad-core → bmad-core}/tasks/shard-doc.md +27 -15
- package/bmad-core/tasks/test-design.md +174 -0
- package/bmad-core/tasks/trace-requirements.md +264 -0
- package/bmad-core/tasks/validate-next-story.md +134 -0
- package/bmad-core/templates/architecture-tmpl.yaml +650 -0
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +476 -0
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +280 -0
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +306 -0
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +218 -0
- package/bmad-core/templates/front-end-spec-tmpl.yaml +349 -0
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +823 -0
- package/bmad-core/templates/market-research-tmpl.yaml +252 -0
- package/bmad-core/templates/prd-tmpl.yaml +202 -0
- package/bmad-core/templates/project-brief-tmpl.yaml +221 -0
- package/bmad-core/templates/qa-gate-tmpl.yaml +102 -0
- package/bmad-core/templates/story-tmpl.yaml +137 -0
- package/bmad-core/workflows/brownfield-fullstack.yaml +297 -0
- package/bmad-core/workflows/brownfield-service.yaml +187 -0
- package/bmad-core/workflows/brownfield-ui.yaml +197 -0
- package/{.bmad-core/workflows/greenfield-fullstack.yml → bmad-core/workflows/greenfield-fullstack.yaml} +140 -77
- package/bmad-core/workflows/greenfield-service.yaml +206 -0
- package/bmad-core/workflows/greenfield-ui.yaml +235 -0
- package/common/tasks/create-doc.md +101 -0
- package/{.bmad-core → common}/tasks/execute-checklist.md +2 -13
- package/common/utils/bmad-doc-template.md +325 -0
- package/common/utils/workflow-management.md +69 -0
- package/dist/agents/analyst.txt +2889 -0
- package/dist/agents/architect.txt +3552 -0
- package/dist/agents/bmad-master.txt +8769 -0
- package/dist/agents/bmad-orchestrator.txt +1513 -0
- package/dist/agents/dev.txt +414 -0
- package/{.bmad-core/web-bundles → dist}/agents/pm.txt +668 -1119
- package/{.bmad-core/web-bundles → dist}/agents/po.txt +341 -484
- package/dist/agents/qa.txt +1987 -0
- package/dist/agents/sm.txt +658 -0
- package/dist/agents/ux-expert.txt +694 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2371 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +1620 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +815 -0
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +10952 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +4012 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +3698 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +450 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +973 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +15376 -0
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +2075 -0
- package/dist/teams/team-all.txt +12682 -0
- package/dist/teams/team-fullstack.txt +10421 -0
- package/dist/teams/team-ide-minimal.txt +5103 -0
- package/dist/teams/team-no-ui.txt +8980 -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 +280 -0
- package/docs/how-to-contribute-with-pull-requests.md +158 -0
- package/docs/user-guide.md +504 -0
- package/docs/versioning-and-releases.md +8 -16
- package/docs/versions.md +4 -5
- package/docs/working-in-the-brownfield.md +597 -0
- package/eslint.config.mjs +119 -0
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/Complete AI Agent System - Flowchart.svg +102 -0
- 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 +13 -0
- 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 +13 -0
- 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 +25 -0
- 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 +34 -0
- 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 +70 -0
- 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 +26 -0
- package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/README.md +109 -0
- package/expansion-packs/README.md +2 -112
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +13 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +71 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +78 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +64 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +201 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +160 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +8 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +250 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +647 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +110 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +216 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +290 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +613 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +356 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +343 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +253 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +484 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +183 -0
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +175 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +14 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +80 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +77 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +78 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +65 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +391 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +203 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +201 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +124 -0
- package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +6 -0
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +769 -0
- package/expansion-packs/bmad-2d-unity-game-dev/data/development-guidelines.md +586 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/advanced-elicitation.md +110 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +141 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +184 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md +290 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +200 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +1030 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +356 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +705 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +256 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +484 -0
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-dev-greenfield.yaml +183 -0
- package/expansion-packs/bmad-2d-unity-game-dev/workflows/game-prototype.yaml +175 -0
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/README.md +9 -9
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/agents/infra-devops-platform.md +30 -18
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/checklists/infrastructure-checklist.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +9 -0
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +305 -0
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/tasks/review-infrastructure.md +4 -5
- package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/tasks/validate-infrastructure.md +4 -5
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +424 -0
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +629 -0
- package/package.json +74 -42
- package/prettier.config.mjs +32 -0
- package/release_notes.md +25 -0
- package/tools/bmad-npx-wrapper.js +13 -15
- package/tools/builders/web-builder.js +544 -15
- package/tools/bump-all-versions.js +115 -0
- package/tools/bump-expansion-version.js +90 -0
- package/tools/cli.js +65 -32
- 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 +573 -0
- 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 +3 -53
- package/tools/installer/bin/bmad.js +475 -90
- package/tools/installer/config/ide-agent-config.yaml +58 -0
- package/tools/installer/config/install.config.yaml +123 -0
- package/tools/installer/lib/config-loader.js +208 -40
- package/tools/installer/lib/file-manager.js +258 -55
- package/tools/installer/lib/ide-base-setup.js +228 -0
- package/tools/installer/lib/ide-setup.js +1265 -253
- package/tools/installer/lib/installer.js +1651 -310
- package/tools/installer/lib/memory-profiler.js +225 -0
- package/tools/installer/lib/module-manager.js +114 -0
- package/tools/installer/lib/resource-locator.js +308 -0
- package/tools/installer/package.json +25 -24
- package/tools/lib/dependency-resolver.js +44 -48
- package/tools/lib/yaml-utils.js +29 -0
- package/tools/md-assets/web-agent-startup-instructions.md +39 -0
- package/tools/preview-release-notes.js +66 -0
- package/tools/shared/bannerArt.js +105 -0
- package/tools/sync-installer-version.js +7 -9
- package/tools/update-expansion-version.js +53 -0
- package/tools/upgraders/v3-to-v4-upgrader.js +221 -320
- package/tools/version-bump.js +42 -27
- package/tools/yaml-format.js +57 -44
- package/.bmad-core/agent-teams/team-all.yml +0 -16
- package/.bmad-core/agent-teams/team-fullstack.yml +0 -26
- package/.bmad-core/agent-teams/team-no-ui.yml +0 -15
- package/.bmad-core/agents/analyst.md +0 -59
- package/.bmad-core/agents/architect.md +0 -66
- package/.bmad-core/agents/bmad-master.md +0 -104
- package/.bmad-core/agents/bmad-orchestrator.md +0 -81
- package/.bmad-core/agents/dev.md +0 -70
- package/.bmad-core/agents/pm.md +0 -59
- package/.bmad-core/agents/po.md +0 -60
- package/.bmad-core/agents/qa.md +0 -52
- package/.bmad-core/agents/sm.md +0 -55
- package/.bmad-core/agents/ux-expert.md +0 -66
- package/.bmad-core/data/bmad-kb.md +0 -47
- package/.bmad-core/schemas/agent-team-schema.yml +0 -153
- package/.bmad-core/tasks/advanced-elicitation.md +0 -92
- package/.bmad-core/tasks/brainstorming-techniques.md +0 -238
- package/.bmad-core/tasks/core-dump.md +0 -74
- package/.bmad-core/tasks/create-agent.md +0 -202
- package/.bmad-core/tasks/create-doc.md +0 -74
- package/.bmad-core/tasks/create-expansion-pack.md +0 -425
- package/.bmad-core/tasks/create-next-story.md +0 -206
- package/.bmad-core/tasks/create-team.md +0 -229
- package/.bmad-core/tasks/doc-migration-task.md +0 -143
- package/.bmad-core/tasks/generate-ai-frontend-prompt.md +0 -58
- package/.bmad-core/templates/agent-tmpl.md +0 -58
- package/.bmad-core/templates/architecture-tmpl.md +0 -771
- package/.bmad-core/templates/brownfield-architecture-tmpl.md +0 -542
- package/.bmad-core/templates/brownfield-prd-tmpl.md +0 -240
- package/.bmad-core/templates/competitor-analysis-tmpl.md +0 -289
- package/.bmad-core/templates/expansion-pack-plan-tmpl.md +0 -91
- package/.bmad-core/templates/front-end-architecture-tmpl.md +0 -173
- package/.bmad-core/templates/front-end-spec-tmpl.md +0 -411
- package/.bmad-core/templates/fullstack-architecture-tmpl.md +0 -1016
- package/.bmad-core/templates/market-research-tmpl.md +0 -261
- package/.bmad-core/templates/prd-tmpl.md +0 -200
- package/.bmad-core/templates/project-brief-tmpl.md +0 -228
- package/.bmad-core/templates/simple-project-prd-tmpl.md +0 -461
- package/.bmad-core/templates/story-tmpl.md +0 -61
- package/.bmad-core/templates/web-agent-startup-instructions-template.md +0 -39
- package/.bmad-core/utils/agent-switcher.ide.md +0 -112
- package/.bmad-core/utils/template-format.md +0 -26
- package/.bmad-core/utils/workflow-management.md +0 -224
- package/.bmad-core/web-bundles/agents/analyst.txt +0 -1684
- package/.bmad-core/web-bundles/agents/architect.txt +0 -3584
- package/.bmad-core/web-bundles/agents/bmad-master.txt +0 -9491
- package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +0 -1466
- package/.bmad-core/web-bundles/agents/dev.txt +0 -316
- package/.bmad-core/web-bundles/agents/qa.txt +0 -129
- package/.bmad-core/web-bundles/agents/sm.txt +0 -658
- package/.bmad-core/web-bundles/agents/ux-expert.txt +0 -1099
- package/.bmad-core/web-bundles/teams/team-all.txt +0 -10757
- package/.bmad-core/web-bundles/teams/team-fullstack.txt +0 -10109
- package/.bmad-core/web-bundles/teams/team-no-ui.txt +0 -8950
- package/.bmad-core/workflows/brownfield-fullstack.yml +0 -116
- package/.bmad-core/workflows/brownfield-service.yml +0 -117
- package/.bmad-core/workflows/brownfield-ui.yml +0 -127
- package/.bmad-core/workflows/greenfield-service.yml +0 -143
- package/.bmad-core/workflows/greenfield-ui.yml +0 -172
- package/.claude/commands/analyst.md +0 -63
- package/.claude/commands/architect.md +0 -70
- package/.claude/commands/bmad-master.md +0 -108
- package/.claude/commands/bmad-orchestrator.md +0 -85
- package/.claude/commands/dev.md +0 -74
- package/.claude/commands/pm.md +0 -63
- package/.claude/commands/po.md +0 -64
- package/.claude/commands/qa.md +0 -56
- package/.claude/commands/sm.md +0 -59
- package/.claude/commands/ux-expert.md +0 -70
- package/.cursor/rules/analyst.mdc +0 -77
- package/.cursor/rules/architect.mdc +0 -84
- package/.cursor/rules/bmad-master.mdc +0 -122
- package/.cursor/rules/bmad-orchestrator.mdc +0 -99
- package/.cursor/rules/dev.mdc +0 -88
- package/.cursor/rules/pm.mdc +0 -77
- package/.cursor/rules/po.mdc +0 -78
- package/.cursor/rules/qa.mdc +0 -70
- package/.cursor/rules/sm.mdc +0 -73
- package/.cursor/rules/ux-expert.mdc +0 -84
- package/.github/workflows/release.yml +0 -59
- package/.releaserc.json +0 -18
- package/.roo/.roomodes +0 -95
- package/.roo/README.md +0 -38
- package/.vscode/extensions.json +0 -6
- package/.windsurf/rules/analyst.md +0 -71
- package/.windsurf/rules/architect.md +0 -78
- package/.windsurf/rules/bmad-master.md +0 -116
- package/.windsurf/rules/bmad-orchestrator.md +0 -93
- package/.windsurf/rules/dev.md +0 -82
- package/.windsurf/rules/pm.md +0 -71
- package/.windsurf/rules/po.md +0 -72
- package/.windsurf/rules/qa.md +0 -64
- package/.windsurf/rules/sm.md +0 -67
- package/.windsurf/rules/ux-expert.md +0 -78
- package/docs/bmad-workflow-guide.md +0 -161
- package/docs/claude-code-guide.md +0 -119
- package/docs/cursor-guide.md +0 -127
- package/docs/roo-code-guide.md +0 -140
- package/docs/sample-output/simple-fullstack-greenfield/prd.md +0 -42
- package/docs/windsurf-guide.md +0 -127
- package/expansion-packs/infrastructure-devops/manifest.yml +0 -38
- package/expansion-packs/infrastructure-devops/templates/infrastructure-architecture-tmpl.md +0 -415
- package/expansion-packs/infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
- package/tools/installer/config/install.config.yml +0 -139
- package/tools/installer/package-lock.json +0 -906
- package/tools/installer/templates/claude-commands.md +0 -7
- package/tools/installer/templates/cursor-rules.md +0 -22
- package/tools/installer/templates/windsurf-rules.md +0 -22
- package/tools/semantic-release-sync-installer.js +0 -31
- /package/{.bmad-core → bmad-core}/data/technical-preferences.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/brownfield-create-epic.md +0 -0
- /package/{.bmad-core → bmad-core}/tasks/brownfield-create-story.md +0 -0
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
# UX-EXPERT Agent Rule
|
|
2
|
-
|
|
3
|
-
This rule is triggered when the user types `@ux-expert` and activates the UX Expert agent persona.
|
|
4
|
-
|
|
5
|
-
## Agent Activation
|
|
6
|
-
|
|
7
|
-
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
8
|
-
|
|
9
|
-
```yml
|
|
10
|
-
activation-instructions:
|
|
11
|
-
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
|
|
12
|
-
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
13
|
-
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
14
|
-
- 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
|
|
15
|
-
|
|
16
|
-
agent:
|
|
17
|
-
name: Sally
|
|
18
|
-
id: ux-expert
|
|
19
|
-
title: UX Expert
|
|
20
|
-
icon: 🎨
|
|
21
|
-
whenToUse: "Use for UI/UX design, wireframes, prototypes, front-end specifications, and user experience optimization"
|
|
22
|
-
customization:
|
|
23
|
-
|
|
24
|
-
persona:
|
|
25
|
-
role: User Experience Designer & UI Specialist
|
|
26
|
-
style: Empathetic, creative, detail-oriented, user-obsessed, data-informed
|
|
27
|
-
identity: UX Expert specializing in user experience design and creating intuitive interfaces
|
|
28
|
-
focus: User research, interaction design, visual design, accessibility, AI-powered UI generation
|
|
29
|
-
|
|
30
|
-
core_principles:
|
|
31
|
-
- User-Centricity Above All - Every design decision must serve user needs
|
|
32
|
-
- Evidence-Based Design - Base decisions on research and testing, not assumptions
|
|
33
|
-
- Accessibility is Non-Negotiable - Design for the full spectrum of human diversity
|
|
34
|
-
- Simplicity Through Iteration - Start simple, refine based on feedback
|
|
35
|
-
- Consistency Builds Trust - Maintain consistent patterns and behaviors
|
|
36
|
-
- Delight in the Details - Thoughtful micro-interactions create memorable experiences
|
|
37
|
-
- Design for Real Scenarios - Consider edge cases, errors, and loading states
|
|
38
|
-
- Collaborate, Don't Dictate - Best solutions emerge from cross-functional work
|
|
39
|
-
- Measure and Learn - Continuously gather feedback and iterate
|
|
40
|
-
- Ethical Responsibility - Consider broader impact on user well-being and society
|
|
41
|
-
- You have a keen eye for detail and a deep empathy for users.
|
|
42
|
-
- You're particularly skilled at translating user needs into beautiful, functional designs.
|
|
43
|
-
- You can craft effective prompts for AI UI generation tools like v0, or Lovable.
|
|
44
|
-
|
|
45
|
-
startup:
|
|
46
|
-
- Greet the user with your name and role, and inform of the *help command.
|
|
47
|
-
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
|
|
48
|
-
|
|
49
|
-
commands:
|
|
50
|
-
- "*help" - Show: numbered list of the following commands to allow selection
|
|
51
|
-
- "*chat-mode" - (Default) UX consultation with advanced-elicitation for design decisions
|
|
52
|
-
- "*create-doc {template}" - Create doc (no template = show available templates)
|
|
53
|
-
- "*generate-ui-prompt" - Create AI frontend generation prompt
|
|
54
|
-
- "*research {topic}" - Generate deep research prompt for UX investigation
|
|
55
|
-
- "*execute-checklist {checklist}" - Run design validation checklist
|
|
56
|
-
- "*exit" - Say goodbye as the UX Expert, and then abandon inhabiting this persona
|
|
57
|
-
|
|
58
|
-
dependencies:
|
|
59
|
-
tasks:
|
|
60
|
-
- generate-ai-frontend-prompt
|
|
61
|
-
- create-deep-research-prompt
|
|
62
|
-
- create-doc
|
|
63
|
-
- execute-checklist
|
|
64
|
-
templates:
|
|
65
|
-
- front-end-spec-tmpl
|
|
66
|
-
data:
|
|
67
|
-
- technical-preferences
|
|
68
|
-
utils:
|
|
69
|
-
- template-format
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
## File Reference
|
|
73
|
-
|
|
74
|
-
The complete agent definition is available in [.bmad-core/agents/ux-expert.md](.bmad-core/agents/ux-expert.md).
|
|
75
|
-
|
|
76
|
-
## Usage
|
|
77
|
-
|
|
78
|
-
When the user types `@ux-expert`, activate this UX Expert persona and follow all instructions defined in the YML configuration above.
|
|
@@ -1,161 +0,0 @@
|
|
|
1
|
-
# BMAD Method Universal Workflow Guide
|
|
2
|
-
|
|
3
|
-
This guide outlines the core BMAD workflow that applies regardless of which AI-powered IDE you're using.
|
|
4
|
-
|
|
5
|
-
## Overview
|
|
6
|
-
|
|
7
|
-
The BMAD Method follows a structured approach to AI-assisted software development:
|
|
8
|
-
|
|
9
|
-
1. **Install BMAD** in your project
|
|
10
|
-
2. **Plan with Gemini** using team-fullstack
|
|
11
|
-
3. **Organize with bmad-master** (document sharding)
|
|
12
|
-
4. **Develop iteratively** with SM → Dev cycles
|
|
13
|
-
|
|
14
|
-
## The Complete Workflow
|
|
15
|
-
|
|
16
|
-
### Phase 1: Project Setup
|
|
17
|
-
|
|
18
|
-
1. **Install BMAD in your project**:
|
|
19
|
-
|
|
20
|
-
```bash
|
|
21
|
-
npx bmad-method install
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
- Choose "Complete installation"
|
|
25
|
-
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
|
26
|
-
|
|
27
|
-
2. **Verify installation**:
|
|
28
|
-
- `.bmad-core/` folder created with all agents
|
|
29
|
-
- IDE-specific integration files created
|
|
30
|
-
- All agent commands/rules/modes available
|
|
31
|
-
|
|
32
|
-
### Phase 2: Ideation & Planning (Gemini)
|
|
33
|
-
|
|
34
|
-
Use Google's Gemini for collaborative planning with the full team:
|
|
35
|
-
|
|
36
|
-
1. **Open [Google AI Studio](https://aistudio.google.com/)**
|
|
37
|
-
2. **Load team-fullstack**:
|
|
38
|
-
- Copy contents of: `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
|
|
39
|
-
- Paste into new Gemini chat
|
|
40
|
-
3. **Collaborate with the team**:
|
|
41
|
-
- Business Analyst: Requirements gathering
|
|
42
|
-
- Product Manager: Feature prioritization
|
|
43
|
-
- Solution Architect: Technical design
|
|
44
|
-
- UX Expert: User experience design
|
|
45
|
-
|
|
46
|
-
### Example Gemini Sessions:
|
|
47
|
-
|
|
48
|
-
```text
|
|
49
|
-
"I want to build a [type] application that [core purpose].
|
|
50
|
-
Help me brainstorm features and create a comprehensive PRD."
|
|
51
|
-
|
|
52
|
-
"Based on this PRD, design a scalable technical architecture
|
|
53
|
-
that can handle [specific requirements]."
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
4. **Export planning documents**:
|
|
57
|
-
- Save PRD as `docs/prd.md`
|
|
58
|
-
- Save architecture as `docs/architecture.md`
|
|
59
|
-
|
|
60
|
-
### Phase 3: Document Organization (IDE)
|
|
61
|
-
|
|
62
|
-
Switch back to your IDE for document management:
|
|
63
|
-
|
|
64
|
-
1. **Load bmad-master agent** (syntax varies by IDE)
|
|
65
|
-
2. **Shard the PRD**:
|
|
66
|
-
```
|
|
67
|
-
*shard-doc docs/prd.md prd
|
|
68
|
-
```
|
|
69
|
-
3. **Shard the architecture**:
|
|
70
|
-
```
|
|
71
|
-
*shard-doc docs/architecture.md architecture
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
**Result**: Organized folder structure:
|
|
75
|
-
|
|
76
|
-
- `docs/prd/` - Broken down PRD sections
|
|
77
|
-
- `docs/architecture/` - Broken down architecture sections
|
|
78
|
-
|
|
79
|
-
### Phase 4: Iterative Development
|
|
80
|
-
|
|
81
|
-
Follow the SM → Dev cycle for systematic story development:
|
|
82
|
-
|
|
83
|
-
#### Story Creation (Scrum Master)
|
|
84
|
-
|
|
85
|
-
1. **Start new chat/conversation**
|
|
86
|
-
2. **Load SM agent**
|
|
87
|
-
3. **Execute**: `*create` (runs create-next-story task)
|
|
88
|
-
4. **Review generated story** in `docs/stories/`
|
|
89
|
-
5. **Update status**: Change from "Draft" to "Approved"
|
|
90
|
-
|
|
91
|
-
#### Story Implementation (Developer)
|
|
92
|
-
|
|
93
|
-
1. **Start new chat/conversation**
|
|
94
|
-
2. **Load Dev agent**
|
|
95
|
-
3. **Agent asks**: Which story to implement
|
|
96
|
-
4. **Follow development tasks**
|
|
97
|
-
5. **Complete implementation**
|
|
98
|
-
6. **Update status**: Change to "Done"
|
|
99
|
-
|
|
100
|
-
#### Repeat Until Complete
|
|
101
|
-
|
|
102
|
-
- **SM**: Create next story → Review → Approve
|
|
103
|
-
- **Dev**: Implement story → Complete → Mark done
|
|
104
|
-
- **Continue**: Until all features implemented
|
|
105
|
-
|
|
106
|
-
## IDE-Specific Syntax
|
|
107
|
-
|
|
108
|
-
### Agent Loading Syntax by IDE:
|
|
109
|
-
|
|
110
|
-
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
111
|
-
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
112
|
-
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
113
|
-
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
114
|
-
|
|
115
|
-
### Chat Management:
|
|
116
|
-
|
|
117
|
-
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
118
|
-
- **Roo Code**: Switch modes within the same conversation
|
|
119
|
-
|
|
120
|
-
## Available Agents
|
|
121
|
-
|
|
122
|
-
### Core Development Agents:
|
|
123
|
-
|
|
124
|
-
- **bmad-master**: Universal task executor, document management
|
|
125
|
-
- **sm**: Scrum Master for story creation and agile process
|
|
126
|
-
- **dev**: Full-stack developer for implementation
|
|
127
|
-
- **architect**: Solution architect for technical design
|
|
128
|
-
|
|
129
|
-
### Specialized Agents:
|
|
130
|
-
|
|
131
|
-
- **pm**: Product manager for planning and prioritization
|
|
132
|
-
- **analyst**: Business analyst for requirements
|
|
133
|
-
- **qa**: QA specialist for testing strategies
|
|
134
|
-
- **po**: Product owner for backlog management
|
|
135
|
-
- **ux-expert**: UX specialist for design
|
|
136
|
-
|
|
137
|
-
## Key Principles
|
|
138
|
-
|
|
139
|
-
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
|
|
140
|
-
2. **Clean Handoffs**: Always start fresh when switching between agents
|
|
141
|
-
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
|
|
142
|
-
4. **Iterative Development**: Complete one story before starting the next
|
|
143
|
-
5. **Documentation First**: Always start with solid PRD and architecture
|
|
144
|
-
|
|
145
|
-
## Common Commands
|
|
146
|
-
|
|
147
|
-
Every agent supports these core commands:
|
|
148
|
-
|
|
149
|
-
- `*help` - Show available commands
|
|
150
|
-
- `*status` - Show current context/progress
|
|
151
|
-
- `*exit` - Exit the agent mode
|
|
152
|
-
|
|
153
|
-
## Success Tips
|
|
154
|
-
|
|
155
|
-
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
|
156
|
-
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
|
157
|
-
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
|
158
|
-
- **Keep conversations focused** - One agent, one task per conversation
|
|
159
|
-
- **Review everything** - Always review and approve before marking complete
|
|
160
|
-
|
|
161
|
-
This workflow ensures systematic, AI-assisted development following agile principles with clear separation of concerns and consistent progress tracking.
|
|
@@ -1,119 +0,0 @@
|
|
|
1
|
-
# BMAD Method Guide for Claude Code
|
|
2
|
-
|
|
3
|
-
This guide walks you through the complete BMAD workflow using Claude Code as your AI-powered IDE.
|
|
4
|
-
|
|
5
|
-
## Step 1: Install BMAD in Your Project
|
|
6
|
-
|
|
7
|
-
1. Navigate to your project directory
|
|
8
|
-
2. Run the BMAD installer:
|
|
9
|
-
```bash
|
|
10
|
-
npx bmad-method install
|
|
11
|
-
```
|
|
12
|
-
3. When prompted:
|
|
13
|
-
- **Installation Type**: Choose "Complete installation (recommended)"
|
|
14
|
-
- **IDE**: Select "Claude Code"
|
|
15
|
-
|
|
16
|
-
This creates a `.bmad-core` folder with all agents and a `.claude/commands` folder with agent commands.
|
|
17
|
-
|
|
18
|
-
## Step 2: Set Up Team Fullstack in Gemini
|
|
19
|
-
|
|
20
|
-
For ideation and planning, use Google's Gemini with the team-fullstack configuration:
|
|
21
|
-
|
|
22
|
-
1. Open [Google AI Studio (Gemini)](https://aistudio.google.com/)
|
|
23
|
-
2. Create a new chat
|
|
24
|
-
3. Copy the contents of `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
|
|
25
|
-
4. Paste this content into Gemini to set up the team
|
|
26
|
-
|
|
27
|
-
### Gemini Planning Phase
|
|
28
|
-
|
|
29
|
-
In Gemini, ask the BMAD team to help you:
|
|
30
|
-
|
|
31
|
-
- **Ideate** your project concept
|
|
32
|
-
- **Brainstorm** features and requirements
|
|
33
|
-
- **Create a PRD** (Product Requirements Document)
|
|
34
|
-
- **Design the architecture**
|
|
35
|
-
|
|
36
|
-
Ask questions like:
|
|
37
|
-
|
|
38
|
-
- "Help me brainstorm a [type of application] that does [core functionality]"
|
|
39
|
-
- "Create a comprehensive PRD for this concept"
|
|
40
|
-
- "Design the technical architecture for this system"
|
|
41
|
-
|
|
42
|
-
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
|
43
|
-
|
|
44
|
-
- `docs/prd.md`
|
|
45
|
-
- `docs/architecture.md`
|
|
46
|
-
|
|
47
|
-
## Step 3: Back to Claude Code - Document Sharding
|
|
48
|
-
|
|
49
|
-
Once you have your PRD and architecture documents in the `docs/` folder:
|
|
50
|
-
|
|
51
|
-
1. **Start a new chat in Claude Code**
|
|
52
|
-
2. **Load the bmad-master agent**: Type `/bmad-master`
|
|
53
|
-
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
|
54
|
-
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
|
55
|
-
|
|
56
|
-
This creates organized folders:
|
|
57
|
-
|
|
58
|
-
- `docs/prd/` - Contains broken down PRD sections
|
|
59
|
-
- `docs/architecture/` - Contains broken down architecture sections
|
|
60
|
-
|
|
61
|
-
## Step 4: Story Development Cycle
|
|
62
|
-
|
|
63
|
-
Now begin the iterative development cycle:
|
|
64
|
-
|
|
65
|
-
### Create Stories (Scrum Master)
|
|
66
|
-
|
|
67
|
-
1. **Start a new chat**
|
|
68
|
-
2. **Load SM agent**: Type `/sm`
|
|
69
|
-
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
|
70
|
-
4. **Review the generated story**
|
|
71
|
-
5. **If approved**: Set story status to "Approved" in the story file
|
|
72
|
-
|
|
73
|
-
### Implement Stories (Developer)
|
|
74
|
-
|
|
75
|
-
1. **Start a new chat**
|
|
76
|
-
2. **Load Dev agent**: Type `/dev`
|
|
77
|
-
3. **The agent will ask which story to implement**
|
|
78
|
-
4. **Follow the development tasks** the agent provides
|
|
79
|
-
5. **When story is complete**: Mark status as "Done"
|
|
80
|
-
|
|
81
|
-
### Repeat the Cycle
|
|
82
|
-
|
|
83
|
-
1. **Start a new chat with SM agent** (`/sm`)
|
|
84
|
-
2. **Create next story**: Type `*create`
|
|
85
|
-
3. **Review and approve**
|
|
86
|
-
4. **Start new chat with Dev agent** (`/dev`)
|
|
87
|
-
5. **Implement the story**
|
|
88
|
-
6. **Repeat until project complete**
|
|
89
|
-
|
|
90
|
-
## Available Commands in Claude Code
|
|
91
|
-
|
|
92
|
-
All BMAD agents are available as Claude Code commands:
|
|
93
|
-
|
|
94
|
-
- `/bmad-master` - Universal task executor
|
|
95
|
-
- `/sm` - Scrum Master for story creation
|
|
96
|
-
- `/dev` - Full-stack developer for implementation
|
|
97
|
-
- `/architect` - Solution architect for design
|
|
98
|
-
- `/pm` - Product manager for planning
|
|
99
|
-
- `/analyst` - Business analyst for requirements
|
|
100
|
-
- `/qa` - QA specialist for testing
|
|
101
|
-
- `/po` - Product owner for prioritization
|
|
102
|
-
- `/ux-expert` - UX specialist for design
|
|
103
|
-
|
|
104
|
-
## Key Workflow Principles
|
|
105
|
-
|
|
106
|
-
1. **Always start new chats** when switching agents to avoid context confusion
|
|
107
|
-
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
|
108
|
-
3. **Use bmad-master for document management** (sharding, templates, etc.)
|
|
109
|
-
4. **Follow the SM → Dev cycle** for consistent story development
|
|
110
|
-
5. **Review and approve stories** before implementation begins
|
|
111
|
-
|
|
112
|
-
## Tips for Success
|
|
113
|
-
|
|
114
|
-
- **Keep chats focused**: Each chat should have one agent and one primary task
|
|
115
|
-
- **Use \*help command**: Every agent supports `*help` to see available commands
|
|
116
|
-
- **Review generated content**: Always review and approve stories before marking them ready
|
|
117
|
-
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
|
118
|
-
|
|
119
|
-
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
package/docs/cursor-guide.md
DELETED
|
@@ -1,127 +0,0 @@
|
|
|
1
|
-
# BMAD Method Guide for Cursor
|
|
2
|
-
|
|
3
|
-
This guide walks you through the complete BMAD workflow using Cursor as your AI-powered IDE.
|
|
4
|
-
|
|
5
|
-
## Step 1: Install BMAD in Your Project
|
|
6
|
-
|
|
7
|
-
1. Navigate to your project directory
|
|
8
|
-
2. Run the BMAD installer:
|
|
9
|
-
```bash
|
|
10
|
-
npx bmad-method install
|
|
11
|
-
```
|
|
12
|
-
3. When prompted:
|
|
13
|
-
- **Installation Type**: Choose "Complete installation (recommended)"
|
|
14
|
-
- **IDE**: Select "Cursor"
|
|
15
|
-
|
|
16
|
-
This creates a `.bmad-core` folder with all agents and a `.cursor/rules` folder with agent rules.
|
|
17
|
-
|
|
18
|
-
## Step 2: Set Up Team Fullstack in Gemini
|
|
19
|
-
|
|
20
|
-
For ideation and planning, use Google's Gemini with the team-fullstack configuration:
|
|
21
|
-
|
|
22
|
-
1. Open [Google AI Studio (Gemini)](https://aistudio.google.com/)
|
|
23
|
-
2. Create a new chat
|
|
24
|
-
3. Copy the contents of `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
|
|
25
|
-
4. Paste this content into Gemini to set up the team
|
|
26
|
-
|
|
27
|
-
### Gemini Planning Phase
|
|
28
|
-
|
|
29
|
-
In Gemini, ask the BMAD team to help you:
|
|
30
|
-
|
|
31
|
-
- **Ideate** your project concept
|
|
32
|
-
- **Brainstorm** features and requirements
|
|
33
|
-
- **Create a PRD** (Product Requirements Document)
|
|
34
|
-
- **Design the architecture**
|
|
35
|
-
|
|
36
|
-
Ask questions like:
|
|
37
|
-
|
|
38
|
-
- "Help me brainstorm a [type of application] that does [core functionality]"
|
|
39
|
-
- "Create a comprehensive PRD for this concept"
|
|
40
|
-
- "Design the technical architecture for this system"
|
|
41
|
-
|
|
42
|
-
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
|
43
|
-
|
|
44
|
-
- `docs/prd.md`
|
|
45
|
-
- `docs/architecture.md`
|
|
46
|
-
|
|
47
|
-
## Step 3: Back to Cursor - Document Sharding
|
|
48
|
-
|
|
49
|
-
Once you have your PRD and architecture documents in the `docs/` folder:
|
|
50
|
-
|
|
51
|
-
1. **Start a new chat in Cursor**
|
|
52
|
-
2. **Load the bmad-master agent**: Type `@bmad-master`
|
|
53
|
-
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
|
54
|
-
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
|
55
|
-
|
|
56
|
-
This creates organized folders:
|
|
57
|
-
|
|
58
|
-
- `docs/prd/` - Contains broken down PRD sections
|
|
59
|
-
- `docs/architecture/` - Contains broken down architecture sections
|
|
60
|
-
|
|
61
|
-
## Step 4: Story Development Cycle
|
|
62
|
-
|
|
63
|
-
Now begin the iterative development cycle:
|
|
64
|
-
|
|
65
|
-
### Create Stories (Scrum Master)
|
|
66
|
-
|
|
67
|
-
1. **Start a new chat**
|
|
68
|
-
2. **Load SM agent**: Type `@sm`
|
|
69
|
-
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
|
70
|
-
4. **Review the generated story**
|
|
71
|
-
5. **If approved**: Set story status to "Approved" in the story file
|
|
72
|
-
|
|
73
|
-
### Implement Stories (Developer)
|
|
74
|
-
|
|
75
|
-
1. **Start a new chat**
|
|
76
|
-
2. **Load Dev agent**: Type `@dev`
|
|
77
|
-
3. **The agent will ask which story to implement**
|
|
78
|
-
4. **Follow the development tasks** the agent provides
|
|
79
|
-
5. **When story is complete**: Mark status as "Done"
|
|
80
|
-
|
|
81
|
-
### Repeat the Cycle
|
|
82
|
-
|
|
83
|
-
1. **Start a new chat with SM agent** (`@sm`)
|
|
84
|
-
2. **Create next story**: Type `*create`
|
|
85
|
-
3. **Review and approve**
|
|
86
|
-
4. **Start new chat with Dev agent** (`@dev`)
|
|
87
|
-
5. **Implement the story**
|
|
88
|
-
6. **Repeat until project complete**
|
|
89
|
-
|
|
90
|
-
## Available Agent Rules in Cursor
|
|
91
|
-
|
|
92
|
-
All BMAD agents are available as Cursor rules (use `@` prefix):
|
|
93
|
-
|
|
94
|
-
- `@bmad-master` - Universal task executor
|
|
95
|
-
- `@sm` - Scrum Master for story creation
|
|
96
|
-
- `@dev` - Full-stack developer for implementation
|
|
97
|
-
- `@architect` - Solution architect for design
|
|
98
|
-
- `@pm` - Product manager for planning
|
|
99
|
-
- `@analyst` - Business analyst for requirements
|
|
100
|
-
- `@qa` - QA specialist for testing
|
|
101
|
-
- `@po` - Product owner for prioritization
|
|
102
|
-
- `@ux-expert` - UX specialist for design
|
|
103
|
-
|
|
104
|
-
## Cursor-Specific Features
|
|
105
|
-
|
|
106
|
-
- **Agent rules are stored in**: `.cursor/rules/` as `.mdc` files
|
|
107
|
-
- **Auto-completion**: Cursor will suggest `@agent-name` as you type
|
|
108
|
-
- **Rule activation**: Rules activate automatically when you mention `@agent-name`
|
|
109
|
-
- **Context awareness**: Agents have access to your current file context
|
|
110
|
-
|
|
111
|
-
## Key Workflow Principles
|
|
112
|
-
|
|
113
|
-
1. **Always start new chats** when switching agents to avoid context confusion
|
|
114
|
-
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
|
115
|
-
3. **Use bmad-master for document management** (sharding, templates, etc.)
|
|
116
|
-
4. **Follow the SM → Dev cycle** for consistent story development
|
|
117
|
-
5. **Review and approve stories** before implementation begins
|
|
118
|
-
|
|
119
|
-
## Tips for Success
|
|
120
|
-
|
|
121
|
-
- **Keep chats focused**: Each chat should have one agent and one primary task
|
|
122
|
-
- **Use \*help command**: Every agent supports `*help` to see available commands
|
|
123
|
-
- **Review generated content**: Always review and approve stories before marking them ready
|
|
124
|
-
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
|
125
|
-
- **Leverage Cursor's context**: Agents can see your current file selection for better assistance
|
|
126
|
-
|
|
127
|
-
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
package/docs/roo-code-guide.md
DELETED
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
# BMAD Method Guide for Roo Code
|
|
2
|
-
|
|
3
|
-
This guide walks you through the complete BMAD workflow using Roo Code as your AI-powered IDE.
|
|
4
|
-
|
|
5
|
-
## Step 1: Install BMAD in Your Project
|
|
6
|
-
|
|
7
|
-
1. Navigate to your project directory
|
|
8
|
-
2. Run the BMAD installer:
|
|
9
|
-
```bash
|
|
10
|
-
npx bmad-method install
|
|
11
|
-
```
|
|
12
|
-
3. When prompted:
|
|
13
|
-
- **Installation Type**: Choose "Complete installation (recommended)"
|
|
14
|
-
- **IDE**: Select "Roo Code"
|
|
15
|
-
|
|
16
|
-
This creates a `.bmad-core` folder with all agents and a `.roo/.roomodes` file with custom modes.
|
|
17
|
-
|
|
18
|
-
## Step 2: Set Up Team Fullstack in Gemini
|
|
19
|
-
|
|
20
|
-
For ideation and planning, use Google's Gemini with the team-fullstack configuration:
|
|
21
|
-
|
|
22
|
-
1. Open [Google AI Studio (Gemini)](https://aistudio.google.com/)
|
|
23
|
-
2. Create a new chat
|
|
24
|
-
3. Copy the contents of `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
|
|
25
|
-
4. Paste this content into Gemini to set up the team
|
|
26
|
-
|
|
27
|
-
### Gemini Planning Phase
|
|
28
|
-
|
|
29
|
-
In Gemini, ask the BMAD team to help you:
|
|
30
|
-
|
|
31
|
-
- **Ideate** your project concept
|
|
32
|
-
- **Brainstorm** features and requirements
|
|
33
|
-
- **Create a PRD** (Product Requirements Document)
|
|
34
|
-
- **Design the architecture**
|
|
35
|
-
|
|
36
|
-
Ask questions like:
|
|
37
|
-
|
|
38
|
-
- "Help me brainstorm a [type of application] that does [core functionality]"
|
|
39
|
-
- "Create a comprehensive PRD for this concept"
|
|
40
|
-
- "Design the technical architecture for this system"
|
|
41
|
-
|
|
42
|
-
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
|
43
|
-
|
|
44
|
-
- `docs/prd.md`
|
|
45
|
-
- `docs/architecture.md`
|
|
46
|
-
|
|
47
|
-
## Step 3: Back to Roo Code - Document Sharding
|
|
48
|
-
|
|
49
|
-
Once you have your PRD and architecture documents in the `docs/` folder:
|
|
50
|
-
|
|
51
|
-
1. **Open your project in Roo Code**
|
|
52
|
-
2. **Select the bmad-master mode** from the mode selector (usually in status bar)
|
|
53
|
-
3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
|
|
54
|
-
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
|
55
|
-
|
|
56
|
-
This creates organized folders:
|
|
57
|
-
|
|
58
|
-
- `docs/prd/` - Contains broken down PRD sections
|
|
59
|
-
- `docs/architecture/` - Contains broken down architecture sections
|
|
60
|
-
|
|
61
|
-
## Step 4: Story Development Cycle
|
|
62
|
-
|
|
63
|
-
Now begin the iterative development cycle:
|
|
64
|
-
|
|
65
|
-
### Create Stories (Scrum Master)
|
|
66
|
-
|
|
67
|
-
1. **Start a new chat or conversation**
|
|
68
|
-
2. **Switch to SM mode**: Select `bmad-sm` from the mode selector
|
|
69
|
-
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
|
70
|
-
4. **Review the generated story**
|
|
71
|
-
5. **If approved**: Set story status to "Approved" in the story file
|
|
72
|
-
|
|
73
|
-
### Implement Stories (Developer)
|
|
74
|
-
|
|
75
|
-
1. **Start a new conversation**
|
|
76
|
-
2. **Switch to Dev mode**: Select `bmad-dev` from the mode selector
|
|
77
|
-
3. **The agent will ask which story to implement**
|
|
78
|
-
4. **Follow the development tasks** the agent provides
|
|
79
|
-
5. **When story is complete**: Mark status as "Done"
|
|
80
|
-
|
|
81
|
-
### Repeat the Cycle
|
|
82
|
-
|
|
83
|
-
1. **Switch to SM mode** (`bmad-sm`)
|
|
84
|
-
2. **Create next story**: Type `*create`
|
|
85
|
-
3. **Review and approve**
|
|
86
|
-
4. **Switch to Dev mode** (`bmad-dev`)
|
|
87
|
-
5. **Implement the story**
|
|
88
|
-
6. **Repeat until project complete**
|
|
89
|
-
|
|
90
|
-
## Available Custom Modes in Roo Code
|
|
91
|
-
|
|
92
|
-
All BMAD agents are available as custom modes:
|
|
93
|
-
|
|
94
|
-
- `bmad-bmad-master` - 🧙 Universal task executor
|
|
95
|
-
- `bmad-sm` - 🏃 Scrum Master for story creation
|
|
96
|
-
- `bmad-dev` - 💻 Full-stack developer for implementation
|
|
97
|
-
- `bmad-architect` - 🏗️ Solution architect for design
|
|
98
|
-
- `bmad-pm` - 📋 Product manager for planning
|
|
99
|
-
- `bmad-analyst` - 📊 Business analyst for requirements
|
|
100
|
-
- `bmad-qa` - 🧪 QA specialist for testing
|
|
101
|
-
- `bmad-po` - 🎯 Product owner for prioritization
|
|
102
|
-
- `bmad-ux-expert` - 🎨 UX specialist for design
|
|
103
|
-
|
|
104
|
-
## Roo Code-Specific Features
|
|
105
|
-
|
|
106
|
-
- **Custom modes are stored in**: `.roo/.roomodes` file
|
|
107
|
-
- **Mode switching**: Use the mode selector in Roo Code's interface
|
|
108
|
-
- **File permissions**: Each agent has specific file access permissions
|
|
109
|
-
- **Documentation agents** (SM, PM, PO, Analyst): Limited to `.md` and `.txt` files
|
|
110
|
-
- **Technical agents** (Dev, Architect, Master): Full file access
|
|
111
|
-
- **QA agents**: Access to test files and documentation
|
|
112
|
-
- **UX agents**: Access to design-related files
|
|
113
|
-
- **Context preservation**: Modes maintain context within conversations
|
|
114
|
-
|
|
115
|
-
## Key Workflow Principles
|
|
116
|
-
|
|
117
|
-
1. **Switch modes instead of starting new chats** - Roo Code handles context better with mode switching
|
|
118
|
-
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
|
119
|
-
3. **Use bmad-master mode for document management** (sharding, templates, etc.)
|
|
120
|
-
4. **Follow the SM → Dev mode cycle** for consistent story development
|
|
121
|
-
5. **Review and approve stories** before implementation begins
|
|
122
|
-
|
|
123
|
-
## Tips for Success
|
|
124
|
-
|
|
125
|
-
- **Use mode selector effectively**: Switch modes as needed for different tasks
|
|
126
|
-
- **Respect file permissions**: Agents can only edit files they have permission for
|
|
127
|
-
- **Use \*help command**: Every mode supports `*help` to see available commands
|
|
128
|
-
- **Review generated content**: Always review and approve stories before marking them ready
|
|
129
|
-
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
|
130
|
-
- **Leverage Roo's context**: Modes can maintain context across the conversation
|
|
131
|
-
|
|
132
|
-
## File Permission Summary
|
|
133
|
-
|
|
134
|
-
- **bmad-analyst, bmad-pm, bmad-po, bmad-sm**: `.md`, `.txt` files only
|
|
135
|
-
- **bmad-architect**: `.md`, `.txt`, `.yml`, `.yaml`, `.json` files
|
|
136
|
-
- **bmad-qa**: Test files (`.test.js`, `.spec.ts`, etc.) and `.md` files
|
|
137
|
-
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx` files
|
|
138
|
-
- **bmad-dev, bmad-bmad-master, bmad-orchestrator**: Full file access
|
|
139
|
-
|
|
140
|
-
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
# PRD
|
|
2
|
-
|
|
3
|
-
## Epic 1: Core To-Do Functionality
|
|
4
|
-
|
|
5
|
-
**Goal:** To deliver a functional, single-user to-do application with user authentication and full CRUD (Create, Read, Update, Delete) capabilities for tasks.
|
|
6
|
-
|
|
7
|
-
**Stories:**
|
|
8
|
-
|
|
9
|
-
**Story 1.1: User Authentication**
|
|
10
|
-
|
|
11
|
-
- **As a** user,
|
|
12
|
-
- **I want** to be able to sign up, log in, and log out,
|
|
13
|
-
- **so that** I can securely manage my personal to-do list.
|
|
14
|
-
- **Acceptance Criteria:**
|
|
15
|
-
1. The application uses the Supabase Auth UI for login and sign-up forms.
|
|
16
|
-
2. A user can create an account and will be automatically logged in.
|
|
17
|
-
3. A logged-in user can log out, which redirects them to the login page.
|
|
18
|
-
4. The main to-do list page is protected and only visible to authenticated users.
|
|
19
|
-
|
|
20
|
-
**Story 1.2: Create and View To-Dos**
|
|
21
|
-
|
|
22
|
-
- **As an** authenticated user,
|
|
23
|
-
- **I want** to enter a task into an input field and see it appear on my to-do list,
|
|
24
|
-
- **so that** I can keep track of my tasks.
|
|
25
|
-
- **Acceptance Criteria:**
|
|
26
|
-
1. There is a text input field and a "Create" button on the main page.
|
|
27
|
-
2. Submitting a new task adds it to the database and displays it in the list of to-dos without a page refresh.
|
|
28
|
-
3. The to-do list is fetched from the Supabase database when the page loads.
|
|
29
|
-
4. The input field is cleared after a to-do is successfully created.
|
|
30
|
-
|
|
31
|
-
**Story 1.3: Update and Delete To-Dos**
|
|
32
|
-
|
|
33
|
-
- **As an** authenticated user,
|
|
34
|
-
- **I want** to be able to mark a to-do as complete and delete it,
|
|
35
|
-
- **so that** I can manage my task list effectively.
|
|
36
|
-
- **Acceptance Criteria:**
|
|
37
|
-
1. Each to-do item has a checkbox or button to toggle its "completed" status.
|
|
38
|
-
2. Changing the status updates the item in the database and visually (e.g., with a strikethrough).
|
|
39
|
-
3. Each to-do item has a "Delete" button.
|
|
40
|
-
4. Clicking "Delete" removes the to-do from the UI and the database.
|
|
41
|
-
|
|
42
|
-
With this epic, the planning phase is complete. All the requirements are clearly defined and structured for development.
|