Compare commits

...

23 Commits

Author SHA1 Message Date
semantic-release-bot
3dc21db649 chore(release): 4.8.0 [skip ci]
# [4.8.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.7.0...v4.8.0) (2025-06-19)

### Bug Fixes

* installer has fast v4 update option now to keep the bmad method up to date with changes easily without breaking any customizations from the user. The SM and DEV are much more configurable to find epics stories and architectureal information when the prd and architecture are deviant from v4 templates and/or have not been sharded. so a config will give the user the option to configure the SM to use the full large documents or the sharded versions! ([aea7f3c](aea7f3cc86))
* prevent double installation when updating v4 ([af0e767](af0e767ecf))
* resolve undefined config properties in performUpdate ([0185e01](0185e012bb))
* update file-manager to properly handle YAML manifest files ([724cdd0](724cdd07a1))

### Features

* add early v4 detection for improved update flow ([29e7bbf](29e7bbf4c5))
* add file resolution context for IDE agents ([74d9bb4](74d9bb4b2b))
* update web builder to remove IDE-specific properties from agent bundles ([2f2a1e7](2f2a1e72d6))
2025-06-19 18:25:32 +00:00
Brian Madison
dfe8bc982a Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-19 13:25:01 -05:00
Brian Madison
b53b3a5b28 agents have clear file resolution and fuzzy task resolution instructions 2025-06-19 13:24:49 -05:00
Brian Madison
2f2a1e72d6 feat: update web builder to remove IDE-specific properties from agent bundles
- Remove 'root' property from YAML when building web bundles
- Remove 'IDE-FILE-RESOLUTION' and 'REQUEST-RESOLUTION' properties
- Filter out IDE-specific activation instructions
- Keep agent header minimal for web bundles
- Ensures web bundles are clean of IDE-specific configuration

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 13:21:26 -05:00
Brian Madison
d75cf9e032 refactor: simplify file resolution to concise activation instructions
- Added two concise activation instructions to SM agent
- IDE-FILE-RESOLUTION: One-line explanation of file path mapping
- REQUEST-RESOLUTION: One-line instruction for flexible request matching
- Simplified file-resolution-context.md to be a quick reference
- Removed verbose documentation in favor of clear, actionable instructions

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 13:06:45 -05:00
Brian Madison
74d9bb4b2b feat: add file resolution context for IDE agents
- Added file resolution section to SM agent explaining path patterns
- Created reusable file-resolution-context.md utility
- Documents how agents resolve tasks/templates/checklists to file paths
- Provides natural language to command mapping examples
- Helps IDE agents understand file system structure

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 13:02:17 -05:00
Brian Madison
aea7f3cc86 fix: installer has fast v4 update option now to keep the bmad method up to date with changes easily without breaking any customizations from the user. The SM and DEV are much more configurable to find epics stories and architectureal information when the prd and architecture are deviant from v4 templates and/or have not been sharded. so a config will give the user the option to configure the SM to use the full large documents or the sharded versions! 2025-06-19 12:55:16 -05:00
Brian Madison
9af2463fae docs: add update announcement to README
- Added prominent section about updating existing installations
- Explains how npx bmad-method install detects and updates v4
- Highlights backup feature for custom modifications
- Makes it clear that updates are safe and preserve customizations

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:47:22 -05:00
Brian Madison
af0e767ecf fix: prevent double installation when updating v4
- Added flag to prevent installer.install() being called twice
- Fixed undefined 'directory' error by using answers.directory
- Update flow now completes without errors
- Prevents 'Cannot read properties of undefined' error after successful update

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:43:58 -05:00
Brian Madison
0185e012bb fix: resolve undefined config properties in performUpdate
- Added optional chaining for newConfig.ide access
- Added ides array to config object in performUpdate
- Fixes 'Cannot read properties of undefined' error after update
- Ensures all required config properties are present for showSuccessMessage

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:41:19 -05:00
Brian Madison
29e7bbf4c5 feat: add early v4 detection for improved update flow
- Now detects existing v4 installations immediately after directory prompt
- Offers update option upfront for existing v4 installations
- If user declines update, continues with normal installation flow
- Added 'update' install type handling in installer
- Improves user experience by streamlining the update process

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:38:06 -05:00
Brian Madison
724cdd07a1 fix: update file-manager to properly handle YAML manifest files
- Added js-yaml import for YAML parsing
- Updated readManifest to parse YAML instead of JSON
- Updated createManifest to write YAML instead of JSON
- Fixes installation error when updating existing BMAD installations

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-19 12:31:27 -05:00
semantic-release-bot
91272a0077 chore(release): 4.7.0 [skip ci]
# [4.7.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.3...v4.7.0) (2025-06-19)

### Features

* extensive bmad-kb for web orchestrator to be much more helpful ([e663a11](e663a1146b))
2025-06-19 14:18:16 +00:00
Brian Madison
e663a1146b feat: extensive bmad-kb for web orchestrator to be much more helpful 2025-06-19 09:17:48 -05:00
semantic-release-bot
6dca9cc5ba chore(release): 4.6.3 [skip ci]
## [4.6.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.2...v4.6.3) (2025-06-19)

### Bug Fixes

* SM fixed file resolution issue in v4 ([61ab116](61ab1161e5))
2025-06-19 03:55:00 +00:00
Brian Madison
0881735a20 Merge branch 'main' of github.com:bmadcode/BMAD-METHOD 2025-06-18 22:54:14 -05:00
Brian Madison
61ab1161e5 fix: SM fixed file resolution issue in v4 2025-06-18 22:53:26 -05:00
semantic-release-bot
93d3a47326 chore(release): 4.6.2 [skip ci]
## [4.6.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.1...v4.6.2) (2025-06-19)

### Bug Fixes

* installer upgrade path fixed ([bd6a558](bd6a558929))
2025-06-19 00:58:56 +00:00
Brian Madison
bd6a558929 fix: installer upgrade path fixed 2025-06-18 19:58:28 -05:00
semantic-release-bot
a314df4f22 chore(release): 4.6.1 [skip ci]
## [4.6.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.0...v4.6.1) (2025-06-19)

### Bug Fixes

* expansion pack builder now includes proper dependencies from core as needed, and default template file name save added to template llm instructions ([9dded00](9dded00356))
2025-06-19 00:17:38 +00:00
Brian Madison
9dded00356 fix: expansion pack builder now includes proper dependencies from core as needed, and default template file name save added to template llm instructions 2025-06-18 19:17:09 -05:00
Matt
7f3a0be7e8 update web-builder.js to read agents from yaml. Import agents from core if not detected in expansion. (#246) 2025-06-18 18:07:21 -05:00
Kayvan Sylvan
3c658ac297 update @kayvan/markdown-tree-parser to v1.6.0 to support CJK characters (#244)
* chore: update `@kayvan/markdown-tree-parser` to version 1.5.1

### CHANGES
- Upgrade `@kayvan/markdown-tree-parser` to version 1.5.1
- Update package integrity for security improvements

* chore: update @kayvan//markdown-tree-parser to 1.6.0 to support CJK chars
2025-06-18 17:18:47 -05:00
68 changed files with 10376 additions and 3854 deletions

View File

@@ -4,7 +4,6 @@ package-lock.json
# Build outputs
dist/
web-bundles/
# Generated files
*.log

View File

@@ -1,3 +1,48 @@
# [4.8.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.7.0...v4.8.0) (2025-06-19)
### Bug Fixes
* installer has fast v4 update option now to keep the bmad method up to date with changes easily without breaking any customizations from the user. The SM and DEV are much more configurable to find epics stories and architectureal information when the prd and architecture are deviant from v4 templates and/or have not been sharded. so a config will give the user the option to configure the SM to use the full large documents or the sharded versions! ([aea7f3c](https://github.com/bmadcode/BMAD-METHOD/commit/aea7f3cc86e749d25ed18bed761dc2839023b3b3))
* prevent double installation when updating v4 ([af0e767](https://github.com/bmadcode/BMAD-METHOD/commit/af0e767ecf1b91d41f114e1a5d7bf5da08de57d6))
* resolve undefined config properties in performUpdate ([0185e01](https://github.com/bmadcode/BMAD-METHOD/commit/0185e012bb579948a4de1ea3950db4e399761619))
* update file-manager to properly handle YAML manifest files ([724cdd0](https://github.com/bmadcode/BMAD-METHOD/commit/724cdd07a199cb12b82236ad34ca1a0c61eb43e2))
### Features
* add early v4 detection for improved update flow ([29e7bbf](https://github.com/bmadcode/BMAD-METHOD/commit/29e7bbf4c5aa7e17854061a5ee695f44324f307a))
* add file resolution context for IDE agents ([74d9bb4](https://github.com/bmadcode/BMAD-METHOD/commit/74d9bb4b2b70a341673849a1df704f6eac70c3de))
* update web builder to remove IDE-specific properties from agent bundles ([2f2a1e7](https://github.com/bmadcode/BMAD-METHOD/commit/2f2a1e72d6a70f8127db6ba58a563d0f289621c3))
# [4.7.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.3...v4.7.0) (2025-06-19)
### Features
* extensive bmad-kb for web orchestrator to be much more helpful ([e663a11](https://github.com/bmadcode/BMAD-METHOD/commit/e663a1146b89e7b5078d9726649a51ae5624da46))
## [4.6.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.2...v4.6.3) (2025-06-19)
### Bug Fixes
* SM fixed file resolution issue in v4 ([61ab116](https://github.com/bmadcode/BMAD-METHOD/commit/61ab1161e59a92d657ab663082abcaf26729fa6b))
## [4.6.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.1...v4.6.2) (2025-06-19)
### Bug Fixes
* installer upgrade path fixed ([bd6a558](https://github.com/bmadcode/BMAD-METHOD/commit/bd6a55892906077a700f488bde175b57e846729d))
## [4.6.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.0...v4.6.1) (2025-06-19)
### Bug Fixes
* expansion pack builder now includes proper dependencies from core as needed, and default template file name save added to template llm instructions ([9dded00](https://github.com/bmadcode/BMAD-METHOD/commit/9dded003565879901246885d60787695e0d0b7bd))
# [4.6.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.5.1...v4.6.0) (2025-06-18)

View File

@@ -11,6 +11,23 @@
**If you find this project helpful or useful, please give it a star!** It helps others discover BMAD-METHOD and you will be notified of updates!
## 🔄 Important: Keeping Your BMAD Installation Updated
**Stay up-to-date effortlessly!** If you already have BMAD-METHOD installed in your project, simply run:
```bash
npx bmad-method install
```
The installer will:
- ✅ Automatically detect your existing v4 installation
- ✅ Update only the files that have changed
- ✅ Create `.bak` backup files for any custom modifications you've made
- ✅ Preserve your project-specific configurations
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
## 🚀 Quick Start
### Fastest Start: Web UI (2 minutes) 🏃‍♂️
@@ -191,7 +208,7 @@ Structured approaches for different scenarios:
├── tasks/ # Reusable task definitions
├── checklists/ # Quality checklists
├── data/ # Knowledge base
└── web-bundles/ # Pre-built bundles (deprecated - use dist/ instead)
└── web-bundles/ # Optional can be added if you use the install command and select this folder as a destination for the build bundle files
tools/
├── cli.js # Build tool

View File

@@ -3,6 +3,9 @@
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:
```yaml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -34,14 +37,14 @@ persona:
- Numbered Options Protocol - Always use numbered lists for selections
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*brainstorm {topic}" - Facilitate structured brainstorming session'
- '*research {topic}" - Generate deep research prompt for investigation'
- '*elicit" - Run advanced elicitation to clarify requirements'
- '*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- brainstorm {topic}: Facilitate structured brainstorming session
- research {topic}: Generate deep research prompt for investigation
- elicit: Run advanced elicitation to clarify requirements
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
dependencies:
tasks:
- brainstorming-techniques

View File

@@ -3,6 +3,9 @@
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:
```yaml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -34,13 +37,13 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run architectural validation checklist'
- '*research {topic}" - Generate deep research prompt for architectural decisions'
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Architect consultation with advanced-elicitation for complex system design
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run architectural validation checklist
- research {topic}: Generate deep research prompt for architectural decisions
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc

View File

@@ -3,6 +3,9 @@
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
```yml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
agent:
name: BMad Master
id: bmad-master
@@ -22,21 +25,21 @@ persona:
- Use numbered lists for choices
- Process (*) commands immediately
startup:
- Announce: I'm BMad Master, your BMAD task executor. I can run any task, template, util, checklist, workflow, or schema. Type *help or tell me what you need.
- Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT scan filesystem or load any resources during startup
- CRITICAL: Do NOT run discovery tasks automatically
- Wait for user request before any tool use
- Match request to resources, offer numbered options if unclear
- Load resources only when explicitly requested
commands:
- '*help" - Show commands'
- '*chat" - Advanced elicitation + KB mode'
- '*status" - Current context'
- '*task/template/util/checklist/workflow {name}" - Execute (list if no name)'
- '*list {type}" - List resources by type'
- '*exit" - Exit (confirm)'
- '*yolo" - Skip confirmations'
- '*doc-out" - Output full document'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show commands
- chat: Advanced elicitation + KB mode
- status: Current context
- task {template|util|checklist|workflow}: Execute
- list {task|template|util|checklist|workflow}: List resources by type
- exit: Exit (confirm)
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
- doc-out: Output full document
fuzzy-matching:
- 85% confidence threshold
- Show numbered list if unsure
@@ -74,7 +77,6 @@ dependencies:
- prd-tmpl
- project-brief-tmpl
- story-tmpl
- web-agent-startup-instructions-template
data:
- bmad-kb
- technical-preferences

View File

@@ -3,6 +3,9 @@
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
```yaml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
agent:
name: BMad Orchestrator
id: bmad-orchestrator

View File

@@ -3,6 +3,9 @@
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:
```yml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
agent:
name: James
id: dev
@@ -19,33 +22,35 @@ persona:
core_principles:
- CRITICAL: Story-Centric - Story has ALL info. NEVER load PRD/architecture/other docs files unless explicitly directed in dev notes
- CRITICAL: Load Standards - MUST load docs/architecture/coding-standards.md into core memory at startup
- CRITICAL: Config-Based Loading - MUST load .bmad-core/core-config.yml at startup, then load ONLY files listed in devLoadAlwaysFiles. Inform user of missing files but continue
- CRITICAL: Dev Record Only - ONLY update Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
- Sequential Execution - Complete tasks 1-by-1 in order. Mark [x] before next. No skipping
- Test-Driven Quality - Write tests alongside code. Task incomplete without passing tests
- Debug Log Discipline - Log temp changes to table. Revert after fix. Keep story lean
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
- Code Excellence - Clean, secure, maintainable code per coding-standards.md
- Code Excellence - Clean, secure, maintainable code per loaded standards
- Numbered Options - Always use numbered lists when presenting choices
startup:
- Announce: Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT load any story files or coding-standards.md during startup
- CRITICAL: Load .bmad-core/core-config.yml and read devLoadAlwaysFiles list
- CRITICAL: Load ONLY files specified in devLoadAlwaysFiles. If any missing, inform user but continue
- CRITICAL: Do NOT load any story files during startup unless user requested you do
- CRITICAL: Do NOT scan docs/stories/ directory automatically
- CRITICAL: Do NOT begin any tasks automatically
- Wait for user to specify story or ask for story selection
- Only load files and begin work when explicitly requested by user
- Only load story files and begin work when explicitly requested by user
commands:
- "*help" - Show commands
- "*chat-mode" - Conversational mode
- "*run-tests" - Execute linting+tests
- "*lint" - Run linting only
- "*dod-check" - Run story-dod-checklist
- "*status" - Show task progress
- "*debug-log" - Show debug entries
- "*complete-story" - Finalize to "Review"
- "*exit" - Leave developer mode
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: Conversational mode for development discussions
- run-tests: Execute linting and tests
- lint: Run linting only
- dod-check: Run story-dod-checklist
- status: Show task progress
- debug-log: Show debug entries
- complete-story: Finalize to "Review"
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
task-execution:
flow: "Read task→Implement→Write tests→Pass tests→Update [x]→Next task"

View File

@@ -3,6 +3,9 @@
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:
```yml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -31,11 +34,11 @@ persona:
- Strategic thinking & outcome-oriented
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Deep conversation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*exit" - Say goodbye as the PM, and then abandon inhabiting this persona'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Deep conversation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- exit: Say goodbye as the PM, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc

View File

@@ -3,6 +3,9 @@
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:
```yml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -33,16 +36,16 @@ persona:
- Documentation Ecosystem Integrity - Maintain consistency across all documents
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Product Owner consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run validation checklist (default->po-master-checklist)'
- '*shard-doc {document}" - Break down document into actionable parts'
- '*correct-course" - Analyze and suggest project course corrections'
- '*create-epic" - Create epic for brownfield projects (task brownfield-create-epic)'
- '*create-story" - Create user story from requirements (task brownfield-create-story)'
- '*exit" - Say Goodbye, You are no longer this Agent'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
- shard-doc {document}: Break down document into actionable parts
- correct-course: Analyze and suggest project course corrections
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-story: Create user story from requirements (task brownfield-create-story)
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
dependencies:
tasks:
- execute-checklist

View File

@@ -3,6 +3,9 @@
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:
```yaml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -33,11 +36,11 @@ persona:
- Cross-Browser & Cross-Platform Testing - Ensure comprehensive compatibility
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) QA consultation with advanced-elicitation for test strategy'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*exit" - Say goodbye as the QA Test Architect, and then abandon inhabiting this persona'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) QA consultation with advanced-elicitation for test strategy
- create-doc {template}: Create doc (no template = show available templates)
- exit: Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
dependencies:
data:
- technical-preferences

View File

@@ -3,9 +3,11 @@
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:
```yaml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- 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
agent:
@@ -21,31 +23,25 @@ persona:
identity: Story creation expert who prepares detailed, actionable stories for AI developers
focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
core_principles:
- Task Adherence - Rigorously follow create-next-story procedures
- Checklist-Driven Validation - Apply story-draft-checklist meticulously
- Clarity for Developer Handoff - Stories must be immediately actionable
- Focus on One Story at a Time - Complete one before starting next
- Numbered Options Protocol - Always use numbered lists for selections
- Rigorously follow `create-next-story` procedure to generate the detailed user story
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
- You are NOT allowed to implement stories or modify code EVER!
startup:
- Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT automatically execute create-next-story tasks during startup
- CRITICAL: Do NOT create or modify any files during startup
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
- Offer to help with story preparation but wait for explicit user confirmation
- Only execute tasks when user explicitly requests them
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent'
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - Conversational mode with advanced-elicitation for advice'
- '*create" - Execute all steps in Create Next Story Task document'
- '*pivot" - Run correct-course task (ensure no story already created first)'
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
- '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
- '*index-docs" - Update documentation index in /docs/index.md'
- '*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: Conversational mode with advanced-elicitation for advice
- create|draft: Execute create-next-story
- pivot: Execute `correct-course` task
- checklist {checklist}: Show numbered list of checklists, execute selection
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
dependencies:
tasks:
- create-next-story
- execute-checklist
- course-correct
templates:
- story-tmpl
checklists:

View File

@@ -3,6 +3,9 @@
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:
```yaml
root: .bmad-core
IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -37,14 +40,14 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) UX consultation with advanced-elicitation for design decisions'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*generate-ui-prompt" - Create AI frontend generation prompt'
- '*research {topic}" - Generate deep research prompt for UX investigation'
- '*execute-checklist {checklist}" - Run design validation checklist'
- '*exit" - Say goodbye as the UX Expert, and then abandon inhabiting this persona'
commands: # All commands require * prefix when used (e.g., *help)
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) UX consultation with advanced-elicitation for design decisions
- create-doc {template}: Create doc (no template = show available templates)
- generate-ui-prompt: Create AI frontend generation prompt
- research {topic}: Generate deep research prompt for UX investigation
- execute-checklist {checklist}: Run design validation checklist
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
dependencies:
tasks:
- generate-ai-frontend-prompt

24
bmad-core/core-config.yml Normal file
View File

@@ -0,0 +1,24 @@
core-project-information:
dev-story-location: docs/stories # alternate could be .ai/stories if preferred for example
prd:
prd-file: docs/prd.md
prdVersion: v4
prdSharded: true
prdShardedLocation: docs/prd
epicFilePattern: epic-{n}*.md
architecture:
architecture-file: docs/architecture.md
architectureVersion: v4
architectureSharded: true
architectureShardedLocation: docs/architecture
# if you have a front-end architecture document, uncomment the following and validate the file path
# front-end-architecture:
# front-end-architecture-file: docs/front-end-architecture.md
# architectureVersion: v4
# architectureSharded: true
# architectureShardedLocation: docs/architecture
customTechnicalDocuments: null # list other documents only if you want the SM to read them when creating stories
devLoadAlwaysFiles:
- docs/architecture/coding-standards.md
- docs/architecture/tech-stack.md
- docs/architecture/project-structure.md

View File

@@ -12,6 +12,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
- **Reusable Resources**: Portable templates, tasks, and checklists
- **Slash Command Integration**: Quick agent switching and control
### When to Use BMAD
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
- **Team Collaboration**: Multiple roles working together
- **Quality Assurance**: Structured testing and validation
- **Documentation**: Professional PRDs, architecture docs, user stories
## Getting Started
### Quick Start Options
#### Option 1: Web UI
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
5. Type `/help` to see available commands
#### Option 2: IDE Integration
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
```bash
# Interactive installation (recommended)
npx bmad-method install
```
**Installation Steps**:
- Choose "Complete installation"
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
**Verify Installation**:
- `.bmad-core/` folder created with all agents
- IDE-specific integration files created
- All agent commands/rules/modes available
### Environment Selection Guide
**Use Web UI for**:
- Initial planning and documentation (PRD, architecture)
- Cost-effective document creation (especially with Gemini)
- Brainstorming and analysis phases
- Multi-agent consultation and planning
**Use IDE for**:
- Active development and coding
- File operations and project integration
- Document sharding and story management
- Implementation workflow (SM/Dev cycles)
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
## Core Philosophy
### Vibe CEO'ing
@@ -33,15 +87,342 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
## IDE Development Workflow
### Key Workflow Principles
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
5. Use a new chat window to allow the SM agent to `draft the next story`.
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
2. **Clean Handoffs**: Always start fresh when switching between agents
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
4. **Iterative Development**: Complete one story before starting the next
5. **Documentation First**: Always start with solid PRD and architecture
With this work flow, there is only 1 story in progress at a time, worked sequentially.
## Agent System
### Core Development Team
| Agent | Role | Primary Functions | When to Use |
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
| `dev` | Developer | Code implementation, debugging | All development tasks |
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
### Meta Agents
| Agent | Role | Primary Functions | When to Use |
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
### Agent Interaction Commands
#### IDE-Specific Syntax
**Agent Loading by IDE**:
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
**Chat Management Guidelines**:
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
- **Roo Code**: Switch modes within the same conversation
**Common Task Commands**:
- `*help` - Show available commands
- `*status` - Show current context/progress
- `*exit` - Exit the agent mode
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
- `*create` - Run create-next-story task (SM agent)
**In Web UI**:
```text
/pm create-doc prd
/architect review system design
/dev implement story 1.2
/help - Show available commands
/switch agent-name - Change active agent (if orchestrator available)
```
## Team Configurations
### Pre-Built Teams
#### Team All
- **Includes**: All 10 agents + orchestrator
- **Use Case**: Complete projects requiring all roles
- **Bundle**: `team-all.txt`
#### Team Fullstack
- **Includes**: PM, Architect, Developer, QA, UX Expert
- **Use Case**: End-to-end web/mobile development
- **Bundle**: `team-fullstack.txt`
#### Team No-UI
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
- **Use Case**: Backend services, APIs, system development
- **Bundle**: `team-no-ui.txt`
## Core Architecture
### System Overview
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).
### Key Architectural Components
#### 1. Agents (`bmad-core/agents/`)
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
- **Startup Instructions**: Can load project-specific documentation for immediate context
#### 2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Define collections of agents bundled together for specific purposes
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
- **Usage**: Creates pre-packaged contexts for web UI environments
#### 3. Workflows (`bmad-core/workflows/`)
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
#### 4. Reusable Resources
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
### Dual Environment Architecture
#### IDE Environment
- Users interact directly with agent markdown files
- Agents can access all dependencies dynamically
- Supports real-time file operations and project integration
- Optimized for development workflow execution
#### Web UI Environment
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
- Created by the web-builder tool for upload to web interfaces
- Provides complete context in one package
### Template Processing System
BMAD employs a sophisticated template system with three key components:
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
**Template Features**:
- **Self-contained**: Templates embed both output structure and processing instructions
- **Variable Substitution**: `{{placeholders}}` for dynamic content
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
### Technical Preferences Integration
The `technical-preferences.md` file serves as a persistent technical profile that:
- Ensures consistency across all agents and projects
- Eliminates repetitive technology specification
- Provides personalized recommendations aligned with user preferences
- Evolves over time with lessons learned
### Build and Delivery Process
The `web-builder.js` tool creates web-ready bundles by:
1. Reading agent or team definition files
2. Recursively resolving all dependencies
3. Concatenating content into single text files with clear separators
4. Outputting ready-to-upload bundles for web AI interfaces
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
## Complete Development Workflow
### Planning Phase (Web UI Recommended)
**Ideal for cost efficiency, especially with Gemini:**
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
2. **Project Brief**: Create foundation document (Analyst or user)
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
#### Example Planning Prompts
**For PRD Creation**:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
```
**For Architecture Design**:
```text
"Based on this PRD, design a scalable technical architecture
that can handle [specific requirements]."
```
### Critical Transition: Web UI to IDE
**Once planning is complete, you MUST switch to IDE for development:**
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
### IDE Development Workflow
**Prerequisites**: Planning documents must exist in `docs/` folder
1. **Document Sharding**:
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
- If architecture exists, shard to `docs/architecture/` folder
- Results in multiple manageable documents and epic files
2. **Verify Sharded Content**:
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
- Source tree document and coding standards for dev agent reference
- Sharded docs for SM agent story creation
**Resulting Folder Structure**:
- `docs/prd/` - Broken down PRD sections
- `docs/architecture/` - Broken down architecture sections
- `docs/stories/` - Generated user stories
3. **Development Cycle** (Sequential, one story at a time):
**Step 1 - Story Creation**: New chat window → `@sm``*create`
- SM executes create-next-story task
- Review generated story in `docs/stories/`
- Update status from "Draft" to "Approved"
**Step 2 - Story Implementation**: New chat window → `@dev`
- Agent asks which story to implement
- Include story file content to save dev agent lookup time
- Dev follows tasks/subtasks, marking completion
- Dev leaves notes for SM about any deviations
- Update status to "Done"
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
### Status Tracking Workflow
Stories progress through defined statuses:
- **Draft** → **Approved****InProgress****Done**
Each status change requires user verification and approval before proceeding.
### Workflow Types
#### Greenfield Development
- Business analysis and market research
- Product requirements and feature definition
- System architecture and design
- Development execution
- Testing and deployment
#### Brownfield Enhancement
- Current system analysis
- Enhancement planning
- Impact assessment
- Incremental development
- Integration testing
## Document Creation Best Practices
### Required File Naming for Framework Integration
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter**:
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
### Cost-Effective Document Creation Workflow
**Recommended for Large Documents (PRD, Architecture):**
1. **Use Web UI**: Create documents in web interface for cost efficiency
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
4. **Switch to IDE**: Use IDE agents for development and smaller documents
### Document Sharding
Templates with Level 2 headings (`##`) can be automatically sharded:
**Original PRD**:
```markdown
## Goals and Background Context
## Requirements
## User Interface Design Goals
## Success Metrics
```
**After Sharding**:
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
## Usage Patterns and Best Practices
### Environment-Specific Usage
**Web UI Best For**:
- Initial planning and documentation phases
- Cost-effective large document creation
- Agent consultation and brainstorming
- Multi-agent workflows with orchestrator
**IDE Best For**:
- Active development and implementation
- File operations and project integration
- Story management and development cycles
- Code review and debugging
### Quality Assurance
- Use appropriate agents for specialized tasks
- Follow Agile ceremonies and review processes
- Maintain document consistency with PO agent
- Regular validation with checklists and templates
### Performance Optimization
- Use specific agents vs. `bmad-master` for focused tasks
- Choose appropriate team size for project needs
- Leverage technical preferences for consistency
- Regular context management and cache clearing
## Success Tips
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
- **Use bmad-master for document organization** - Sharding creates manageable chunks
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Getting Help
- **Commands**: Use `/help` in any environment to see available commands
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
- **Documentation**: Check `docs/` folder for project-specific context
- **Community**: Discord and GitHub resources available for support

View File

@@ -4,45 +4,42 @@
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
## Inputs for this Task
- Access to the project's documentation repository, specifically:
- `docs/index.md` (hereafter "Index Doc")
- All Epic files - located in one of these locations:
- Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Secondary: `docs/epics/epic-{n}-{description}.md`
- User-specified location if not found in above paths
- Existing story files in `docs/stories/`
- Main PRD (hereafter "PRD Doc")
- Main Architecture Document (hereafter "Main Arch Doc")
- Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
- Project Structure Guide (`docs/project-structure.md`)
- Operational Guidelines Document (`docs/operational-guidelines.md`)
- Technology Stack Document (`docs/tech-stack.md`)
- Data Models Document (as referenced in Index Doc)
- API Reference Document (as referenced in Index Doc)
- UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
- The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
- The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
- User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
## Task Execution Instructions
### 0. Load Core Configuration
[[LLM: CRITICAL - This MUST be your first step]]
- Load `.bmad-core/core-config.yml` from the project root
- If the file does not exist:
- HALT and inform the user: "core-config.yml not found. This file is required for story creation. You can:
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yml and configure it for your project
2. Run the BMAD installer against your project to upgrade and add the file automatically
Please add and configure core-config.yml before proceeding."
- Extract the following key configurations:
- `dev-story-location`: Where to save story files
- `prd.prdSharded`: Whether PRD is sharded or monolithic
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
- `prd.prdShardedLocation`: Location of sharded epic files
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
- `architecture.architectureVersion`: Architecture document version
- `architecture.architectureSharded`: Whether architecture is sharded
- `architecture.architecture-file`: Location of monolithic architecture
- `architecture.architectureShardedLocation`: Location of sharded architecture files
### 1. Identify Next Story for Preparation
#### 1.1 Locate Epic Files
- First, determine where epic files are located:
- Check `docs/prd/` for files matching pattern `epic-{n}-*.md`
- If not found, check `docs/epics/` for files matching pattern `epic-{n}-*.md`
- If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
- Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Based on `prdSharded` from config:
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
#### 1.2 Review Existing Stories
- Review `docs/stories/` to find the highest-numbered story file.
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
- If the directory exists and has at least 1 file, find the highest-numbered story file.
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
- Verify its `Status` is 'Done' (or equivalent).
- If not 'Done', present an alert to the user:
@@ -60,17 +57,17 @@ To identify the next logical story based on project progress and epic definition
```
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}-*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}-*.md`, then `epic-{lastEpicNum + 2}-*.md`, etc.) whose prerequisites are met.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
- **If no story files exist in `docs/stories/`:**
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
### 2. Gather Core Story Requirements (from Epic File)
### 2. Gather Core Story Requirements (from Epic)
- For the identified story, open its parent Epic File (e.g., `epic-{epicNum}-*.md` from the location identified in step 1.1).
- For the identified story, review its parent Epic (e.g., `epic-{epicNum}*.md` from the location identified in step 1.1).
- Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
- Keep a record of this original epic-defined scope for later deviation analysis.
@@ -79,7 +76,7 @@ To identify the next logical story based on project progress and epic definition
[[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
- If this is not the first story (i.e., previous story exists):
- Read the previous story file: `docs/stories/{prevEpicNum}.{prevStoryNum}.story.md`
- Read the previous sequential story from `docs/stories`
- Pay special attention to:
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
- Any deviations from planned implementation
@@ -88,18 +85,30 @@ To identify the next logical story based on project progress and epic definition
- Any "lessons learned" or notes for future stories
- Extract relevant insights that might inform the current story's preparation
### 4. Gather & Synthesize Architecture Context from Sharded Docs
### 4. Gather & Synthesize Architecture Context
[[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
[[LLM: CRITICAL - You MUST gather technical details from the architecture documents. NEVER make up technical details not found in these documents.]]
#### 4.1 Start with Architecture Index
#### 4.1 Determine Architecture Document Strategy
- Read `docs/architecture/index.md` to understand the full scope of available documentation
- Identify which sharded documents are most relevant to the current story
Based on configuration loaded in Step 0:
#### 4.2 Recommended Reading Order Based on Story Type
- **If `architectureVersion: v4` and `architectureSharded: true`**:
- Read `{architectureShardedLocation}/index.md` to understand available documentation
- Follow the structured reading order in section 4.2 below
- **If `architectureVersion: v4` and `architectureSharded: false`**:
- Load the monolithic architecture from `architecture-file`
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
- **If `architectureVersion` is NOT v4**:
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
- If `architectureSharded: true`: Search sharded files by filename relevance
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
[[LLM: Read documents in this order, but ALWAYS verify relevance to the specific story. Skip irrelevant sections but NEVER skip documents that contain information needed for the story.]]
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
**For ALL Stories:**
@@ -108,9 +117,18 @@ To identify the next logical story based on project progress and epic definition
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
**For Backend/API Stories, additionally read:** 5. `docs/architecture/data-models.md` - Data structures and validation rules 6. `docs/architecture/database-schema.md` - Database design and relationships 7. `docs/architecture/backend-architecture.md` - Service patterns and structure 8. `docs/architecture/rest-api-spec.md` - API endpoint specifications 9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Backend/API Stories, additionally read:**
5. `docs/architecture/data-models.md` - Data structures and validation rules
6. `docs/architecture/database-schema.md` - Database design and relationships
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Frontend/UI Stories, additionally read:** 5. `docs/architecture/frontend-architecture.md` - Component structure and patterns 6. `docs/architecture/components.md` - Specific component designs 7. `docs/architecture/core-workflows.md` - User interaction flows 8. `docs/architecture/data-models.md` - Frontend data handling
**For Frontend/UI Stories, additionally read:**
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
6. `docs/architecture/components.md` - Specific component designs
7. `docs/architecture/core-workflows.md` - User interaction flows
8. `docs/architecture/data-models.md` - Frontend data handling
**For Full-Stack Stories:**
@@ -143,7 +161,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
### 6. Populate Story Template with Full Context
- Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
- Use the Story Template to structure the file.
- Fill in:
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
@@ -190,7 +208,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
- Verify all source references are included for technical details
- Ensure tasks align with both epic requirements and architecture constraints
- Update status to "Draft"
- Save the story file to `docs/stories/{epicNum}.{storyNum}.story.md`
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
### 9. Report Completion

View File

@@ -2,6 +2,8 @@
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
[[LLM: The default path and filename unless specified is docs/architecture.md]]
## Introduction
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.

View File

@@ -1,5 +1,7 @@
# {{Project Name}} Brownfield Enhancement Architecture
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:

View File

@@ -1,5 +1,7 @@
# {{Project Name}} Brownfield Enhancement PRD
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:

View File

@@ -1,5 +1,7 @@
# Competitive Analysis Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
[[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
## Executive Summary

View File

@@ -1,5 +1,7 @@
# {{Project Name}} Frontend Architecture Document
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
[[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
## Template and Framework Selection

View File

@@ -1,5 +1,7 @@
# {{Project Name}} UI/UX Specification
[[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
[[LLM: Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.]]
## Introduction

View File

@@ -1,5 +1,7 @@
# {{Project Name}} Fullstack Architecture Document
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.]]
## Introduction

View File

@@ -1,5 +1,7 @@
# Market Research Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/market-research.md]]
[[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
## Executive Summary

View File

@@ -1,5 +1,7 @@
# {{Project Name}} Product Requirements Document (PRD)
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
## Goals and Background Context

View File

@@ -1,5 +1,7 @@
# Project Brief: {{Project Name}}
[[LLM: The default path and filename unless specified is docs/brief.md]]
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
Start by asking the user which mode they prefer:

View File

@@ -0,0 +1,10 @@
# File Resolution Context
Update the installer/upgrader so that when agents are added to a project (under Add these two lines to any agent's `activation-instructions` for ide installation:
```yaml
- IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
- REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
```
and add `root: .bmad-core` as the first root yml property.

View File

@@ -76,13 +76,13 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*brainstorm {topic}" - Facilitate structured brainstorming session'
- '*research {topic}" - Generate deep research prompt for investigation'
- '*elicit" - Run advanced elicitation to clarify requirements'
- '*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- brainstorm {topic}: Facilitate structured brainstorming session
- research {topic}: Generate deep research prompt for investigation
- elicit: Run advanced elicitation to clarify requirements
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
dependencies:
tasks:
- brainstorming-techniques
@@ -820,6 +820,8 @@ Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
==================== START: templates#project-brief-tmpl ====================
# Project Brief: {{Project Name}}
[[LLM: The default path and filename unless specified is docs/brief.md]]
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
Start by asking the user which mode they prefer:
@@ -1051,6 +1053,8 @@ These replace the standard elicitation options when working on project brief doc
==================== START: templates#market-research-tmpl ====================
# Market Research Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/market-research.md]]
[[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
## Executive Summary
@@ -1315,6 +1319,8 @@ These replace the standard elicitation options when working on market research d
==================== START: templates#competitor-analysis-tmpl ====================
# Competitive Analysis Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
[[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
## Executive Summary
@@ -1619,6 +1625,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
- **Reusable Resources**: Portable templates, tasks, and checklists
- **Slash Command Integration**: Quick agent switching and control
### When to Use BMAD
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
- **Team Collaboration**: Multiple roles working together
- **Quality Assurance**: Structured testing and validation
- **Documentation**: Professional PRDs, architecture docs, user stories
## Getting Started
### Quick Start Options
#### Option 1: Web UI
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
5. Type `/help` to see available commands
#### Option 2: IDE Integration
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
```bash
# Interactive installation (recommended)
npx bmad-method install
```
**Installation Steps**:
- Choose "Complete installation"
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
**Verify Installation**:
- `.bmad-core/` folder created with all agents
- IDE-specific integration files created
- All agent commands/rules/modes available
### Environment Selection Guide
**Use Web UI for**:
- Initial planning and documentation (PRD, architecture)
- Cost-effective document creation (especially with Gemini)
- Brainstorming and analysis phases
- Multi-agent consultation and planning
**Use IDE for**:
- Active development and coding
- File operations and project integration
- Document sharding and story management
- Implementation workflow (SM/Dev cycles)
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
## Core Philosophy
### Vibe CEO'ing
@@ -1640,18 +1700,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
## IDE Development Workflow
### Key Workflow Principles
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
5. Use a new chat window to allow the SM agent to `draft the next story`.
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
2. **Clean Handoffs**: Always start fresh when switching between agents
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
4. **Iterative Development**: Complete one story before starting the next
5. **Documentation First**: Always start with solid PRD and architecture
With this work flow, there is only 1 story in progress at a time, worked sequentially.
## Agent System
### Core Development Team
| Agent | Role | Primary Functions | When to Use |
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
| `dev` | Developer | Code implementation, debugging | All development tasks |
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
### Meta Agents
| Agent | Role | Primary Functions | When to Use |
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
### Agent Interaction Commands
#### IDE-Specific Syntax
**Agent Loading by IDE**:
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
**Chat Management Guidelines**:
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
- **Roo Code**: Switch modes within the same conversation
**Common Task Commands**:
- `*help` - Show available commands
- `*status` - Show current context/progress
- `*exit` - Exit the agent mode
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
- `*create` - Run create-next-story task (SM agent)
**In Web UI**:
```text
/pm create-doc prd
/architect review system design
/dev implement story 1.2
/help - Show available commands
/switch agent-name - Change active agent (if orchestrator available)
```
## Team Configurations
### Pre-Built Teams
#### Team All
- **Includes**: All 10 agents + orchestrator
- **Use Case**: Complete projects requiring all roles
- **Bundle**: `team-all.txt`
#### Team Fullstack
- **Includes**: PM, Architect, Developer, QA, UX Expert
- **Use Case**: End-to-end web/mobile development
- **Bundle**: `team-fullstack.txt`
#### Team No-UI
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
- **Use Case**: Backend services, APIs, system development
- **Bundle**: `team-no-ui.txt`
## Core Architecture
### System Overview
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).
### Key Architectural Components
#### 1. Agents (`bmad-core/agents/`)
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
- **Startup Instructions**: Can load project-specific documentation for immediate context
#### 2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Define collections of agents bundled together for specific purposes
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
- **Usage**: Creates pre-packaged contexts for web UI environments
#### 3. Workflows (`bmad-core/workflows/`)
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
#### 4. Reusable Resources
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
### Dual Environment Architecture
#### IDE Environment
- Users interact directly with agent markdown files
- Agents can access all dependencies dynamically
- Supports real-time file operations and project integration
- Optimized for development workflow execution
#### Web UI Environment
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
- Created by the web-builder tool for upload to web interfaces
- Provides complete context in one package
### Template Processing System
BMAD employs a sophisticated template system with three key components:
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
**Template Features**:
- **Self-contained**: Templates embed both output structure and processing instructions
- **Variable Substitution**: `{{placeholders}}` for dynamic content
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
### Technical Preferences Integration
The `technical-preferences.md` file serves as a persistent technical profile that:
- Ensures consistency across all agents and projects
- Eliminates repetitive technology specification
- Provides personalized recommendations aligned with user preferences
- Evolves over time with lessons learned
### Build and Delivery Process
The `web-builder.js` tool creates web-ready bundles by:
1. Reading agent or team definition files
2. Recursively resolving all dependencies
3. Concatenating content into single text files with clear separators
4. Outputting ready-to-upload bundles for web AI interfaces
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
## Complete Development Workflow
### Planning Phase (Web UI Recommended)
**Ideal for cost efficiency, especially with Gemini:**
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
2. **Project Brief**: Create foundation document (Analyst or user)
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
#### Example Planning Prompts
**For PRD Creation**:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
```
**For Architecture Design**:
```text
"Based on this PRD, design a scalable technical architecture
that can handle [specific requirements]."
```
### Critical Transition: Web UI to IDE
**Once planning is complete, you MUST switch to IDE for development:**
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
### IDE Development Workflow
**Prerequisites**: Planning documents must exist in `docs/` folder
1. **Document Sharding**:
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
- If architecture exists, shard to `docs/architecture/` folder
- Results in multiple manageable documents and epic files
2. **Verify Sharded Content**:
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
- Source tree document and coding standards for dev agent reference
- Sharded docs for SM agent story creation
**Resulting Folder Structure**:
- `docs/prd/` - Broken down PRD sections
- `docs/architecture/` - Broken down architecture sections
- `docs/stories/` - Generated user stories
3. **Development Cycle** (Sequential, one story at a time):
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
- SM executes create-next-story task
- Review generated story in `docs/stories/`
- Update status from "Draft" to "Approved"
**Step 2 - Story Implementation**: New chat window → `@dev`
- Agent asks which story to implement
- Include story file content to save dev agent lookup time
- Dev follows tasks/subtasks, marking completion
- Dev leaves notes for SM about any deviations
- Update status to "Done"
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
### Status Tracking Workflow
Stories progress through defined statuses:
- **Draft** → **Approved** → **InProgress** → **Done**
Each status change requires user verification and approval before proceeding.
### Workflow Types
#### Greenfield Development
- Business analysis and market research
- Product requirements and feature definition
- System architecture and design
- Development execution
- Testing and deployment
#### Brownfield Enhancement
- Current system analysis
- Enhancement planning
- Impact assessment
- Incremental development
- Integration testing
## Document Creation Best Practices
### Required File Naming for Framework Integration
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter**:
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
### Cost-Effective Document Creation Workflow
**Recommended for Large Documents (PRD, Architecture):**
1. **Use Web UI**: Create documents in web interface for cost efficiency
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
4. **Switch to IDE**: Use IDE agents for development and smaller documents
### Document Sharding
Templates with Level 2 headings (`##`) can be automatically sharded:
**Original PRD**:
```markdown
## Goals and Background Context
## Requirements
## User Interface Design Goals
## Success Metrics
```
**After Sharding**:
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
## Usage Patterns and Best Practices
### Environment-Specific Usage
**Web UI Best For**:
- Initial planning and documentation phases
- Cost-effective large document creation
- Agent consultation and brainstorming
- Multi-agent workflows with orchestrator
**IDE Best For**:
- Active development and implementation
- File operations and project integration
- Story management and development cycles
- Code review and debugging
### Quality Assurance
- Use appropriate agents for specialized tasks
- Follow Agile ceremonies and review processes
- Maintain document consistency with PO agent
- Regular validation with checklists and templates
### Performance Optimization
- Use specific agents vs. `bmad-master` for focused tasks
- Choose appropriate team size for project needs
- Leverage technical preferences for consistency
- Regular context management and cache clearing
## Success Tips
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
- **Use bmad-master for document organization** - Sharding creates manageable chunks
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Getting Help
- **Commands**: Use `/help` in any environment to see available commands
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
- **Documentation**: Check `docs/` folder for project-specific context
- **Community**: Discord and GitHub resources available for support
==================== END: data#bmad-kb ====================
==================== START: utils#template-format ====================

View File

@@ -76,12 +76,12 @@ startup:
- Greet the user with your name and role, and inform of the *help command.
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run architectural validation checklist'
- '*research {topic}" - Generate deep research prompt for architectural decisions'
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Architect consultation with advanced-elicitation for complex system design
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run architectural validation checklist
- research {topic}: Generate deep research prompt for architectural decisions
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc
@@ -980,6 +980,8 @@ The LLM will:
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
[[LLM: The default path and filename unless specified is docs/architecture.md]]
## Introduction
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
@@ -1755,6 +1757,8 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
==================== START: templates#front-end-architecture-tmpl ====================
# {{Project Name}} Frontend Architecture Document
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
[[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
## Template and Framework Selection
@@ -1931,6 +1935,8 @@ Document the starter template decision and any constraints it imposes before pro
==================== START: templates#fullstack-architecture-tmpl ====================
# {{Project Name}} Fullstack Architecture Document
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.]]
## Introduction
@@ -2950,6 +2956,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
==================== START: templates#brownfield-architecture-tmpl ====================
# {{Project Name}} Brownfield Enhancement Architecture
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:

View File

@@ -41,9 +41,9 @@ These references map directly to bundle sections:
==================== START: agents#bmad-master ====================
# bmad-master
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
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:
```yml
```yaml
agent:
name: BMad Master
id: bmad-master
@@ -63,21 +63,21 @@ persona:
- Use numbered lists for choices
- Process (*) commands immediately
startup:
- Announce: I'm BMad Master, your BMAD task executor. I can run any task, template, util, checklist, workflow, or schema. Type *help or tell me what you need.
- Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT scan filesystem or load any resources during startup
- CRITICAL: Do NOT run discovery tasks automatically
- Wait for user request before any tool use
- Match request to resources, offer numbered options if unclear
- Load resources only when explicitly requested
commands:
- '*help" - Show commands'
- '*chat" - Advanced elicitation + KB mode'
- '*status" - Current context'
- '*task/template/util/checklist/workflow {name}" - Execute (list if no name)'
- '*list {type}" - List resources by type'
- '*exit" - Exit (confirm)'
- '*yolo" - Skip confirmations'
- '*doc-out" - Output full document'
- help: Show commands
- chat: Advanced elicitation + KB mode
- status: Current context
- task {template|util|checklist|workflow}: Execute
- list {task|template|util|checklist|workflow}: List resources by type
- exit: Exit (confirm)
- yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
- doc-out: Output full document
fuzzy-matching:
- 85% confidence threshold
- Show numbered list if unsure
@@ -115,7 +115,6 @@ dependencies:
- prd-tmpl
- project-brief-tmpl
- story-tmpl
- web-agent-startup-instructions-template
data:
- bmad-kb
- technical-preferences
@@ -1722,45 +1721,42 @@ Present a summary of what was created and ask if any additional documentation wo
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
## Inputs for this Task
- Access to the project's documentation repository, specifically:
- `docs/index.md` (hereafter "Index Doc")
- All Epic files - located in one of these locations:
- Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Secondary: `docs/epics/epic-{n}-{description}.md`
- User-specified location if not found in above paths
- Existing story files in `docs/stories/`
- Main PRD (hereafter "PRD Doc")
- Main Architecture Document (hereafter "Main Arch Doc")
- Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
- Project Structure Guide (`docs/project-structure.md`)
- Operational Guidelines Document (`docs/operational-guidelines.md`)
- Technology Stack Document (`docs/tech-stack.md`)
- Data Models Document (as referenced in Index Doc)
- API Reference Document (as referenced in Index Doc)
- UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
- The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
- The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
- User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
## Task Execution Instructions
### 0. Load Core Configuration
[[LLM: CRITICAL - This MUST be your first step]]
- Load `.bmad-core/core-config.yml` from the project root
- If the file does not exist:
- HALT and inform the user: "core-config.yml not found. This file is required for story creation. You can:
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yml and configure it for your project
2. Run the BMAD installer against your project to upgrade and add the file automatically
Please add and configure core-config.yml before proceeding."
- Extract the following key configurations:
- `dev-story-location`: Where to save story files
- `prd.prdSharded`: Whether PRD is sharded or monolithic
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
- `prd.prdShardedLocation`: Location of sharded epic files
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
- `architecture.architectureVersion`: Architecture document version
- `architecture.architectureSharded`: Whether architecture is sharded
- `architecture.architecture-file`: Location of monolithic architecture
- `architecture.architectureShardedLocation`: Location of sharded architecture files
### 1. Identify Next Story for Preparation
#### 1.1 Locate Epic Files
- First, determine where epic files are located:
- Check `docs/prd/` for files matching pattern `epic-{n}-*.md`
- If not found, check `docs/epics/` for files matching pattern `epic-{n}-*.md`
- If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
- Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Based on `prdSharded` from config:
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
#### 1.2 Review Existing Stories
- Review `docs/stories/` to find the highest-numbered story file.
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
- If the directory exists and has at least 1 file, find the highest-numbered story file.
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
- Verify its `Status` is 'Done' (or equivalent).
- If not 'Done', present an alert to the user:
@@ -1778,17 +1774,17 @@ To identify the next logical story based on project progress and epic definition
```
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}-*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}-*.md`, then `epic-{lastEpicNum + 2}-*.md`, etc.) whose prerequisites are met.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
- **If no story files exist in `docs/stories/`:**
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
### 2. Gather Core Story Requirements (from Epic File)
### 2. Gather Core Story Requirements (from Epic)
- For the identified story, open its parent Epic File (e.g., `epic-{epicNum}-*.md` from the location identified in step 1.1).
- For the identified story, review its parent Epic (e.g., `epic-{epicNum}*.md` from the location identified in step 1.1).
- Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
- Keep a record of this original epic-defined scope for later deviation analysis.
@@ -1797,7 +1793,7 @@ To identify the next logical story based on project progress and epic definition
[[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
- If this is not the first story (i.e., previous story exists):
- Read the previous story file: `docs/stories/{prevEpicNum}.{prevStoryNum}.story.md`
- Read the previous sequential story from `docs/stories`
- Pay special attention to:
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
- Any deviations from planned implementation
@@ -1806,18 +1802,30 @@ To identify the next logical story based on project progress and epic definition
- Any "lessons learned" or notes for future stories
- Extract relevant insights that might inform the current story's preparation
### 4. Gather & Synthesize Architecture Context from Sharded Docs
### 4. Gather & Synthesize Architecture Context
[[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
[[LLM: CRITICAL - You MUST gather technical details from the architecture documents. NEVER make up technical details not found in these documents.]]
#### 4.1 Start with Architecture Index
#### 4.1 Determine Architecture Document Strategy
- Read `docs/architecture/index.md` to understand the full scope of available documentation
- Identify which sharded documents are most relevant to the current story
Based on configuration loaded in Step 0:
#### 4.2 Recommended Reading Order Based on Story Type
- **If `architectureVersion: v4` and `architectureSharded: true`**:
- Read `{architectureShardedLocation}/index.md` to understand available documentation
- Follow the structured reading order in section 4.2 below
- **If `architectureVersion: v4` and `architectureSharded: false`**:
- Load the monolithic architecture from `architecture-file`
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
- **If `architectureVersion` is NOT v4**:
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
- If `architectureSharded: true`: Search sharded files by filename relevance
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
[[LLM: Read documents in this order, but ALWAYS verify relevance to the specific story. Skip irrelevant sections but NEVER skip documents that contain information needed for the story.]]
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
**For ALL Stories:**
@@ -1826,9 +1834,18 @@ To identify the next logical story based on project progress and epic definition
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
**For Backend/API Stories, additionally read:** 5. `docs/architecture/data-models.md` - Data structures and validation rules 6. `docs/architecture/database-schema.md` - Database design and relationships 7. `docs/architecture/backend-architecture.md` - Service patterns and structure 8. `docs/architecture/rest-api-spec.md` - API endpoint specifications 9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Backend/API Stories, additionally read:**
5. `docs/architecture/data-models.md` - Data structures and validation rules
6. `docs/architecture/database-schema.md` - Database design and relationships
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Frontend/UI Stories, additionally read:** 5. `docs/architecture/frontend-architecture.md` - Component structure and patterns 6. `docs/architecture/components.md` - Specific component designs 7. `docs/architecture/core-workflows.md` - User interaction flows 8. `docs/architecture/data-models.md` - Frontend data handling
**For Frontend/UI Stories, additionally read:**
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
6. `docs/architecture/components.md` - Specific component designs
7. `docs/architecture/core-workflows.md` - User interaction flows
8. `docs/architecture/data-models.md` - Frontend data handling
**For Full-Stack Stories:**
@@ -1861,7 +1878,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
### 6. Populate Story Template with Full Context
- Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
- Use the Story Template to structure the file.
- Fill in:
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
@@ -1908,7 +1925,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
- Verify all source references are included for technical details
- Ensure tasks align with both epic requirements and architecture constraints
- Update status to "Draft"
- Save the story file to `docs/stories/{epicNum}.{storyNum}.story.md`
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
### 9. Report Completion
@@ -2441,6 +2458,8 @@ Document sharded successfully:
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
[[LLM: The default path and filename unless specified is docs/architecture.md]]
## Introduction
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
@@ -3216,6 +3235,8 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
==================== START: templates#brownfield-architecture-tmpl ====================
# {{Project Name}} Brownfield Enhancement Architecture
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:
@@ -3761,6 +3782,8 @@ Present risk assessment and apply `tasks#advanced-elicitation` protocol]]
==================== START: templates#brownfield-prd-tmpl ====================
# {{Project Name}} Brownfield Enhancement PRD
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
@@ -4004,6 +4027,8 @@ so that {{benefit}}.
==================== START: templates#competitor-analysis-tmpl ====================
# Competitive Analysis Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
[[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
## Executive Summary
@@ -4296,6 +4321,8 @@ These replace the standard elicitation options when working on competitive analy
==================== START: templates#front-end-architecture-tmpl ====================
# {{Project Name}} Frontend Architecture Document
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
[[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
## Template and Framework Selection
@@ -4472,6 +4499,8 @@ Document the starter template decision and any constraints it imposes before pro
==================== START: templates#front-end-spec-tmpl ====================
# {{Project Name}} UI/UX Specification
[[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
[[LLM: Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.]]
## Introduction
@@ -4886,6 +4915,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
==================== START: templates#fullstack-architecture-tmpl ====================
# {{Project Name}} Fullstack Architecture Document
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.]]
## Introduction
@@ -5905,6 +5936,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
==================== START: templates#market-research-tmpl ====================
# Market Research Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/market-research.md]]
[[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
## Executive Summary
@@ -6169,6 +6202,8 @@ These replace the standard elicitation options when working on market research d
==================== START: templates#prd-tmpl ====================
# {{Project Name}} Product Requirements Document (PRD)
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
## Goals and Background Context
@@ -6372,6 +6407,8 @@ so that {{benefit}}.
==================== START: templates#project-brief-tmpl ====================
# Project Brief: {{Project Name}}
[[LLM: The default path and filename unless specified is docs/brief.md]]
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
Start by asking the user which mode they prefer:
@@ -6664,48 +6701,6 @@ Manual Test Steps: [[LLM: Include how if possible the user can manually test the
| :--- | :------ | :---------- | :----- |
==================== END: templates#story-tmpl ====================
==================== START: templates#web-agent-startup-instructions-template ====================
# Web Agent Bundle Instructions
You are now operating as a specialized AI agent from the BMAD-METHOD framework. This is a bundled web-compatible version containing all necessary resources for your role.
## Important Instructions
1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
- `==================== START: folder#filename ====================`
- `==================== END: folder#filename ====================`
When you need to reference a resource mentioned in your instructions:
- Look for the corresponding START/END tags
- The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
- If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
**Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
```yaml
dependencies:
utils:
- template-format
tasks:
- create-story
```
These references map directly to bundle sections:
- `utils: template-format` → Look for `==================== START: utils#template-format ====================`
- `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMAD-METHOD framework.
---
==================== END: templates#web-agent-startup-instructions-template ====================
==================== START: checklists#architect-checklist ====================
# Architect Solution Validation Checklist
@@ -8437,6 +8432,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
- **Reusable Resources**: Portable templates, tasks, and checklists
- **Slash Command Integration**: Quick agent switching and control
### When to Use BMAD
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
- **Team Collaboration**: Multiple roles working together
- **Quality Assurance**: Structured testing and validation
- **Documentation**: Professional PRDs, architecture docs, user stories
## Getting Started
### Quick Start Options
#### Option 1: Web UI
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
5. Type `/help` to see available commands
#### Option 2: IDE Integration
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
```bash
# Interactive installation (recommended)
npx bmad-method install
```
**Installation Steps**:
- Choose "Complete installation"
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
**Verify Installation**:
- `.bmad-core/` folder created with all agents
- IDE-specific integration files created
- All agent commands/rules/modes available
### Environment Selection Guide
**Use Web UI for**:
- Initial planning and documentation (PRD, architecture)
- Cost-effective document creation (especially with Gemini)
- Brainstorming and analysis phases
- Multi-agent consultation and planning
**Use IDE for**:
- Active development and coding
- File operations and project integration
- Document sharding and story management
- Implementation workflow (SM/Dev cycles)
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
## Core Philosophy
### Vibe CEO'ing
@@ -8458,18 +8507,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
## IDE Development Workflow
### Key Workflow Principles
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
5. Use a new chat window to allow the SM agent to `draft the next story`.
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
2. **Clean Handoffs**: Always start fresh when switching between agents
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
4. **Iterative Development**: Complete one story before starting the next
5. **Documentation First**: Always start with solid PRD and architecture
With this work flow, there is only 1 story in progress at a time, worked sequentially.
## Agent System
### Core Development Team
| Agent | Role | Primary Functions | When to Use |
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
| `dev` | Developer | Code implementation, debugging | All development tasks |
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
### Meta Agents
| Agent | Role | Primary Functions | When to Use |
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
### Agent Interaction Commands
#### IDE-Specific Syntax
**Agent Loading by IDE**:
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
**Chat Management Guidelines**:
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
- **Roo Code**: Switch modes within the same conversation
**Common Task Commands**:
- `*help` - Show available commands
- `*status` - Show current context/progress
- `*exit` - Exit the agent mode
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
- `*create` - Run create-next-story task (SM agent)
**In Web UI**:
```text
/pm create-doc prd
/architect review system design
/dev implement story 1.2
/help - Show available commands
/switch agent-name - Change active agent (if orchestrator available)
```
## Team Configurations
### Pre-Built Teams
#### Team All
- **Includes**: All 10 agents + orchestrator
- **Use Case**: Complete projects requiring all roles
- **Bundle**: `team-all.txt`
#### Team Fullstack
- **Includes**: PM, Architect, Developer, QA, UX Expert
- **Use Case**: End-to-end web/mobile development
- **Bundle**: `team-fullstack.txt`
#### Team No-UI
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
- **Use Case**: Backend services, APIs, system development
- **Bundle**: `team-no-ui.txt`
## Core Architecture
### System Overview
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).
### Key Architectural Components
#### 1. Agents (`bmad-core/agents/`)
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
- **Startup Instructions**: Can load project-specific documentation for immediate context
#### 2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Define collections of agents bundled together for specific purposes
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
- **Usage**: Creates pre-packaged contexts for web UI environments
#### 3. Workflows (`bmad-core/workflows/`)
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
#### 4. Reusable Resources
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
### Dual Environment Architecture
#### IDE Environment
- Users interact directly with agent markdown files
- Agents can access all dependencies dynamically
- Supports real-time file operations and project integration
- Optimized for development workflow execution
#### Web UI Environment
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
- Created by the web-builder tool for upload to web interfaces
- Provides complete context in one package
### Template Processing System
BMAD employs a sophisticated template system with three key components:
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
**Template Features**:
- **Self-contained**: Templates embed both output structure and processing instructions
- **Variable Substitution**: `{{placeholders}}` for dynamic content
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
### Technical Preferences Integration
The `technical-preferences.md` file serves as a persistent technical profile that:
- Ensures consistency across all agents and projects
- Eliminates repetitive technology specification
- Provides personalized recommendations aligned with user preferences
- Evolves over time with lessons learned
### Build and Delivery Process
The `web-builder.js` tool creates web-ready bundles by:
1. Reading agent or team definition files
2. Recursively resolving all dependencies
3. Concatenating content into single text files with clear separators
4. Outputting ready-to-upload bundles for web AI interfaces
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
## Complete Development Workflow
### Planning Phase (Web UI Recommended)
**Ideal for cost efficiency, especially with Gemini:**
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
2. **Project Brief**: Create foundation document (Analyst or user)
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
#### Example Planning Prompts
**For PRD Creation**:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
```
**For Architecture Design**:
```text
"Based on this PRD, design a scalable technical architecture
that can handle [specific requirements]."
```
### Critical Transition: Web UI to IDE
**Once planning is complete, you MUST switch to IDE for development:**
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
### IDE Development Workflow
**Prerequisites**: Planning documents must exist in `docs/` folder
1. **Document Sharding**:
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
- If architecture exists, shard to `docs/architecture/` folder
- Results in multiple manageable documents and epic files
2. **Verify Sharded Content**:
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
- Source tree document and coding standards for dev agent reference
- Sharded docs for SM agent story creation
**Resulting Folder Structure**:
- `docs/prd/` - Broken down PRD sections
- `docs/architecture/` - Broken down architecture sections
- `docs/stories/` - Generated user stories
3. **Development Cycle** (Sequential, one story at a time):
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
- SM executes create-next-story task
- Review generated story in `docs/stories/`
- Update status from "Draft" to "Approved"
**Step 2 - Story Implementation**: New chat window → `@dev`
- Agent asks which story to implement
- Include story file content to save dev agent lookup time
- Dev follows tasks/subtasks, marking completion
- Dev leaves notes for SM about any deviations
- Update status to "Done"
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
### Status Tracking Workflow
Stories progress through defined statuses:
- **Draft** → **Approved** → **InProgress** → **Done**
Each status change requires user verification and approval before proceeding.
### Workflow Types
#### Greenfield Development
- Business analysis and market research
- Product requirements and feature definition
- System architecture and design
- Development execution
- Testing and deployment
#### Brownfield Enhancement
- Current system analysis
- Enhancement planning
- Impact assessment
- Incremental development
- Integration testing
## Document Creation Best Practices
### Required File Naming for Framework Integration
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter**:
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
### Cost-Effective Document Creation Workflow
**Recommended for Large Documents (PRD, Architecture):**
1. **Use Web UI**: Create documents in web interface for cost efficiency
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
4. **Switch to IDE**: Use IDE agents for development and smaller documents
### Document Sharding
Templates with Level 2 headings (`##`) can be automatically sharded:
**Original PRD**:
```markdown
## Goals and Background Context
## Requirements
## User Interface Design Goals
## Success Metrics
```
**After Sharding**:
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
## Usage Patterns and Best Practices
### Environment-Specific Usage
**Web UI Best For**:
- Initial planning and documentation phases
- Cost-effective large document creation
- Agent consultation and brainstorming
- Multi-agent workflows with orchestrator
**IDE Best For**:
- Active development and implementation
- File operations and project integration
- Story management and development cycles
- Code review and debugging
### Quality Assurance
- Use appropriate agents for specialized tasks
- Follow Agile ceremonies and review processes
- Maintain document consistency with PO agent
- Regular validation with checklists and templates
### Performance Optimization
- Use specific agents vs. `bmad-master` for focused tasks
- Choose appropriate team size for project needs
- Leverage technical preferences for consistency
- Regular context management and cache clearing
## Success Tips
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
- **Use bmad-master for document organization** - Sharding creates manageable chunks
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Getting Help
- **Commands**: Use `/help` in any environment to see available commands
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
- **Documentation**: Check `docs/` folder for project-specific context
- **Community**: Discord and GitHub resources available for support
==================== END: data#bmad-kb ====================
==================== START: data#technical-preferences ====================

View File

@@ -39,9 +39,9 @@ These references map directly to bundle sections:
---
==================== START: agents#bmad-orchestrator ====================
# bmad
# bmad-orchestrator
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
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:
```yaml
agent:
@@ -73,9 +73,9 @@ startup:
- If clear match to an agent's expertise, suggest transformation with *agent command
- If project-oriented, suggest *workflow-guidance to explore options
- Load resources only when needed - never pre-load
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
commands:
help: Show this guide with available agents and workflows
chat-mode: Start conversational mode for detailed assistance
chat-mode: Start conversational mode for detailed assistance
kb-mode: Load full BMAD knowledge base
status: Show current context, active agent, and progress
agent: Transform into a specialized agent (list if name not specified)
@@ -90,41 +90,40 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
help-display-template: |
=== BMAD Orchestrator Commands ===
All commands must start with * (asterisk)
Core Commands:
*help ............... Show this guide
*chat-mode .......... Start conversational mode for detailed assistance
*kb-mode ............ Load full BMAD knowledge base
*status ............. Show current context, active agent, and progress
*exit ............... Return to BMad or exit session
Agent & Task Management:
*agent [name] ....... Transform into specialized agent (list if no name)
*task [name] ........ Run specific task (list if no name, requires agent)
*checklist [name] ... Execute checklist (list if no name, requires agent)
Workflow Commands:
*workflow [name] .... Start specific workflow (list if no name)
*workflow-guidance .. Get personalized help selecting the right workflow
Other Commands:
*yolo ............... Toggle skip confirmations mode
*party-mode ......... Group chat with all agents
*doc-out ............ Output full document
=== Available Specialist Agents ===
[Dynamically list each agent in bundle with format:
*agent {id}: {title}
When to use: {whenToUse}
Key deliverables: {main outputs/documents}]
=== Available Workflows ===
[Dynamically list each workflow in bundle with format:
*workflow {id}: {name}
Purpose: {description}]
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
fuzzy-matching:
- 85% confidence threshold
- Show numbered list if unsure
@@ -345,6 +344,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
- **Reusable Resources**: Portable templates, tasks, and checklists
- **Slash Command Integration**: Quick agent switching and control
### When to Use BMAD
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
- **Team Collaboration**: Multiple roles working together
- **Quality Assurance**: Structured testing and validation
- **Documentation**: Professional PRDs, architecture docs, user stories
## Getting Started
### Quick Start Options
#### Option 1: Web UI
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
5. Type `/help` to see available commands
#### Option 2: IDE Integration
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
```bash
# Interactive installation (recommended)
npx bmad-method install
```
**Installation Steps**:
- Choose "Complete installation"
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
**Verify Installation**:
- `.bmad-core/` folder created with all agents
- IDE-specific integration files created
- All agent commands/rules/modes available
### Environment Selection Guide
**Use Web UI for**:
- Initial planning and documentation (PRD, architecture)
- Cost-effective document creation (especially with Gemini)
- Brainstorming and analysis phases
- Multi-agent consultation and planning
**Use IDE for**:
- Active development and coding
- File operations and project integration
- Document sharding and story management
- Implementation workflow (SM/Dev cycles)
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
## Core Philosophy
### Vibe CEO'ing
@@ -366,18 +419,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
## IDE Development Workflow
### Key Workflow Principles
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
5. Use a new chat window to allow the SM agent to `draft the next story`.
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
2. **Clean Handoffs**: Always start fresh when switching between agents
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
4. **Iterative Development**: Complete one story before starting the next
5. **Documentation First**: Always start with solid PRD and architecture
With this work flow, there is only 1 story in progress at a time, worked sequentially.
## Agent System
### Core Development Team
| Agent | Role | Primary Functions | When to Use |
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
| `dev` | Developer | Code implementation, debugging | All development tasks |
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
### Meta Agents
| Agent | Role | Primary Functions | When to Use |
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
### Agent Interaction Commands
#### IDE-Specific Syntax
**Agent Loading by IDE**:
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
**Chat Management Guidelines**:
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
- **Roo Code**: Switch modes within the same conversation
**Common Task Commands**:
- `*help` - Show available commands
- `*status` - Show current context/progress
- `*exit` - Exit the agent mode
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
- `*create` - Run create-next-story task (SM agent)
**In Web UI**:
```text
/pm create-doc prd
/architect review system design
/dev implement story 1.2
/help - Show available commands
/switch agent-name - Change active agent (if orchestrator available)
```
## Team Configurations
### Pre-Built Teams
#### Team All
- **Includes**: All 10 agents + orchestrator
- **Use Case**: Complete projects requiring all roles
- **Bundle**: `team-all.txt`
#### Team Fullstack
- **Includes**: PM, Architect, Developer, QA, UX Expert
- **Use Case**: End-to-end web/mobile development
- **Bundle**: `team-fullstack.txt`
#### Team No-UI
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
- **Use Case**: Backend services, APIs, system development
- **Bundle**: `team-no-ui.txt`
## Core Architecture
### System Overview
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).
### Key Architectural Components
#### 1. Agents (`bmad-core/agents/`)
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
- **Startup Instructions**: Can load project-specific documentation for immediate context
#### 2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Define collections of agents bundled together for specific purposes
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
- **Usage**: Creates pre-packaged contexts for web UI environments
#### 3. Workflows (`bmad-core/workflows/`)
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
#### 4. Reusable Resources
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
### Dual Environment Architecture
#### IDE Environment
- Users interact directly with agent markdown files
- Agents can access all dependencies dynamically
- Supports real-time file operations and project integration
- Optimized for development workflow execution
#### Web UI Environment
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
- Created by the web-builder tool for upload to web interfaces
- Provides complete context in one package
### Template Processing System
BMAD employs a sophisticated template system with three key components:
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
**Template Features**:
- **Self-contained**: Templates embed both output structure and processing instructions
- **Variable Substitution**: `{{placeholders}}` for dynamic content
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
### Technical Preferences Integration
The `technical-preferences.md` file serves as a persistent technical profile that:
- Ensures consistency across all agents and projects
- Eliminates repetitive technology specification
- Provides personalized recommendations aligned with user preferences
- Evolves over time with lessons learned
### Build and Delivery Process
The `web-builder.js` tool creates web-ready bundles by:
1. Reading agent or team definition files
2. Recursively resolving all dependencies
3. Concatenating content into single text files with clear separators
4. Outputting ready-to-upload bundles for web AI interfaces
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
## Complete Development Workflow
### Planning Phase (Web UI Recommended)
**Ideal for cost efficiency, especially with Gemini:**
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
2. **Project Brief**: Create foundation document (Analyst or user)
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
#### Example Planning Prompts
**For PRD Creation**:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
```
**For Architecture Design**:
```text
"Based on this PRD, design a scalable technical architecture
that can handle [specific requirements]."
```
### Critical Transition: Web UI to IDE
**Once planning is complete, you MUST switch to IDE for development:**
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
### IDE Development Workflow
**Prerequisites**: Planning documents must exist in `docs/` folder
1. **Document Sharding**:
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
- If architecture exists, shard to `docs/architecture/` folder
- Results in multiple manageable documents and epic files
2. **Verify Sharded Content**:
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
- Source tree document and coding standards for dev agent reference
- Sharded docs for SM agent story creation
**Resulting Folder Structure**:
- `docs/prd/` - Broken down PRD sections
- `docs/architecture/` - Broken down architecture sections
- `docs/stories/` - Generated user stories
3. **Development Cycle** (Sequential, one story at a time):
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
- SM executes create-next-story task
- Review generated story in `docs/stories/`
- Update status from "Draft" to "Approved"
**Step 2 - Story Implementation**: New chat window → `@dev`
- Agent asks which story to implement
- Include story file content to save dev agent lookup time
- Dev follows tasks/subtasks, marking completion
- Dev leaves notes for SM about any deviations
- Update status to "Done"
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
### Status Tracking Workflow
Stories progress through defined statuses:
- **Draft** → **Approved** → **InProgress** → **Done**
Each status change requires user verification and approval before proceeding.
### Workflow Types
#### Greenfield Development
- Business analysis and market research
- Product requirements and feature definition
- System architecture and design
- Development execution
- Testing and deployment
#### Brownfield Enhancement
- Current system analysis
- Enhancement planning
- Impact assessment
- Incremental development
- Integration testing
## Document Creation Best Practices
### Required File Naming for Framework Integration
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter**:
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
### Cost-Effective Document Creation Workflow
**Recommended for Large Documents (PRD, Architecture):**
1. **Use Web UI**: Create documents in web interface for cost efficiency
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
4. **Switch to IDE**: Use IDE agents for development and smaller documents
### Document Sharding
Templates with Level 2 headings (`##`) can be automatically sharded:
**Original PRD**:
```markdown
## Goals and Background Context
## Requirements
## User Interface Design Goals
## Success Metrics
```
**After Sharding**:
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
## Usage Patterns and Best Practices
### Environment-Specific Usage
**Web UI Best For**:
- Initial planning and documentation phases
- Cost-effective large document creation
- Agent consultation and brainstorming
- Multi-agent workflows with orchestrator
**IDE Best For**:
- Active development and implementation
- File operations and project integration
- Story management and development cycles
- Code review and debugging
### Quality Assurance
- Use appropriate agents for specialized tasks
- Follow Agile ceremonies and review processes
- Maintain document consistency with PO agent
- Regular validation with checklists and templates
### Performance Optimization
- Use specific agents vs. `bmad-master` for focused tasks
- Choose appropriate team size for project needs
- Leverage technical preferences for consistency
- Regular context management and cache clearing
## Success Tips
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
- **Use bmad-master for document organization** - Sharding creates manageable chunks
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Getting Help
- **Commands**: Use `/help` in any environment to see available commands
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
- **Documentation**: Check `docs/` folder for project-specific context
- **Community**: Discord and GitHub resources available for support
==================== END: data#bmad-kb ====================
==================== START: utils#workflow-management ====================

60
dist/agents/dev.txt vendored
View File

@@ -43,66 +43,58 @@ These references map directly to bundle sections:
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:
```yml
```yaml
agent:
name: James
id: dev
title: Full Stack Developer
icon: 💻
whenToUse: "Use for code implementation, debugging, refactoring, and development best practices"
customization:
whenToUse: Use for code implementation, debugging, refactoring, and development best practices
customization: null
persona:
role: Expert Senior Software Engineer & Implementation Specialist
style: Extremely concise, pragmatic, detail-oriented, solution-focused
identity: Expert who implements stories by reading requirements and executing tasks sequentially with comprehensive testing
focus: Executing story tasks with precision, updating Dev Agent Record sections only, maintaining minimal context overhead
core_principles:
- CRITICAL: Story-Centric - Story has ALL info. NEVER load PRD/architecture/other docs files unless explicitly directed in dev notes
- CRITICAL: Load Standards - MUST load docs/architecture/coding-standards.md into core memory at startup
- CRITICAL: Config-Based Loading - MUST load .bmad-core/core-config.yml at startup, then load ONLY files listed in devLoadAlwaysFiles. Inform user of missing files but continue
- CRITICAL: Dev Record Only - ONLY update Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
- Sequential Execution - Complete tasks 1-by-1 in order. Mark [x] before next. No skipping
- Test-Driven Quality - Write tests alongside code. Task incomplete without passing tests
- Debug Log Discipline - Log temp changes to table. Revert after fix. Keep story lean
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
- Code Excellence - Clean, secure, maintainable code per coding-standards.md
- Code Excellence - Clean, secure, maintainable code per loaded standards
- Numbered Options - Always use numbered lists when presenting choices
startup:
- Announce: Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT load any story files or coding-standards.md during startup
- CRITICAL: Load .bmad-core/core-config.yml and read devLoadAlwaysFiles list
- CRITICAL: Load ONLY files specified in devLoadAlwaysFiles. If any missing, inform user but continue
- CRITICAL: Do NOT load any story files during startup unless user requested you do
- CRITICAL: Do NOT scan docs/stories/ directory automatically
- CRITICAL: Do NOT begin any tasks automatically
- Wait for user to specify story or ask for story selection
- Only load files and begin work when explicitly requested by user
- Only load story files and begin work when explicitly requested by user
commands:
- "*help" - Show commands
- "*chat-mode" - Conversational mode
- "*run-tests" - Execute linting+tests
- "*lint" - Run linting only
- "*dod-check" - Run story-dod-checklist
- "*status" - Show task progress
- "*debug-log" - Show debug entries
- "*complete-story" - Finalize to "Review"
- "*exit" - Leave developer mode
- help: Show numbered list of the following commands to allow selection
- chat-mode: Conversational mode for development discussions
- run-tests: Execute linting and tests
- lint: Run linting only
- dod-check: Run story-dod-checklist
- status: Show task progress
- debug-log: Show debug entries
- complete-story: Finalize to "Review"
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
task-execution:
flow: "Read task→Implement→Write tests→Pass tests→Update [x]→Next task"
flow: Read task→Implement→Write tests→Pass tests→Update [x]→Next task
updates-ONLY:
- "Checkboxes: [ ] not started | [-] in progress | [x] complete"
- "Debug Log: | Task | File | Change | Reverted? |"
- "Completion Notes: Deviations only, <50 words"
- "Change Log: Requirement changes only"
blocking: "Unapproved deps | Ambiguous after story check | 3 failures | Missing config"
done: "Code matches reqs + Tests pass + Follows standards + No lint errors"
completion: "All [x]→Lint→Tests(100%)→Integration(if noted)→Coverage(80%+)→E2E(if noted)→DoD→Summary→HALT"
- 'Checkboxes: [ ] not started | [-] in progress | [x] complete'
- 'Debug Log: | Task | File | Change | Reverted? |'
- 'Completion Notes: Deviations only, <50 words'
- 'Change Log: Requirement changes only'
blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing config
done: Code matches reqs + Tests pass + Follows standards + No lint errors
completion: All [x]→Lint→Tests(100%)→Integration(if noted)→Coverage(80%+)→E2E(if noted)→DoD→Summary→HALT
dependencies:
tasks:
- execute-checklist

14
dist/agents/pm.txt vendored
View File

@@ -43,7 +43,7 @@ These references map directly to bundle sections:
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:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -73,10 +73,10 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Deep conversation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*exit" - Say goodbye as the PM, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Deep conversation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- exit: Say goodbye as the PM, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc
@@ -1148,6 +1148,8 @@ Document sharded successfully:
==================== START: templates#prd-tmpl ====================
# {{Project Name}} Product Requirements Document (PRD)
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
## Goals and Background Context
@@ -1351,6 +1353,8 @@ so that {{benefit}}.
==================== START: templates#brownfield-prd-tmpl ====================
# {{Project Name}} Brownfield Enhancement PRD
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:

20
dist/agents/po.txt vendored
View File

@@ -43,7 +43,7 @@ These references map directly to bundle sections:
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:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -75,15 +75,15 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Product Owner consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run validation checklist (default->po-master-checklist)'
- '*shard-doc {document}" - Break down document into actionable parts'
- '*correct-course" - Analyze and suggest project course corrections'
- '*create-epic" - Create epic for brownfield projects (task brownfield-create-epic)'
- '*create-story" - Create user story from requirements (task brownfield-create-story)'
- '*exit" - Say Goodbye, You are no longer this Agent'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
- shard-doc {document}: Break down document into actionable parts
- correct-course: Analyze and suggest project course corrections
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-story: Create user story from requirements (task brownfield-create-story)
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
dependencies:
tasks:
- execute-checklist

8
dist/agents/qa.txt vendored
View File

@@ -75,10 +75,10 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) QA consultation with advanced-elicitation for test strategy'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*exit" - Say goodbye as the QA Test Architect, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) QA consultation with advanced-elicitation for test strategy
- create-doc {template}: Create doc (no template = show available templates)
- exit: Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
dependencies:
data:
- technical-preferences

137
dist/agents/sm.txt vendored
View File

@@ -46,7 +46,6 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- 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
agent:
@@ -62,31 +61,25 @@ persona:
identity: Story creation expert who prepares detailed, actionable stories for AI developers
focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
core_principles:
- Task Adherence - Rigorously follow create-next-story procedures
- Checklist-Driven Validation - Apply story-draft-checklist meticulously
- Clarity for Developer Handoff - Stories must be immediately actionable
- Focus on One Story at a Time - Complete one before starting next
- Numbered Options Protocol - Always use numbered lists for selections
- Rigorously follow `create-next-story` procedure to generate the detailed user story
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
- You are NOT allowed to implement stories or modify code EVER!
startup:
- Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT automatically execute create-next-story tasks during startup
- CRITICAL: Do NOT create or modify any files during startup
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
- Offer to help with story preparation but wait for explicit user confirmation
- Only execute tasks when user explicitly requests them
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent'
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - Conversational mode with advanced-elicitation for advice'
- '*create" - Execute all steps in Create Next Story Task document'
- '*pivot" - Run correct-course task (ensure no story already created first)'
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
- '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
- '*index-docs" - Update documentation index in /docs/index.md'
- '*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: Conversational mode with advanced-elicitation for advice
- create|draft: Execute create-next-story
- pivot: Execute `correct-course` task
- checklist {checklist}: Show numbered list of checklists, execute selection
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
dependencies:
tasks:
- create-next-story
- execute-checklist
- course-correct
templates:
- story-tmpl
checklists:
@@ -103,45 +96,42 @@ dependencies:
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
## Inputs for this Task
- Access to the project's documentation repository, specifically:
- `docs/index.md` (hereafter "Index Doc")
- All Epic files - located in one of these locations:
- Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Secondary: `docs/epics/epic-{n}-{description}.md`
- User-specified location if not found in above paths
- Existing story files in `docs/stories/`
- Main PRD (hereafter "PRD Doc")
- Main Architecture Document (hereafter "Main Arch Doc")
- Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
- Project Structure Guide (`docs/project-structure.md`)
- Operational Guidelines Document (`docs/operational-guidelines.md`)
- Technology Stack Document (`docs/tech-stack.md`)
- Data Models Document (as referenced in Index Doc)
- API Reference Document (as referenced in Index Doc)
- UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
- The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
- The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
- User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
## Task Execution Instructions
### 0. Load Core Configuration
[[LLM: CRITICAL - This MUST be your first step]]
- Load `.bmad-core/core-config.yml` from the project root
- If the file does not exist:
- HALT and inform the user: "core-config.yml not found. This file is required for story creation. You can:
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yml and configure it for your project
2. Run the BMAD installer against your project to upgrade and add the file automatically
Please add and configure core-config.yml before proceeding."
- Extract the following key configurations:
- `dev-story-location`: Where to save story files
- `prd.prdSharded`: Whether PRD is sharded or monolithic
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
- `prd.prdShardedLocation`: Location of sharded epic files
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
- `architecture.architectureVersion`: Architecture document version
- `architecture.architectureSharded`: Whether architecture is sharded
- `architecture.architecture-file`: Location of monolithic architecture
- `architecture.architectureShardedLocation`: Location of sharded architecture files
### 1. Identify Next Story for Preparation
#### 1.1 Locate Epic Files
- First, determine where epic files are located:
- Check `docs/prd/` for files matching pattern `epic-{n}-*.md`
- If not found, check `docs/epics/` for files matching pattern `epic-{n}-*.md`
- If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
- Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Based on `prdSharded` from config:
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
#### 1.2 Review Existing Stories
- Review `docs/stories/` to find the highest-numbered story file.
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
- If the directory exists and has at least 1 file, find the highest-numbered story file.
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
- Verify its `Status` is 'Done' (or equivalent).
- If not 'Done', present an alert to the user:
@@ -159,17 +149,17 @@ To identify the next logical story based on project progress and epic definition
```
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}-*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}-*.md`, then `epic-{lastEpicNum + 2}-*.md`, etc.) whose prerequisites are met.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
- **If no story files exist in `docs/stories/`:**
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
### 2. Gather Core Story Requirements (from Epic File)
### 2. Gather Core Story Requirements (from Epic)
- For the identified story, open its parent Epic File (e.g., `epic-{epicNum}-*.md` from the location identified in step 1.1).
- For the identified story, review its parent Epic (e.g., `epic-{epicNum}*.md` from the location identified in step 1.1).
- Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
- Keep a record of this original epic-defined scope for later deviation analysis.
@@ -178,7 +168,7 @@ To identify the next logical story based on project progress and epic definition
[[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
- If this is not the first story (i.e., previous story exists):
- Read the previous story file: `docs/stories/{prevEpicNum}.{prevStoryNum}.story.md`
- Read the previous sequential story from `docs/stories`
- Pay special attention to:
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
- Any deviations from planned implementation
@@ -187,18 +177,30 @@ To identify the next logical story based on project progress and epic definition
- Any "lessons learned" or notes for future stories
- Extract relevant insights that might inform the current story's preparation
### 4. Gather & Synthesize Architecture Context from Sharded Docs
### 4. Gather & Synthesize Architecture Context
[[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
[[LLM: CRITICAL - You MUST gather technical details from the architecture documents. NEVER make up technical details not found in these documents.]]
#### 4.1 Start with Architecture Index
#### 4.1 Determine Architecture Document Strategy
- Read `docs/architecture/index.md` to understand the full scope of available documentation
- Identify which sharded documents are most relevant to the current story
Based on configuration loaded in Step 0:
#### 4.2 Recommended Reading Order Based on Story Type
- **If `architectureVersion: v4` and `architectureSharded: true`**:
- Read `{architectureShardedLocation}/index.md` to understand available documentation
- Follow the structured reading order in section 4.2 below
- **If `architectureVersion: v4` and `architectureSharded: false`**:
- Load the monolithic architecture from `architecture-file`
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
- **If `architectureVersion` is NOT v4**:
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
- If `architectureSharded: true`: Search sharded files by filename relevance
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
[[LLM: Read documents in this order, but ALWAYS verify relevance to the specific story. Skip irrelevant sections but NEVER skip documents that contain information needed for the story.]]
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
**For ALL Stories:**
@@ -207,9 +209,18 @@ To identify the next logical story based on project progress and epic definition
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
**For Backend/API Stories, additionally read:** 5. `docs/architecture/data-models.md` - Data structures and validation rules 6. `docs/architecture/database-schema.md` - Database design and relationships 7. `docs/architecture/backend-architecture.md` - Service patterns and structure 8. `docs/architecture/rest-api-spec.md` - API endpoint specifications 9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Backend/API Stories, additionally read:**
5. `docs/architecture/data-models.md` - Data structures and validation rules
6. `docs/architecture/database-schema.md` - Database design and relationships
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Frontend/UI Stories, additionally read:** 5. `docs/architecture/frontend-architecture.md` - Component structure and patterns 6. `docs/architecture/components.md` - Specific component designs 7. `docs/architecture/core-workflows.md` - User interaction flows 8. `docs/architecture/data-models.md` - Frontend data handling
**For Frontend/UI Stories, additionally read:**
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
6. `docs/architecture/components.md` - Specific component designs
7. `docs/architecture/core-workflows.md` - User interaction flows
8. `docs/architecture/data-models.md` - Frontend data handling
**For Full-Stack Stories:**
@@ -242,7 +253,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
### 6. Populate Story Template with Full Context
- Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
- Use the Story Template to structure the file.
- Fill in:
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
@@ -289,7 +300,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
- Verify all source references are included for technical details
- Ensure tasks align with both epic requirements and architecture constraints
- Update status to "Draft"
- Save the story file to `docs/stories/{epicNum}.{storyNum}.story.md`
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
### 9. Report Completion

View File

@@ -79,13 +79,13 @@ startup:
- Greet the user with your name and role, and inform of the *help command.
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) UX consultation with advanced-elicitation for design decisions'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*generate-ui-prompt" - Create AI frontend generation prompt'
- '*research {topic}" - Generate deep research prompt for UX investigation'
- '*execute-checklist {checklist}" - Run design validation checklist'
- '*exit" - Say goodbye as the UX Expert, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) UX consultation with advanced-elicitation for design decisions
- create-doc {template}: Create doc (no template = show available templates)
- generate-ui-prompt: Create AI frontend generation prompt
- research {topic}: Generate deep research prompt for UX investigation
- execute-checklist {checklist}: Run design validation checklist
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
dependencies:
tasks:
- generate-ai-frontend-prompt
@@ -639,6 +639,8 @@ The LLM will:
==================== START: templates#front-end-spec-tmpl ====================
# {{Project Name}} UI/UX Specification
[[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
[[LLM: Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.]]
## Introduction

View File

@@ -99,6 +99,183 @@ dependencies:
```
==================== END: agents#game-designer ====================
==================== START: tasks#create-doc ====================
# Create Document from Template Task
## Purpose
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
## Instructions
### 1. Identify Template and Context
- Determine which template to use (user-provided or list available for selection to user)
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
@{example}
dependencies:
templates: - prd-tmpl - architecture-tmpl
@{/example}
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
- Understand the document purpose and target audience
### 2. Determine Interaction Mode
Confirm with the user their preferred interaction style:
- **Incremental:** Work through chunks of the document.
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
### 3. Execute Template
- Load specified template from `templates#*` or the /templates directory
- Follow ALL embedded LLM instructions within the template
- Process template markup according to `utils#template-format` conventions
### 4. Template Processing Rules
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
- Replace all {{placeholders}} with actual content
- Execute all [[LLM: instructions]] internally
- Process `<<REPEAT>>` sections as needed
- Evaluate ^^CONDITION^^ blocks and include only if applicable
- Use @{examples} for guidance but never output them
### 5. Content Generation
- **Incremental Mode**: Present each major section for review before proceeding
- **YOLO Mode**: Generate all sections, then review complete document with user
- Apply any elicitation protocols specified in template
- Incorporate user feedback and iterate as needed
### 6. Validation
If template specifies a checklist:
- Run the appropriate checklist against completed document
- Document completion status for each item
- Address any deficiencies found
- Present validation summary to user
### 7. Final Presentation
- Present clean, formatted content only
- Ensure all sections are complete
- DO NOT truncate or summarize content
- Begin directly with document content (no preamble)
- Include any handoff prompts specified in template
## Important Notes
- Template markup is for AI processing only - never expose to users
==================== END: tasks#create-doc ====================
==================== START: tasks#execute-checklist ====================
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
## Context
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
## Available Checklists
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
## Instructions
1. **Initial Assessment**
- If user or the task being run provides a checklist name:
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
- If multiple matches found, ask user to clarify
- Load the appropriate checklist from bmad-core/checklists/
- If no checklist specified:
- Ask the user which checklist they want to use
- Present the available options from the files in the checklists folder
- Confirm if they want to work through the checklist:
- Section by section (interactive mode - very time consuming)
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
2. **Document and Artifact Gathering**
- Each checklist will specify its required documents/artifacts at the beginning
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
3. **Checklist Processing**
If in interactive mode:
- Work through each section of the checklist one at a time
- For each section:
- Review all items in the section following instructions for that section embedded in the checklist
- Check each item against the relevant documentation or artifacts as appropriate
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
If in YOLO mode:
- Process all sections at once
- Create a comprehensive report of all findings
- Present the complete analysis to the user
4. **Validation Approach**
For each checklist item:
- Read and understand the requirement
- Look for evidence in the documentation that satisfies the requirement
- Consider both explicit mentions and implicit coverage
- Aside from this, follow all checklist llm instructions
- Mark items as:
- ✅ PASS: Requirement clearly met
- ❌ FAIL: Requirement not met or insufficient coverage
- ⚠️ PARTIAL: Some aspects covered but needs improvement
- N/A: Not applicable to this case
5. **Section Analysis**
For each section:
- think step by step to calculate pass rate
- Identify common themes in failed items
- Provide specific recommendations for improvement
- In interactive mode, discuss findings with user
- Document any user decisions or explanations
6. **Final Report**
Prepare a summary that includes:
- Overall checklist completion status
- Pass rates by section
- List of failed items with context
- Specific recommendations for improvement
- Any sections or items marked as N/A with justification
## Checklist Execution Methodology
Each checklist now contains embedded LLM prompts and instructions that will:
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
3. **Provide contextual guidance** - Section-specific prompts for better validation
4. **Generate comprehensive reports** - Final summary with detailed findings
The LLM will:
- Execute the complete checklist validation
- Present a final report with pass/fail rates and key findings
- Offer to provide detailed analysis of any section, especially those with warnings or failures
==================== END: tasks#execute-checklist ====================
==================== START: tasks#game-design-brainstorming ====================
# Game Design Brainstorming Techniques Task
@@ -392,6 +569,310 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
- Plan for iteration based on player feedback
==================== END: tasks#game-design-brainstorming ====================
==================== START: tasks#create-deep-research-prompt ====================
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
## Purpose
Generate well-structured research prompts that:
- Define clear research objectives and scope
- Specify appropriate research methodologies
- Outline expected deliverables and formats
- Guide systematic investigation of complex topics
- Ensure actionable insights are captured
## Research Type Selection
[[LLM: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.]]
### 1. Research Focus Options
Present these numbered options to the user:
1. **Product Validation Research**
- Validate product hypotheses and market fit
- Test assumptions about user needs and solutions
- Assess technical and business feasibility
- Identify risks and mitigation strategies
2. **Market Opportunity Research**
- Analyze market size and growth potential
- Identify market segments and dynamics
- Assess market entry strategies
- Evaluate timing and market readiness
3. **User & Customer Research**
- Deep dive into user personas and behaviors
- Understand jobs-to-be-done and pain points
- Map customer journeys and touchpoints
- Analyze willingness to pay and value perception
4. **Competitive Intelligence Research**
- Detailed competitor analysis and positioning
- Feature and capability comparisons
- Business model and strategy analysis
- Identify competitive advantages and gaps
5. **Technology & Innovation Research**
- Assess technology trends and possibilities
- Evaluate technical approaches and architectures
- Identify emerging technologies and disruptions
- Analyze build vs. buy vs. partner options
6. **Industry & Ecosystem Research**
- Map industry value chains and dynamics
- Identify key players and relationships
- Analyze regulatory and compliance factors
- Understand partnership opportunities
7. **Strategic Options Research**
- Evaluate different strategic directions
- Assess business model alternatives
- Analyze go-to-market strategies
- Consider expansion and scaling paths
8. **Risk & Feasibility Research**
- Identify and assess various risk factors
- Evaluate implementation challenges
- Analyze resource requirements
- Consider regulatory and legal implications
9. **Custom Research Focus**
[[LLM: Allow user to define their own specific research focus.]]
- User-defined research objectives
- Specialized domain investigation
- Cross-functional research needs
### 2. Input Processing
[[LLM: Based on the selected research type and any provided inputs (project brief, brainstorming results, etc.), extract relevant context and constraints.]]
**If Project Brief provided:**
- Extract key product concepts and goals
- Identify target users and use cases
- Note technical constraints and preferences
- Highlight uncertainties and assumptions
**If Brainstorming Results provided:**
- Synthesize main ideas and themes
- Identify areas needing validation
- Extract hypotheses to test
- Note creative directions to explore
**If Market Research provided:**
- Build on identified opportunities
- Deepen specific market insights
- Validate initial findings
- Explore adjacent possibilities
**If Starting Fresh:**
- Gather essential context through questions
- Define the problem space
- Clarify research objectives
- Establish success criteria
## Process
### 3. Research Prompt Structure
[[LLM: Based on the selected research type and context, collaboratively develop a comprehensive research prompt with these components.]]
#### A. Research Objectives
[[LLM: Work with the user to articulate clear, specific objectives for the research.]]
- Primary research goal and purpose
- Key decisions the research will inform
- Success criteria for the research
- Constraints and boundaries
#### B. Research Questions
[[LLM: Develop specific, actionable research questions organized by theme.]]
**Core Questions:**
- Central questions that must be answered
- Priority ranking of questions
- Dependencies between questions
**Supporting Questions:**
- Additional context-building questions
- Nice-to-have insights
- Future-looking considerations
#### C. Research Methodology
[[LLM: Specify appropriate research methods based on the type and objectives.]]
**Data Collection Methods:**
- Secondary research sources
- Primary research approaches (if applicable)
- Data quality requirements
- Source credibility criteria
**Analysis Frameworks:**
- Specific frameworks to apply
- Comparison criteria
- Evaluation methodologies
- Synthesis approaches
#### D. Output Requirements
[[LLM: Define how research findings should be structured and presented.]]
**Format Specifications:**
- Executive summary requirements
- Detailed findings structure
- Visual/tabular presentations
- Supporting documentation
**Key Deliverables:**
- Must-have sections and insights
- Decision-support elements
- Action-oriented recommendations
- Risk and uncertainty documentation
### 4. Prompt Generation
[[LLM: Synthesize all elements into a comprehensive, ready-to-use research prompt.]]
**Research Prompt Template:**
```markdown
## Research Objective
[Clear statement of what this research aims to achieve]
## Background Context
[Relevant information from project brief, brainstorming, or other inputs]
## Research Questions
### Primary Questions (Must Answer)
1. [Specific, actionable question]
2. [Specific, actionable question]
...
### Secondary Questions (Nice to Have)
1. [Supporting question]
2. [Supporting question]
...
## Research Methodology
### Information Sources
- [Specific source types and priorities]
### Analysis Frameworks
- [Specific frameworks to apply]
### Data Requirements
- [Quality, recency, credibility needs]
## Expected Deliverables
### Executive Summary
- Key findings and insights
- Critical implications
- Recommended actions
### Detailed Analysis
[Specific sections needed based on research type]
### Supporting Materials
- Data tables
- Comparison matrices
- Source documentation
## Success Criteria
[How to evaluate if research achieved its objectives]
## Timeline and Priority
[If applicable, any time constraints or phasing]
```
### 5. Review and Refinement
[[LLM: Present the draft research prompt for user review and refinement.]]
1. **Present Complete Prompt**
- Show the full research prompt
- Explain key elements and rationale
- Highlight any assumptions made
2. **Gather Feedback**
- Are the objectives clear and correct?
- Do the questions address all concerns?
- Is the scope appropriate?
- Are output requirements sufficient?
3. **Refine as Needed**
- Incorporate user feedback
- Adjust scope or focus
- Add missing elements
- Clarify ambiguities
### 6. Next Steps Guidance
[[LLM: Provide clear guidance on how to use the research prompt.]]
**Execution Options:**
1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
2. **Guide Human Research**: Use as a framework for manual research efforts
3. **Hybrid Approach**: Combine AI and human research using this structure
**Integration Points:**
- How findings will feed into next phases
- Which team members should review results
- How to validate findings
- When to revisit or expand research
## Important Notes
- The quality of the research prompt directly impacts the quality of insights gathered
- Be specific rather than general in research questions
- Consider both current state and future implications
- Balance comprehensiveness with focus
- Document assumptions and limitations clearly
- Plan for iterative refinement based on initial findings
==================== END: tasks#create-deep-research-prompt ====================
==================== START: tasks#advanced-elicitation ====================
# Advanced Game Design Elicitation Task

View File

@@ -107,6 +107,106 @@ dependencies:
```
==================== END: agents#game-developer ====================
==================== START: tasks#execute-checklist ====================
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
## Context
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
## Available Checklists
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
## Instructions
1. **Initial Assessment**
- If user or the task being run provides a checklist name:
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
- If multiple matches found, ask user to clarify
- Load the appropriate checklist from bmad-core/checklists/
- If no checklist specified:
- Ask the user which checklist they want to use
- Present the available options from the files in the checklists folder
- Confirm if they want to work through the checklist:
- Section by section (interactive mode - very time consuming)
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
2. **Document and Artifact Gathering**
- Each checklist will specify its required documents/artifacts at the beginning
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
3. **Checklist Processing**
If in interactive mode:
- Work through each section of the checklist one at a time
- For each section:
- Review all items in the section following instructions for that section embedded in the checklist
- Check each item against the relevant documentation or artifacts as appropriate
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
If in YOLO mode:
- Process all sections at once
- Create a comprehensive report of all findings
- Present the complete analysis to the user
4. **Validation Approach**
For each checklist item:
- Read and understand the requirement
- Look for evidence in the documentation that satisfies the requirement
- Consider both explicit mentions and implicit coverage
- Aside from this, follow all checklist llm instructions
- Mark items as:
- ✅ PASS: Requirement clearly met
- ❌ FAIL: Requirement not met or insufficient coverage
- ⚠️ PARTIAL: Some aspects covered but needs improvement
- N/A: Not applicable to this case
5. **Section Analysis**
For each section:
- think step by step to calculate pass rate
- Identify common themes in failed items
- Provide specific recommendations for improvement
- In interactive mode, discuss findings with user
- Document any user decisions or explanations
6. **Final Report**
Prepare a summary that includes:
- Overall checklist completion status
- Pass rates by section
- List of failed items with context
- Specific recommendations for improvement
- Any sections or items marked as N/A with justification
## Checklist Execution Methodology
Each checklist now contains embedded LLM prompts and instructions that will:
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
3. **Provide contextual guidance** - Section-specific prompts for better validation
4. **Generate comprehensive reports** - Final summary with detailed findings
The LLM will:
- Execute the complete checklist validation
- Present a final report with pass/fail rates and key findings
- Offer to provide detailed analysis of any section, especially those with warnings or failures
==================== END: tasks#execute-checklist ====================
==================== START: templates#game-architecture-tmpl ====================
# {{Game Title}} Game Architecture Document

View File

@@ -289,6 +289,106 @@ Execute `checklists#game-story-dod-checklist` against completed story
This task ensures game development stories are immediately actionable and enable efficient AI-driven development of game features.
==================== END: tasks#create-game-story ====================
==================== START: tasks#execute-checklist ====================
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
## Context
The BMAD Method uses various checklists to ensure quality and completeness of different artifacts. Each checklist contains embedded prompts and instructions to guide the LLM through thorough validation and advanced elicitation. The checklists automatically identify their required artifacts and guide the validation process.
## Available Checklists
If the user asks or does not specify a specific checklist, list the checklists available to the agent persona. If the task is being run not with a specific agent, tell the user to check the bmad-core/checklists folder to select the appropriate one to run.
## Instructions
1. **Initial Assessment**
- If user or the task being run provides a checklist name:
- Try fuzzy matching (e.g. "architecture checklist" -> "architect-checklist")
- If multiple matches found, ask user to clarify
- Load the appropriate checklist from bmad-core/checklists/
- If no checklist specified:
- Ask the user which checklist they want to use
- Present the available options from the files in the checklists folder
- Confirm if they want to work through the checklist:
- Section by section (interactive mode - very time consuming)
- All at once (YOLO mode - recommended for checklists, there will be a summary of sections at the end to discuss)
2. **Document and Artifact Gathering**
- Each checklist will specify its required documents/artifacts at the beginning
- Follow the checklist's specific instructions for what to gather, generally a file can be resolved in the docs folder, if not or unsure, halt and ask or confirm with the user.
3. **Checklist Processing**
If in interactive mode:
- Work through each section of the checklist one at a time
- For each section:
- Review all items in the section following instructions for that section embedded in the checklist
- Check each item against the relevant documentation or artifacts as appropriate
- Present summary of findings for that section, highlighting warnings, errors and non applicable items (rationale for non-applicability).
- Get user confirmation before proceeding to next section or if any thing major do we need to halt and take corrective action
If in YOLO mode:
- Process all sections at once
- Create a comprehensive report of all findings
- Present the complete analysis to the user
4. **Validation Approach**
For each checklist item:
- Read and understand the requirement
- Look for evidence in the documentation that satisfies the requirement
- Consider both explicit mentions and implicit coverage
- Aside from this, follow all checklist llm instructions
- Mark items as:
- ✅ PASS: Requirement clearly met
- ❌ FAIL: Requirement not met or insufficient coverage
- ⚠️ PARTIAL: Some aspects covered but needs improvement
- N/A: Not applicable to this case
5. **Section Analysis**
For each section:
- think step by step to calculate pass rate
- Identify common themes in failed items
- Provide specific recommendations for improvement
- In interactive mode, discuss findings with user
- Document any user decisions or explanations
6. **Final Report**
Prepare a summary that includes:
- Overall checklist completion status
- Pass rates by section
- List of failed items with context
- Specific recommendations for improvement
- Any sections or items marked as N/A with justification
## Checklist Execution Methodology
Each checklist now contains embedded LLM prompts and instructions that will:
1. **Guide thorough thinking** - Prompts ensure deep analysis of each section
2. **Request specific artifacts** - Clear instructions on what documents/access is needed
3. **Provide contextual guidance** - Section-specific prompts for better validation
4. **Generate comprehensive reports** - Final summary with detailed findings
The LLM will:
- Execute the complete checklist validation
- Present a final report with pass/fail rates and key findings
- Offer to provide detailed analysis of any section, especially those with warnings or failures
==================== END: tasks#execute-checklist ====================
==================== START: templates#game-story-tmpl ====================
# Story: {{Story Title}}

View File

@@ -2019,3 +2019,38 @@ This checklist serves as a comprehensive framework for validating infrastructure
- [ ] Platform component integration validated
- [ ] Cross-platform functionality tested and verified
==================== END: checklists#infrastructure-checklist ====================
==================== START: data#technical-preferences ====================
# User-Defined Preferred Patterns and Preferences
None Listed
==================== END: data#technical-preferences ====================
==================== START: utils#template-format ====================
# Template Format Conventions
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
## Template Markup Elements
- **{{placeholders}}**: Variables to be replaced with actual content
- **[[LLM: instructions]]**: Internal processing instructions for AI agents (never shown to users)
- **REPEAT** sections: Content blocks that may be repeated as needed
- **^^CONDITION^^** blocks: Conditional content included only if criteria are met
- **@{examples}**: Example content for guidance (never output to users)
## Processing Rules
- Replace all {{placeholders}} with project-specific content
- Execute all [[LLM: instructions]] internally without showing users
- Process conditional and repeat blocks as specified
- Use examples for guidance but never include them in final output
- Present only clean, formatted content to users
## Critical Guidelines
- **NEVER display template markup, LLM instructions, or examples to users**
- Template elements are for AI processing only
- Focus on faithful template execution and clean output
- All template-specific instructions are embedded within templates
==================== END: utils#template-format ====================

View File

@@ -1330,6 +1330,405 @@ Embedded knowledge (automatic):
```
==================== END: tasks#generate-expansion-pack ====================
==================== START: tasks#advanced-elicitation ====================
# Advanced Elicitation Task
## Purpose
- Provide optional reflective and brainstorming actions to enhance content quality
- Enable deeper exploration of ideas through structured elicitation techniques
- Support iterative refinement through multiple analytical perspectives
## Task Instructions
### 1. Section Context and Review
[[LLM: When invoked after outputting a section:
1. First, provide a brief 1-2 sentence summary of what the user should look for in the section just presented (e.g., "Please review the technology choices for completeness and alignment with your project needs. Pay special attention to version numbers and any missing categories.")
2. If the section contains Mermaid diagrams, explain each diagram briefly before offering elicitation options (e.g., "The component diagram shows the main system modules and their interactions. Notice how the API Gateway routes requests to different services.")
3. If the section contains multiple distinct items (like multiple components, multiple patterns, etc.), inform the user they can apply elicitation actions to:
- The entire section as a whole
- Individual items within the section (specify which item when selecting an action)
4. Then present the action list as specified below.]]
### 2. Ask for Review and Present Action List
[[LLM: Ask the user to review the drafted section. In the SAME message, inform them that they can suggest additions, removals, or modifications, OR they can select an action by number from the 'Advanced Reflective, Elicitation & Brainstorming Actions'. If there are multiple items in the section, mention they can specify which item(s) to apply the action to. Then, present ONLY the numbered list (0-9) of these actions. Conclude by stating that selecting 9 will proceed to the next section. Await user selection. If an elicitation action (0-8) is chosen, execute it and then re-offer this combined review/elicitation choice. If option 9 is chosen, or if the user provides direct feedback, proceed accordingly.]]
**Present the numbered list (0-9) with this exact format:**
```text
**Advanced Reflective, Elicitation & Brainstorming Actions**
Choose an action (0-9 - 9 to bypass - HELP for explanation of these options):
0. Expand or Contract for Audience
1. Explain Reasoning (CoT Step-by-Step)
2. Critique and Refine
3. Analyze Logical Flow and Dependencies
4. Assess Alignment with Overall Goals
5. Identify Potential Risks and Unforeseen Issues
6. Challenge from Critical Perspective (Self or Other Persona)
7. Explore Diverse Alternatives (ToT-Inspired)
8. Hindsight is 20/20: The 'If Only...' Reflection
9. Proceed / No Further Actions
```
### 2. Processing Guidelines
**Do NOT show:**
- The full protocol text with `[[LLM: ...]]` instructions
- Detailed explanations of each option unless executing or the user asks, when giving the definition you can modify to tie its relevance
- Any internal template markup
**After user selection from the list:**
- Execute the chosen action according to the protocol instructions below
- Ask if they want to select another action or proceed with option 9 once complete
- Continue until user selects option 9 or indicates completion
## Action Definitions
0. Expand or Contract for Audience
[[LLM: Ask the user whether they want to 'expand' on the content (add more detail, elaborate) or 'contract' it (simplify, clarify, make more concise). Also, ask if there's a specific target audience they have in mind. Once clarified, perform the expansion or contraction from your current role's perspective, tailored to the specified audience if provided.]]
1. Explain Reasoning (CoT Step-by-Step)
[[LLM: Explain the step-by-step thinking process, characteristic of your role, that you used to arrive at the current proposal for this content.]]
2. Critique and Refine
[[LLM: From your current role's perspective, review your last output or the current section for flaws, inconsistencies, or areas for improvement, and then suggest a refined version reflecting your expertise.]]
3. Analyze Logical Flow and Dependencies
[[LLM: From your role's standpoint, examine the content's structure for logical progression, internal consistency, and any relevant dependencies. Confirm if elements are presented in an effective order.]]
4. Assess Alignment with Overall Goals
[[LLM: Evaluate how well the current content contributes to the stated overall goals of the document, interpreting this from your specific role's perspective and identifying any misalignments you perceive.]]
5. Identify Potential Risks and Unforeseen Issues
[[LLM: Based on your role's expertise, brainstorm potential risks, overlooked edge cases, or unintended consequences related to the current content or proposal.]]
6. Challenge from Critical Perspective (Self or Other Persona)
[[LLM: Adopt a critical perspective on the current content. If the user specifies another role or persona (e.g., 'as a customer', 'as [Another Persona Name]'), critique the content or play devil's advocate from that specified viewpoint. If no other role is specified, play devil's advocate from your own current persona's viewpoint, arguing against the proposal or current content and highlighting weaknesses or counterarguments specific to your concerns. This can also randomly include YAGNI when appropriate, such as when trimming the scope of an MVP, the perspective might challenge the need for something to cut MVP scope.]]
7. Explore Diverse Alternatives (ToT-Inspired)
[[LLM: From your role's perspective, first broadly brainstorm a range of diverse approaches or solutions to the current topic. Then, from this wider exploration, select and present 2 distinct alternatives, detailing the pros, cons, and potential implications you foresee for each.]]
8. Hindsight is 20/20: The 'If Only...' Reflection
[[LLM: In your current persona, imagine it's a retrospective for a project based on the current content. What's the one 'if only we had known/done X...' that your role would humorously or dramatically highlight, along with the imagined consequences?]]
9. Proceed / No Further Actions
[[LLM: Acknowledge the user's choice to finalize the current work, accept the AI's last output as is, or move on to the next step without selecting another action from this list. Prepare to proceed accordingly.]]
==================== END: tasks#advanced-elicitation ====================
==================== START: tasks#create-deep-research-prompt ====================
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
## Purpose
Generate well-structured research prompts that:
- Define clear research objectives and scope
- Specify appropriate research methodologies
- Outline expected deliverables and formats
- Guide systematic investigation of complex topics
- Ensure actionable insights are captured
## Research Type Selection
[[LLM: First, help the user select the most appropriate research focus based on their needs and any input documents they've provided.]]
### 1. Research Focus Options
Present these numbered options to the user:
1. **Product Validation Research**
- Validate product hypotheses and market fit
- Test assumptions about user needs and solutions
- Assess technical and business feasibility
- Identify risks and mitigation strategies
2. **Market Opportunity Research**
- Analyze market size and growth potential
- Identify market segments and dynamics
- Assess market entry strategies
- Evaluate timing and market readiness
3. **User & Customer Research**
- Deep dive into user personas and behaviors
- Understand jobs-to-be-done and pain points
- Map customer journeys and touchpoints
- Analyze willingness to pay and value perception
4. **Competitive Intelligence Research**
- Detailed competitor analysis and positioning
- Feature and capability comparisons
- Business model and strategy analysis
- Identify competitive advantages and gaps
5. **Technology & Innovation Research**
- Assess technology trends and possibilities
- Evaluate technical approaches and architectures
- Identify emerging technologies and disruptions
- Analyze build vs. buy vs. partner options
6. **Industry & Ecosystem Research**
- Map industry value chains and dynamics
- Identify key players and relationships
- Analyze regulatory and compliance factors
- Understand partnership opportunities
7. **Strategic Options Research**
- Evaluate different strategic directions
- Assess business model alternatives
- Analyze go-to-market strategies
- Consider expansion and scaling paths
8. **Risk & Feasibility Research**
- Identify and assess various risk factors
- Evaluate implementation challenges
- Analyze resource requirements
- Consider regulatory and legal implications
9. **Custom Research Focus**
[[LLM: Allow user to define their own specific research focus.]]
- User-defined research objectives
- Specialized domain investigation
- Cross-functional research needs
### 2. Input Processing
[[LLM: Based on the selected research type and any provided inputs (project brief, brainstorming results, etc.), extract relevant context and constraints.]]
**If Project Brief provided:**
- Extract key product concepts and goals
- Identify target users and use cases
- Note technical constraints and preferences
- Highlight uncertainties and assumptions
**If Brainstorming Results provided:**
- Synthesize main ideas and themes
- Identify areas needing validation
- Extract hypotheses to test
- Note creative directions to explore
**If Market Research provided:**
- Build on identified opportunities
- Deepen specific market insights
- Validate initial findings
- Explore adjacent possibilities
**If Starting Fresh:**
- Gather essential context through questions
- Define the problem space
- Clarify research objectives
- Establish success criteria
## Process
### 3. Research Prompt Structure
[[LLM: Based on the selected research type and context, collaboratively develop a comprehensive research prompt with these components.]]
#### A. Research Objectives
[[LLM: Work with the user to articulate clear, specific objectives for the research.]]
- Primary research goal and purpose
- Key decisions the research will inform
- Success criteria for the research
- Constraints and boundaries
#### B. Research Questions
[[LLM: Develop specific, actionable research questions organized by theme.]]
**Core Questions:**
- Central questions that must be answered
- Priority ranking of questions
- Dependencies between questions
**Supporting Questions:**
- Additional context-building questions
- Nice-to-have insights
- Future-looking considerations
#### C. Research Methodology
[[LLM: Specify appropriate research methods based on the type and objectives.]]
**Data Collection Methods:**
- Secondary research sources
- Primary research approaches (if applicable)
- Data quality requirements
- Source credibility criteria
**Analysis Frameworks:**
- Specific frameworks to apply
- Comparison criteria
- Evaluation methodologies
- Synthesis approaches
#### D. Output Requirements
[[LLM: Define how research findings should be structured and presented.]]
**Format Specifications:**
- Executive summary requirements
- Detailed findings structure
- Visual/tabular presentations
- Supporting documentation
**Key Deliverables:**
- Must-have sections and insights
- Decision-support elements
- Action-oriented recommendations
- Risk and uncertainty documentation
### 4. Prompt Generation
[[LLM: Synthesize all elements into a comprehensive, ready-to-use research prompt.]]
**Research Prompt Template:**
```markdown
## Research Objective
[Clear statement of what this research aims to achieve]
## Background Context
[Relevant information from project brief, brainstorming, or other inputs]
## Research Questions
### Primary Questions (Must Answer)
1. [Specific, actionable question]
2. [Specific, actionable question]
...
### Secondary Questions (Nice to Have)
1. [Supporting question]
2. [Supporting question]
...
## Research Methodology
### Information Sources
- [Specific source types and priorities]
### Analysis Frameworks
- [Specific frameworks to apply]
### Data Requirements
- [Quality, recency, credibility needs]
## Expected Deliverables
### Executive Summary
- Key findings and insights
- Critical implications
- Recommended actions
### Detailed Analysis
[Specific sections needed based on research type]
### Supporting Materials
- Data tables
- Comparison matrices
- Source documentation
## Success Criteria
[How to evaluate if research achieved its objectives]
## Timeline and Priority
[If applicable, any time constraints or phasing]
```
### 5. Review and Refinement
[[LLM: Present the draft research prompt for user review and refinement.]]
1. **Present Complete Prompt**
- Show the full research prompt
- Explain key elements and rationale
- Highlight any assumptions made
2. **Gather Feedback**
- Are the objectives clear and correct?
- Do the questions address all concerns?
- Is the scope appropriate?
- Are output requirements sufficient?
3. **Refine as Needed**
- Incorporate user feedback
- Adjust scope or focus
- Add missing elements
- Clarify ambiguities
### 6. Next Steps Guidance
[[LLM: Provide clear guidance on how to use the research prompt.]]
**Execution Options:**
1. **Use with AI Research Assistant**: Provide this prompt to an AI model with research capabilities
2. **Guide Human Research**: Use as a framework for manual research efforts
3. **Hybrid Approach**: Combine AI and human research using this structure
**Integration Points:**
- How findings will feed into next phases
- Which team members should review results
- How to validate findings
- When to revisit or expand research
## Important Notes
- The quality of the research prompt directly impacts the quality of insights gathered
- Be specific rather than general in research questions
- Consider both current state and future implications
- Balance comprehensiveness with focus
- Document assumptions and limitations clearly
- Plan for iterative refinement based on initial findings
==================== END: tasks#create-deep-research-prompt ====================
==================== START: templates#agent-tmpl ====================
# [AGENT_ID]
@@ -1343,12 +1742,13 @@ Embedded knowledge (automatic):
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:
```yml
````yml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- 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
- Command
agent:
name: [AGENT_NAME]
@@ -1369,7 +1769,9 @@ persona:
# Add more principles as needed
startup:
- [STARTUP_INSTRUCTIONS]
- Greet the user with your name and role, and inform of the *help command.
- [STARTUP_INSTRUCTION]
- [STARTUP_INSTRUCTION]...
commands:
- "*help" - Show: numbered list of the following commands to allow selection
@@ -1470,7 +1872,7 @@ dependencies:
- 'materials-guide.md # Construction materials specs'
utils:
- 'template-format # For template processing'
```
````
==================== END: templates#agent-tmpl ====================
==================== START: templates#expansion-pack-plan-tmpl ====================

File diff suppressed because it is too large Load Diff

View File

@@ -60,9 +60,9 @@ workflows:
==================== END: agent-teams#team-fullstack ====================
==================== START: agents#bmad-orchestrator ====================
# bmad
# bmad-orchestrator
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
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:
```yaml
agent:
@@ -94,9 +94,9 @@ startup:
- If clear match to an agent's expertise, suggest transformation with *agent command
- If project-oriented, suggest *workflow-guidance to explore options
- Load resources only when needed - never pre-load
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
commands:
help: Show this guide with available agents and workflows
chat-mode: Start conversational mode for detailed assistance
chat-mode: Start conversational mode for detailed assistance
kb-mode: Load full BMAD knowledge base
status: Show current context, active agent, and progress
agent: Transform into a specialized agent (list if name not specified)
@@ -111,41 +111,40 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
help-display-template: |
=== BMAD Orchestrator Commands ===
All commands must start with * (asterisk)
Core Commands:
*help ............... Show this guide
*chat-mode .......... Start conversational mode for detailed assistance
*kb-mode ............ Load full BMAD knowledge base
*status ............. Show current context, active agent, and progress
*exit ............... Return to BMad or exit session
Agent & Task Management:
*agent [name] ....... Transform into specialized agent (list if no name)
*task [name] ........ Run specific task (list if no name, requires agent)
*checklist [name] ... Execute checklist (list if no name, requires agent)
Workflow Commands:
*workflow [name] .... Start specific workflow (list if no name)
*workflow-guidance .. Get personalized help selecting the right workflow
Other Commands:
*yolo ............... Toggle skip confirmations mode
*party-mode ......... Group chat with all agents
*doc-out ............ Output full document
=== Available Specialist Agents ===
[Dynamically list each agent in bundle with format:
*agent {id}: {title}
When to use: {whenToUse}
Key deliverables: {main outputs/documents}]
=== Available Workflows ===
[Dynamically list each workflow in bundle with format:
*workflow {id}: {name}
Purpose: {description}]
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
fuzzy-matching:
- 85% confidence threshold
- Show numbered list if unsure
@@ -217,13 +216,13 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*brainstorm {topic}" - Facilitate structured brainstorming session'
- '*research {topic}" - Generate deep research prompt for investigation'
- '*elicit" - Run advanced elicitation to clarify requirements'
- '*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- brainstorm {topic}: Facilitate structured brainstorming session
- research {topic}: Generate deep research prompt for investigation
- elicit: Run advanced elicitation to clarify requirements
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
dependencies:
tasks:
- brainstorming-techniques
@@ -246,7 +245,7 @@ dependencies:
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:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -276,10 +275,10 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Deep conversation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*exit" - Say goodbye as the PM, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Deep conversation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- exit: Say goodbye as the PM, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc
@@ -343,13 +342,13 @@ startup:
- Greet the user with your name and role, and inform of the *help command.
- Always start by understanding the user's context, goals, and constraints before proposing solutions.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) UX consultation with advanced-elicitation for design decisions'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*generate-ui-prompt" - Create AI frontend generation prompt'
- '*research {topic}" - Generate deep research prompt for UX investigation'
- '*execute-checklist {checklist}" - Run design validation checklist'
- '*exit" - Say goodbye as the UX Expert, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) UX consultation with advanced-elicitation for design decisions
- create-doc {template}: Create doc (no template = show available templates)
- generate-ui-prompt: Create AI frontend generation prompt
- research {topic}: Generate deep research prompt for UX investigation
- execute-checklist {checklist}: Run design validation checklist
- exit: Say goodbye as the UX Expert, and then abandon inhabiting this persona
dependencies:
tasks:
- generate-ai-frontend-prompt
@@ -403,12 +402,12 @@ startup:
- Greet the user with your name and role, and inform of the *help command.
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run architectural validation checklist'
- '*research {topic}" - Generate deep research prompt for architectural decisions'
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Architect consultation with advanced-elicitation for complex system design
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run architectural validation checklist
- research {topic}: Generate deep research prompt for architectural decisions
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc
@@ -434,7 +433,7 @@ dependencies:
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:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -466,15 +465,15 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Product Owner consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run validation checklist (default->po-master-checklist)'
- '*shard-doc {document}" - Break down document into actionable parts'
- '*correct-course" - Analyze and suggest project course corrections'
- '*create-epic" - Create epic for brownfield projects (task brownfield-create-epic)'
- '*create-story" - Create user story from requirements (task brownfield-create-story)'
- '*exit" - Say Goodbye, You are no longer this Agent'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
- shard-doc {document}: Break down document into actionable parts
- correct-course: Analyze and suggest project course corrections
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-story: Create user story from requirements (task brownfield-create-story)
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
dependencies:
tasks:
- execute-checklist
@@ -679,6 +678,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
- **Reusable Resources**: Portable templates, tasks, and checklists
- **Slash Command Integration**: Quick agent switching and control
### When to Use BMAD
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
- **Team Collaboration**: Multiple roles working together
- **Quality Assurance**: Structured testing and validation
- **Documentation**: Professional PRDs, architecture docs, user stories
## Getting Started
### Quick Start Options
#### Option 1: Web UI
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
5. Type `/help` to see available commands
#### Option 2: IDE Integration
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
```bash
# Interactive installation (recommended)
npx bmad-method install
```
**Installation Steps**:
- Choose "Complete installation"
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
**Verify Installation**:
- `.bmad-core/` folder created with all agents
- IDE-specific integration files created
- All agent commands/rules/modes available
### Environment Selection Guide
**Use Web UI for**:
- Initial planning and documentation (PRD, architecture)
- Cost-effective document creation (especially with Gemini)
- Brainstorming and analysis phases
- Multi-agent consultation and planning
**Use IDE for**:
- Active development and coding
- File operations and project integration
- Document sharding and story management
- Implementation workflow (SM/Dev cycles)
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
## Core Philosophy
### Vibe CEO'ing
@@ -700,18 +753,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
## IDE Development Workflow
### Key Workflow Principles
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
5. Use a new chat window to allow the SM agent to `draft the next story`.
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
2. **Clean Handoffs**: Always start fresh when switching between agents
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
4. **Iterative Development**: Complete one story before starting the next
5. **Documentation First**: Always start with solid PRD and architecture
With this work flow, there is only 1 story in progress at a time, worked sequentially.
## Agent System
### Core Development Team
| Agent | Role | Primary Functions | When to Use |
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
| `dev` | Developer | Code implementation, debugging | All development tasks |
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
### Meta Agents
| Agent | Role | Primary Functions | When to Use |
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
### Agent Interaction Commands
#### IDE-Specific Syntax
**Agent Loading by IDE**:
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
**Chat Management Guidelines**:
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
- **Roo Code**: Switch modes within the same conversation
**Common Task Commands**:
- `*help` - Show available commands
- `*status` - Show current context/progress
- `*exit` - Exit the agent mode
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
- `*create` - Run create-next-story task (SM agent)
**In Web UI**:
```text
/pm create-doc prd
/architect review system design
/dev implement story 1.2
/help - Show available commands
/switch agent-name - Change active agent (if orchestrator available)
```
## Team Configurations
### Pre-Built Teams
#### Team All
- **Includes**: All 10 agents + orchestrator
- **Use Case**: Complete projects requiring all roles
- **Bundle**: `team-all.txt`
#### Team Fullstack
- **Includes**: PM, Architect, Developer, QA, UX Expert
- **Use Case**: End-to-end web/mobile development
- **Bundle**: `team-fullstack.txt`
#### Team No-UI
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
- **Use Case**: Backend services, APIs, system development
- **Bundle**: `team-no-ui.txt`
## Core Architecture
### System Overview
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).
### Key Architectural Components
#### 1. Agents (`bmad-core/agents/`)
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
- **Startup Instructions**: Can load project-specific documentation for immediate context
#### 2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Define collections of agents bundled together for specific purposes
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
- **Usage**: Creates pre-packaged contexts for web UI environments
#### 3. Workflows (`bmad-core/workflows/`)
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
#### 4. Reusable Resources
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
### Dual Environment Architecture
#### IDE Environment
- Users interact directly with agent markdown files
- Agents can access all dependencies dynamically
- Supports real-time file operations and project integration
- Optimized for development workflow execution
#### Web UI Environment
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
- Created by the web-builder tool for upload to web interfaces
- Provides complete context in one package
### Template Processing System
BMAD employs a sophisticated template system with three key components:
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
**Template Features**:
- **Self-contained**: Templates embed both output structure and processing instructions
- **Variable Substitution**: `{{placeholders}}` for dynamic content
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
### Technical Preferences Integration
The `technical-preferences.md` file serves as a persistent technical profile that:
- Ensures consistency across all agents and projects
- Eliminates repetitive technology specification
- Provides personalized recommendations aligned with user preferences
- Evolves over time with lessons learned
### Build and Delivery Process
The `web-builder.js` tool creates web-ready bundles by:
1. Reading agent or team definition files
2. Recursively resolving all dependencies
3. Concatenating content into single text files with clear separators
4. Outputting ready-to-upload bundles for web AI interfaces
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
## Complete Development Workflow
### Planning Phase (Web UI Recommended)
**Ideal for cost efficiency, especially with Gemini:**
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
2. **Project Brief**: Create foundation document (Analyst or user)
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
#### Example Planning Prompts
**For PRD Creation**:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
```
**For Architecture Design**:
```text
"Based on this PRD, design a scalable technical architecture
that can handle [specific requirements]."
```
### Critical Transition: Web UI to IDE
**Once planning is complete, you MUST switch to IDE for development:**
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
### IDE Development Workflow
**Prerequisites**: Planning documents must exist in `docs/` folder
1. **Document Sharding**:
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
- If architecture exists, shard to `docs/architecture/` folder
- Results in multiple manageable documents and epic files
2. **Verify Sharded Content**:
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
- Source tree document and coding standards for dev agent reference
- Sharded docs for SM agent story creation
**Resulting Folder Structure**:
- `docs/prd/` - Broken down PRD sections
- `docs/architecture/` - Broken down architecture sections
- `docs/stories/` - Generated user stories
3. **Development Cycle** (Sequential, one story at a time):
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
- SM executes create-next-story task
- Review generated story in `docs/stories/`
- Update status from "Draft" to "Approved"
**Step 2 - Story Implementation**: New chat window → `@dev`
- Agent asks which story to implement
- Include story file content to save dev agent lookup time
- Dev follows tasks/subtasks, marking completion
- Dev leaves notes for SM about any deviations
- Update status to "Done"
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
### Status Tracking Workflow
Stories progress through defined statuses:
- **Draft** → **Approved** → **InProgress** → **Done**
Each status change requires user verification and approval before proceeding.
### Workflow Types
#### Greenfield Development
- Business analysis and market research
- Product requirements and feature definition
- System architecture and design
- Development execution
- Testing and deployment
#### Brownfield Enhancement
- Current system analysis
- Enhancement planning
- Impact assessment
- Incremental development
- Integration testing
## Document Creation Best Practices
### Required File Naming for Framework Integration
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter**:
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
### Cost-Effective Document Creation Workflow
**Recommended for Large Documents (PRD, Architecture):**
1. **Use Web UI**: Create documents in web interface for cost efficiency
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
4. **Switch to IDE**: Use IDE agents for development and smaller documents
### Document Sharding
Templates with Level 2 headings (`##`) can be automatically sharded:
**Original PRD**:
```markdown
## Goals and Background Context
## Requirements
## User Interface Design Goals
## Success Metrics
```
**After Sharding**:
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
## Usage Patterns and Best Practices
### Environment-Specific Usage
**Web UI Best For**:
- Initial planning and documentation phases
- Cost-effective large document creation
- Agent consultation and brainstorming
- Multi-agent workflows with orchestrator
**IDE Best For**:
- Active development and implementation
- File operations and project integration
- Story management and development cycles
- Code review and debugging
### Quality Assurance
- Use appropriate agents for specialized tasks
- Follow Agile ceremonies and review processes
- Maintain document consistency with PO agent
- Regular validation with checklists and templates
### Performance Optimization
- Use specific agents vs. `bmad-master` for focused tasks
- Choose appropriate team size for project needs
- Leverage technical preferences for consistency
- Regular context management and cache clearing
## Success Tips
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
- **Use bmad-master for document organization** - Sharding creates manageable chunks
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Getting Help
- **Commands**: Use `/help` in any environment to see available commands
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
- **Documentation**: Check `docs/` folder for project-specific context
- **Community**: Discord and GitHub resources available for support
==================== END: data#bmad-kb ====================
==================== START: utils#workflow-management ====================
@@ -1517,6 +1897,8 @@ Present these numbered options to the user:
==================== START: templates#project-brief-tmpl ====================
# Project Brief: {{Project Name}}
[[LLM: The default path and filename unless specified is docs/brief.md]]
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
Start by asking the user which mode they prefer:
@@ -1748,6 +2130,8 @@ These replace the standard elicitation options when working on project brief doc
==================== START: templates#market-research-tmpl ====================
# Market Research Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/market-research.md]]
[[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
## Executive Summary
@@ -2012,6 +2396,8 @@ These replace the standard elicitation options when working on market research d
==================== START: templates#competitor-analysis-tmpl ====================
# Competitive Analysis Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
[[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
## Executive Summary
@@ -2969,6 +3355,8 @@ Document sharded successfully:
==================== START: templates#prd-tmpl ====================
# {{Project Name}} Product Requirements Document (PRD)
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
## Goals and Background Context
@@ -3172,6 +3560,8 @@ so that {{benefit}}.
==================== START: templates#brownfield-prd-tmpl ====================
# {{Project Name}} Brownfield Enhancement PRD
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
@@ -4038,6 +4428,8 @@ You will now synthesize the inputs and the above principles into a final, compre
==================== START: templates#front-end-spec-tmpl ====================
# {{Project Name}} UI/UX Specification
[[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
[[LLM: Review provided documents including Project Brief, PRD, and any user research to gather context. Focus on understanding user needs, pain points, and desired outcomes before beginning the specification.]]
## Introduction
@@ -4846,6 +5238,8 @@ Present a summary of what was created and ask if any additional documentation wo
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
[[LLM: The default path and filename unless specified is docs/architecture.md]]
## Introduction
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
@@ -5621,6 +6015,8 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
==================== START: templates#front-end-architecture-tmpl ====================
# {{Project Name}} Frontend Architecture Document
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
[[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
## Template and Framework Selection
@@ -5797,6 +6193,8 @@ Document the starter template decision and any constraints it imposes before pro
==================== START: templates#fullstack-architecture-tmpl ====================
# {{Project Name}} Fullstack Architecture Document
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.]]
## Introduction
@@ -6816,6 +7214,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
==================== START: templates#brownfield-architecture-tmpl ====================
# {{Project Name}} Brownfield Enhancement Architecture
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:

View File

@@ -52,9 +52,9 @@ workflows: null
==================== END: agent-teams#team-ide-minimal ====================
==================== START: agents#bmad-orchestrator ====================
# bmad
# bmad-orchestrator
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
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:
```yaml
agent:
@@ -86,9 +86,9 @@ startup:
- If clear match to an agent's expertise, suggest transformation with *agent command
- If project-oriented, suggest *workflow-guidance to explore options
- Load resources only when needed - never pre-load
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
commands:
help: Show this guide with available agents and workflows
chat-mode: Start conversational mode for detailed assistance
chat-mode: Start conversational mode for detailed assistance
kb-mode: Load full BMAD knowledge base
status: Show current context, active agent, and progress
agent: Transform into a specialized agent (list if name not specified)
@@ -103,41 +103,40 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
help-display-template: |
=== BMAD Orchestrator Commands ===
All commands must start with * (asterisk)
Core Commands:
*help ............... Show this guide
*chat-mode .......... Start conversational mode for detailed assistance
*kb-mode ............ Load full BMAD knowledge base
*status ............. Show current context, active agent, and progress
*exit ............... Return to BMad or exit session
Agent & Task Management:
*agent [name] ....... Transform into specialized agent (list if no name)
*task [name] ........ Run specific task (list if no name, requires agent)
*checklist [name] ... Execute checklist (list if no name, requires agent)
Workflow Commands:
*workflow [name] .... Start specific workflow (list if no name)
*workflow-guidance .. Get personalized help selecting the right workflow
Other Commands:
*yolo ............... Toggle skip confirmations mode
*party-mode ......... Group chat with all agents
*doc-out ............ Output full document
=== Available Specialist Agents ===
[Dynamically list each agent in bundle with format:
*agent {id}: {title}
When to use: {whenToUse}
Key deliverables: {main outputs/documents}]
=== Available Workflows ===
[Dynamically list each workflow in bundle with format:
*workflow {id}: {name}
Purpose: {description}]
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
fuzzy-matching:
- 85% confidence threshold
- Show numbered list if unsure
@@ -176,7 +175,7 @@ dependencies:
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:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -208,15 +207,15 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Product Owner consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run validation checklist (default->po-master-checklist)'
- '*shard-doc {document}" - Break down document into actionable parts'
- '*correct-course" - Analyze and suggest project course corrections'
- '*create-epic" - Create epic for brownfield projects (task brownfield-create-epic)'
- '*create-story" - Create user story from requirements (task brownfield-create-story)'
- '*exit" - Say Goodbye, You are no longer this Agent'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
- shard-doc {document}: Break down document into actionable parts
- correct-course: Analyze and suggest project course corrections
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-story: Create user story from requirements (task brownfield-create-story)
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
dependencies:
tasks:
- execute-checklist
@@ -242,7 +241,6 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- 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
agent:
@@ -258,31 +256,25 @@ persona:
identity: Story creation expert who prepares detailed, actionable stories for AI developers
focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
core_principles:
- Task Adherence - Rigorously follow create-next-story procedures
- Checklist-Driven Validation - Apply story-draft-checklist meticulously
- Clarity for Developer Handoff - Stories must be immediately actionable
- Focus on One Story at a Time - Complete one before starting next
- Numbered Options Protocol - Always use numbered lists for selections
- Rigorously follow `create-next-story` procedure to generate the detailed user story
- Will ensure all information comes from the PRD and Architecture to guide the dumb dev agent
- You are NOT allowed to implement stories or modify code EVER!
startup:
- Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT automatically execute create-next-story tasks during startup
- CRITICAL: Do NOT create or modify any files during startup
- Greet the user with your name and role, and inform of the *help command and then HALT to await instruction if not given already.
- Offer to help with story preparation but wait for explicit user confirmation
- Only execute tasks when user explicitly requests them
- 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent'
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - Conversational mode with advanced-elicitation for advice'
- '*create" - Execute all steps in Create Next Story Task document'
- '*pivot" - Run correct-course task (ensure no story already created first)'
- '*checklist {checklist}" - Show numbered list of checklists, execute selection'
- '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
- '*index-docs" - Update documentation index in /docs/index.md'
- '*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: Conversational mode with advanced-elicitation for advice
- create|draft: Execute create-next-story
- pivot: Execute `correct-course` task
- checklist {checklist}: Show numbered list of checklists, execute selection
- exit: Say goodbye as the Scrum Master, and then abandon inhabiting this persona
dependencies:
tasks:
- create-next-story
- execute-checklist
- course-correct
templates:
- story-tmpl
checklists:
@@ -297,66 +289,58 @@ dependencies:
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:
```yml
```yaml
agent:
name: James
id: dev
title: Full Stack Developer
icon: 💻
whenToUse: "Use for code implementation, debugging, refactoring, and development best practices"
customization:
whenToUse: Use for code implementation, debugging, refactoring, and development best practices
customization: null
persona:
role: Expert Senior Software Engineer & Implementation Specialist
style: Extremely concise, pragmatic, detail-oriented, solution-focused
identity: Expert who implements stories by reading requirements and executing tasks sequentially with comprehensive testing
focus: Executing story tasks with precision, updating Dev Agent Record sections only, maintaining minimal context overhead
core_principles:
- CRITICAL: Story-Centric - Story has ALL info. NEVER load PRD/architecture/other docs files unless explicitly directed in dev notes
- CRITICAL: Load Standards - MUST load docs/architecture/coding-standards.md into core memory at startup
- CRITICAL: Config-Based Loading - MUST load .bmad-core/core-config.yml at startup, then load ONLY files listed in devLoadAlwaysFiles. Inform user of missing files but continue
- CRITICAL: Dev Record Only - ONLY update Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
- Sequential Execution - Complete tasks 1-by-1 in order. Mark [x] before next. No skipping
- Test-Driven Quality - Write tests alongside code. Task incomplete without passing tests
- Debug Log Discipline - Log temp changes to table. Revert after fix. Keep story lean
- Block Only When Critical - HALT for: missing approval/ambiguous reqs/3 failures/missing config
- Code Excellence - Clean, secure, maintainable code per coding-standards.md
- Code Excellence - Clean, secure, maintainable code per loaded standards
- Numbered Options - Always use numbered lists when presenting choices
startup:
- Announce: Greet the user with your name and role, and inform of the *help command.
- CRITICAL: Do NOT load any story files or coding-standards.md during startup
- CRITICAL: Load .bmad-core/core-config.yml and read devLoadAlwaysFiles list
- CRITICAL: Load ONLY files specified in devLoadAlwaysFiles. If any missing, inform user but continue
- CRITICAL: Do NOT load any story files during startup unless user requested you do
- CRITICAL: Do NOT scan docs/stories/ directory automatically
- CRITICAL: Do NOT begin any tasks automatically
- Wait for user to specify story or ask for story selection
- Only load files and begin work when explicitly requested by user
- Only load story files and begin work when explicitly requested by user
commands:
- "*help" - Show commands
- "*chat-mode" - Conversational mode
- "*run-tests" - Execute linting+tests
- "*lint" - Run linting only
- "*dod-check" - Run story-dod-checklist
- "*status" - Show task progress
- "*debug-log" - Show debug entries
- "*complete-story" - Finalize to "Review"
- "*exit" - Leave developer mode
- help: Show numbered list of the following commands to allow selection
- chat-mode: Conversational mode for development discussions
- run-tests: Execute linting and tests
- lint: Run linting only
- dod-check: Run story-dod-checklist
- status: Show task progress
- debug-log: Show debug entries
- complete-story: Finalize to "Review"
- exit: Say goodbye as the Developer, and then abandon inhabiting this persona
task-execution:
flow: "Read task→Implement→Write tests→Pass tests→Update [x]→Next task"
flow: Read task→Implement→Write tests→Pass tests→Update [x]→Next task
updates-ONLY:
- "Checkboxes: [ ] not started | [-] in progress | [x] complete"
- "Debug Log: | Task | File | Change | Reverted? |"
- "Completion Notes: Deviations only, <50 words"
- "Change Log: Requirement changes only"
blocking: "Unapproved deps | Ambiguous after story check | 3 failures | Missing config"
done: "Code matches reqs + Tests pass + Follows standards + No lint errors"
completion: "All [x]→Lint→Tests(100%)→Integration(if noted)→Coverage(80%+)→E2E(if noted)→DoD→Summary→HALT"
- 'Checkboxes: [ ] not started | [-] in progress | [x] complete'
- 'Debug Log: | Task | File | Change | Reverted? |'
- 'Completion Notes: Deviations only, <50 words'
- 'Change Log: Requirement changes only'
blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing config
done: Code matches reqs + Tests pass + Follows standards + No lint errors
completion: All [x]→Lint→Tests(100%)→Integration(if noted)→Coverage(80%+)→E2E(if noted)→DoD→Summary→HALT
dependencies:
tasks:
- execute-checklist
@@ -402,10 +386,10 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) QA consultation with advanced-elicitation for test strategy'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*exit" - Say goodbye as the QA Test Architect, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) QA consultation with advanced-elicitation for test strategy
- create-doc {template}: Create doc (no template = show available templates)
- exit: Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
dependencies:
data:
- technical-preferences
@@ -601,6 +585,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
- **Reusable Resources**: Portable templates, tasks, and checklists
- **Slash Command Integration**: Quick agent switching and control
### When to Use BMAD
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
- **Team Collaboration**: Multiple roles working together
- **Quality Assurance**: Structured testing and validation
- **Documentation**: Professional PRDs, architecture docs, user stories
## Getting Started
### Quick Start Options
#### Option 1: Web UI
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
5. Type `/help` to see available commands
#### Option 2: IDE Integration
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
```bash
# Interactive installation (recommended)
npx bmad-method install
```
**Installation Steps**:
- Choose "Complete installation"
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
**Verify Installation**:
- `.bmad-core/` folder created with all agents
- IDE-specific integration files created
- All agent commands/rules/modes available
### Environment Selection Guide
**Use Web UI for**:
- Initial planning and documentation (PRD, architecture)
- Cost-effective document creation (especially with Gemini)
- Brainstorming and analysis phases
- Multi-agent consultation and planning
**Use IDE for**:
- Active development and coding
- File operations and project integration
- Document sharding and story management
- Implementation workflow (SM/Dev cycles)
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
## Core Philosophy
### Vibe CEO'ing
@@ -622,18 +660,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
## IDE Development Workflow
### Key Workflow Principles
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
5. Use a new chat window to allow the SM agent to `draft the next story`.
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
2. **Clean Handoffs**: Always start fresh when switching between agents
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
4. **Iterative Development**: Complete one story before starting the next
5. **Documentation First**: Always start with solid PRD and architecture
With this work flow, there is only 1 story in progress at a time, worked sequentially.
## Agent System
### Core Development Team
| Agent | Role | Primary Functions | When to Use |
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
| `dev` | Developer | Code implementation, debugging | All development tasks |
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
### Meta Agents
| Agent | Role | Primary Functions | When to Use |
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
### Agent Interaction Commands
#### IDE-Specific Syntax
**Agent Loading by IDE**:
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
**Chat Management Guidelines**:
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
- **Roo Code**: Switch modes within the same conversation
**Common Task Commands**:
- `*help` - Show available commands
- `*status` - Show current context/progress
- `*exit` - Exit the agent mode
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
- `*create` - Run create-next-story task (SM agent)
**In Web UI**:
```text
/pm create-doc prd
/architect review system design
/dev implement story 1.2
/help - Show available commands
/switch agent-name - Change active agent (if orchestrator available)
```
## Team Configurations
### Pre-Built Teams
#### Team All
- **Includes**: All 10 agents + orchestrator
- **Use Case**: Complete projects requiring all roles
- **Bundle**: `team-all.txt`
#### Team Fullstack
- **Includes**: PM, Architect, Developer, QA, UX Expert
- **Use Case**: End-to-end web/mobile development
- **Bundle**: `team-fullstack.txt`
#### Team No-UI
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
- **Use Case**: Backend services, APIs, system development
- **Bundle**: `team-no-ui.txt`
## Core Architecture
### System Overview
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).
### Key Architectural Components
#### 1. Agents (`bmad-core/agents/`)
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
- **Startup Instructions**: Can load project-specific documentation for immediate context
#### 2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Define collections of agents bundled together for specific purposes
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
- **Usage**: Creates pre-packaged contexts for web UI environments
#### 3. Workflows (`bmad-core/workflows/`)
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
#### 4. Reusable Resources
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
### Dual Environment Architecture
#### IDE Environment
- Users interact directly with agent markdown files
- Agents can access all dependencies dynamically
- Supports real-time file operations and project integration
- Optimized for development workflow execution
#### Web UI Environment
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
- Created by the web-builder tool for upload to web interfaces
- Provides complete context in one package
### Template Processing System
BMAD employs a sophisticated template system with three key components:
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
**Template Features**:
- **Self-contained**: Templates embed both output structure and processing instructions
- **Variable Substitution**: `{{placeholders}}` for dynamic content
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
### Technical Preferences Integration
The `technical-preferences.md` file serves as a persistent technical profile that:
- Ensures consistency across all agents and projects
- Eliminates repetitive technology specification
- Provides personalized recommendations aligned with user preferences
- Evolves over time with lessons learned
### Build and Delivery Process
The `web-builder.js` tool creates web-ready bundles by:
1. Reading agent or team definition files
2. Recursively resolving all dependencies
3. Concatenating content into single text files with clear separators
4. Outputting ready-to-upload bundles for web AI interfaces
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
## Complete Development Workflow
### Planning Phase (Web UI Recommended)
**Ideal for cost efficiency, especially with Gemini:**
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
2. **Project Brief**: Create foundation document (Analyst or user)
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
#### Example Planning Prompts
**For PRD Creation**:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
```
**For Architecture Design**:
```text
"Based on this PRD, design a scalable technical architecture
that can handle [specific requirements]."
```
### Critical Transition: Web UI to IDE
**Once planning is complete, you MUST switch to IDE for development:**
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
### IDE Development Workflow
**Prerequisites**: Planning documents must exist in `docs/` folder
1. **Document Sharding**:
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
- If architecture exists, shard to `docs/architecture/` folder
- Results in multiple manageable documents and epic files
2. **Verify Sharded Content**:
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
- Source tree document and coding standards for dev agent reference
- Sharded docs for SM agent story creation
**Resulting Folder Structure**:
- `docs/prd/` - Broken down PRD sections
- `docs/architecture/` - Broken down architecture sections
- `docs/stories/` - Generated user stories
3. **Development Cycle** (Sequential, one story at a time):
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
- SM executes create-next-story task
- Review generated story in `docs/stories/`
- Update status from "Draft" to "Approved"
**Step 2 - Story Implementation**: New chat window → `@dev`
- Agent asks which story to implement
- Include story file content to save dev agent lookup time
- Dev follows tasks/subtasks, marking completion
- Dev leaves notes for SM about any deviations
- Update status to "Done"
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
### Status Tracking Workflow
Stories progress through defined statuses:
- **Draft** → **Approved** → **InProgress** → **Done**
Each status change requires user verification and approval before proceeding.
### Workflow Types
#### Greenfield Development
- Business analysis and market research
- Product requirements and feature definition
- System architecture and design
- Development execution
- Testing and deployment
#### Brownfield Enhancement
- Current system analysis
- Enhancement planning
- Impact assessment
- Incremental development
- Integration testing
## Document Creation Best Practices
### Required File Naming for Framework Integration
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter**:
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
### Cost-Effective Document Creation Workflow
**Recommended for Large Documents (PRD, Architecture):**
1. **Use Web UI**: Create documents in web interface for cost efficiency
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
4. **Switch to IDE**: Use IDE agents for development and smaller documents
### Document Sharding
Templates with Level 2 headings (`##`) can be automatically sharded:
**Original PRD**:
```markdown
## Goals and Background Context
## Requirements
## User Interface Design Goals
## Success Metrics
```
**After Sharding**:
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
## Usage Patterns and Best Practices
### Environment-Specific Usage
**Web UI Best For**:
- Initial planning and documentation phases
- Cost-effective large document creation
- Agent consultation and brainstorming
- Multi-agent workflows with orchestrator
**IDE Best For**:
- Active development and implementation
- File operations and project integration
- Story management and development cycles
- Code review and debugging
### Quality Assurance
- Use appropriate agents for specialized tasks
- Follow Agile ceremonies and review processes
- Maintain document consistency with PO agent
- Regular validation with checklists and templates
### Performance Optimization
- Use specific agents vs. `bmad-master` for focused tasks
- Choose appropriate team size for project needs
- Leverage technical preferences for consistency
- Regular context management and cache clearing
## Success Tips
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
- **Use bmad-master for document organization** - Sharding creates manageable chunks
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Getting Help
- **Commands**: Use `/help` in any environment to see available commands
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
- **Documentation**: Check `docs/` folder for project-specific context
- **Community**: Discord and GitHub resources available for support
==================== END: data#bmad-kb ====================
==================== START: utils#workflow-management ====================
@@ -2256,45 +2621,42 @@ Keep it action-oriented and forward-looking.]]
To identify the next logical story based on project progress and epic definitions, and then to prepare a comprehensive, self-contained, and actionable story file using the `Story Template`. This task ensures the story is enriched with all necessary technical context, requirements, and acceptance criteria, making it ready for efficient implementation by a Developer Agent with minimal need for additional research.
## Inputs for this Task
- Access to the project's documentation repository, specifically:
- `docs/index.md` (hereafter "Index Doc")
- All Epic files - located in one of these locations:
- Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Secondary: `docs/epics/epic-{n}-{description}.md`
- User-specified location if not found in above paths
- Existing story files in `docs/stories/`
- Main PRD (hereafter "PRD Doc")
- Main Architecture Document (hereafter "Main Arch Doc")
- Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
- Project Structure Guide (`docs/project-structure.md`)
- Operational Guidelines Document (`docs/operational-guidelines.md`)
- Technology Stack Document (`docs/tech-stack.md`)
- Data Models Document (as referenced in Index Doc)
- API Reference Document (as referenced in Index Doc)
- UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
- The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
- The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
- User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
## Task Execution Instructions
### 0. Load Core Configuration
[[LLM: CRITICAL - This MUST be your first step]]
- Load `.bmad-core/core-config.yml` from the project root
- If the file does not exist:
- HALT and inform the user: "core-config.yml not found. This file is required for story creation. You can:
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yml and configure it for your project
2. Run the BMAD installer against your project to upgrade and add the file automatically
Please add and configure core-config.yml before proceeding."
- Extract the following key configurations:
- `dev-story-location`: Where to save story files
- `prd.prdSharded`: Whether PRD is sharded or monolithic
- `prd.prd-file`: Location of monolithic PRD (if not sharded)
- `prd.prdShardedLocation`: Location of sharded epic files
- `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
- `architecture.architectureVersion`: Architecture document version
- `architecture.architectureSharded`: Whether architecture is sharded
- `architecture.architecture-file`: Location of monolithic architecture
- `architecture.architectureShardedLocation`: Location of sharded architecture files
### 1. Identify Next Story for Preparation
#### 1.1 Locate Epic Files
- First, determine where epic files are located:
- Check `docs/prd/` for files matching pattern `epic-{n}-*.md`
- If not found, check `docs/epics/` for files matching pattern `epic-{n}-*.md`
- If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
- Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
- Based on `prdSharded` from config:
- **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
- **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
#### 1.2 Review Existing Stories
- Review `docs/stories/` to find the highest-numbered story file.
- Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
- If the directory exists and has at least 1 file, find the highest-numbered story file.
- **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
- Verify its `Status` is 'Done' (or equivalent).
- If not 'Done', present an alert to the user:
@@ -2312,17 +2674,17 @@ To identify the next logical story based on project progress and epic definition
```
- Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}-*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}-*.md`, then `epic-{lastEpicNum + 2}-*.md`, etc.) whose prerequisites are met.
- If proceeding: Look for the Epic File for `{lastEpicNum}` (e.g., `epic-{lastEpicNum}*.md`) and check for a story numbered `{lastStoryNum + 1}`. If it exists and its prerequisites (per Epic File) are met, this is the next story.
- Else (story not found or prerequisites not met): The next story is the first story in the next Epic File (e.g., look for `epic-{lastEpicNum + 1}*.md`, then `epic-{lastEpicNum + 2}*.md`, etc.) whose prerequisites are met.
- **If no story files exist in `docs/stories/`:**
- The next story is the first story in the first epic file (look for `epic-1-*.md`, then `epic-2-*.md`, etc.) whose prerequisites are met.
- If no suitable story with met prerequisites is found, report to the user that story creation is blocked, specifying what prerequisites are pending. HALT task.
- Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
### 2. Gather Core Story Requirements (from Epic File)
### 2. Gather Core Story Requirements (from Epic)
- For the identified story, open its parent Epic File (e.g., `epic-{epicNum}-*.md` from the location identified in step 1.1).
- For the identified story, review its parent Epic (e.g., `epic-{epicNum}*.md` from the location identified in step 1.1).
- Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
- Keep a record of this original epic-defined scope for later deviation analysis.
@@ -2331,7 +2693,7 @@ To identify the next logical story based on project progress and epic definition
[[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
- If this is not the first story (i.e., previous story exists):
- Read the previous story file: `docs/stories/{prevEpicNum}.{prevStoryNum}.story.md`
- Read the previous sequential story from `docs/stories`
- Pay special attention to:
- Dev Agent Record sections (especially Completion Notes and Debug Log References)
- Any deviations from planned implementation
@@ -2340,18 +2702,30 @@ To identify the next logical story based on project progress and epic definition
- Any "lessons learned" or notes for future stories
- Extract relevant insights that might inform the current story's preparation
### 4. Gather & Synthesize Architecture Context from Sharded Docs
### 4. Gather & Synthesize Architecture Context
[[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
[[LLM: CRITICAL - You MUST gather technical details from the architecture documents. NEVER make up technical details not found in these documents.]]
#### 4.1 Start with Architecture Index
#### 4.1 Determine Architecture Document Strategy
- Read `docs/architecture/index.md` to understand the full scope of available documentation
- Identify which sharded documents are most relevant to the current story
Based on configuration loaded in Step 0:
#### 4.2 Recommended Reading Order Based on Story Type
- **If `architectureVersion: v4` and `architectureSharded: true`**:
- Read `{architectureShardedLocation}/index.md` to understand available documentation
- Follow the structured reading order in section 4.2 below
- **If `architectureVersion: v4` and `architectureSharded: false`**:
- Load the monolithic architecture from `architecture-file`
- Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
- **If `architectureVersion` is NOT v4**:
- Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
- If `architectureSharded: true`: Search sharded files by filename relevance
- If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
[[LLM: Read documents in this order, but ALWAYS verify relevance to the specific story. Skip irrelevant sections but NEVER skip documents that contain information needed for the story.]]
#### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
[[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
**For ALL Stories:**
@@ -2360,9 +2734,18 @@ To identify the next logical story based on project progress and epic definition
3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
**For Backend/API Stories, additionally read:** 5. `docs/architecture/data-models.md` - Data structures and validation rules 6. `docs/architecture/database-schema.md` - Database design and relationships 7. `docs/architecture/backend-architecture.md` - Service patterns and structure 8. `docs/architecture/rest-api-spec.md` - API endpoint specifications 9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Backend/API Stories, additionally read:**
5. `docs/architecture/data-models.md` - Data structures and validation rules
6. `docs/architecture/database-schema.md` - Database design and relationships
7. `docs/architecture/backend-architecture.md` - Service patterns and structure
8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
**For Frontend/UI Stories, additionally read:** 5. `docs/architecture/frontend-architecture.md` - Component structure and patterns 6. `docs/architecture/components.md` - Specific component designs 7. `docs/architecture/core-workflows.md` - User interaction flows 8. `docs/architecture/data-models.md` - Frontend data handling
**For Frontend/UI Stories, additionally read:**
5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
6. `docs/architecture/components.md` - Specific component designs
7. `docs/architecture/core-workflows.md` - User interaction flows
8. `docs/architecture/data-models.md` - Frontend data handling
**For Full-Stack Stories:**
@@ -2395,7 +2778,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
### 6. Populate Story Template with Full Context
- Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
- Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
- Use the Story Template to structure the file.
- Fill in:
- Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
@@ -2442,7 +2825,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
- Verify all source references are included for technical details
- Ensure tasks align with both epic requirements and architecture constraints
- Update status to "Draft"
- Save the story file to `docs/stories/{epicNum}.{storyNum}.story.md`
- Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
### 9. Report Completion

View File

@@ -55,9 +55,9 @@ workflows:
==================== END: agent-teams#team-no-ui ====================
==================== START: agents#bmad-orchestrator ====================
# bmad
# bmad-orchestrator
CRITICAL: Read the full YML to understand your operating params, start activation to alter your state of being, follow startup instructions, stay in this being until told to exit this mode:
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:
```yaml
agent:
@@ -89,9 +89,9 @@ startup:
- If clear match to an agent's expertise, suggest transformation with *agent command
- If project-oriented, suggest *workflow-guidance to explore options
- Load resources only when needed - never pre-load
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
commands:
help: Show this guide with available agents and workflows
chat-mode: Start conversational mode for detailed assistance
chat-mode: Start conversational mode for detailed assistance
kb-mode: Load full BMAD knowledge base
status: Show current context, active agent, and progress
agent: Transform into a specialized agent (list if name not specified)
@@ -106,41 +106,40 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
help-display-template: |
=== BMAD Orchestrator Commands ===
All commands must start with * (asterisk)
Core Commands:
*help ............... Show this guide
*chat-mode .......... Start conversational mode for detailed assistance
*kb-mode ............ Load full BMAD knowledge base
*status ............. Show current context, active agent, and progress
*exit ............... Return to BMad or exit session
Agent & Task Management:
*agent [name] ....... Transform into specialized agent (list if no name)
*task [name] ........ Run specific task (list if no name, requires agent)
*checklist [name] ... Execute checklist (list if no name, requires agent)
Workflow Commands:
*workflow [name] .... Start specific workflow (list if no name)
*workflow-guidance .. Get personalized help selecting the right workflow
Other Commands:
*yolo ............... Toggle skip confirmations mode
*party-mode ......... Group chat with all agents
*doc-out ............ Output full document
=== Available Specialist Agents ===
[Dynamically list each agent in bundle with format:
*agent {id}: {title}
When to use: {whenToUse}
Key deliverables: {main outputs/documents}]
=== Available Workflows ===
[Dynamically list each workflow in bundle with format:
*workflow {id}: {name}
Purpose: {description}]
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
💡 Tip: Each agent has unique tasks, templates, and checklists. Switch to an agent to access their capabilities!
fuzzy-matching:
- 85% confidence threshold
- Show numbered list if unsure
@@ -212,13 +211,13 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*brainstorm {topic}" - Facilitate structured brainstorming session'
- '*research {topic}" - Generate deep research prompt for investigation'
- '*elicit" - Run advanced elicitation to clarify requirements'
- '*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Strategic analysis consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- brainstorm {topic}: Facilitate structured brainstorming session
- research {topic}: Generate deep research prompt for investigation
- elicit: Run advanced elicitation to clarify requirements
- exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
dependencies:
tasks:
- brainstorming-techniques
@@ -241,7 +240,7 @@ dependencies:
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:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -271,10 +270,10 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Deep conversation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*exit" - Say goodbye as the PM, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Deep conversation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- exit: Say goodbye as the PM, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc
@@ -335,12 +334,12 @@ startup:
- Greet the user with your name and role, and inform of the *help command.
- When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Architect consultation with advanced-elicitation for complex system design'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run architectural validation checklist'
- '*research {topic}" - Generate deep research prompt for architectural decisions'
- '*exit" - Say goodbye as the Architect, and then abandon inhabiting this persona'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Architect consultation with advanced-elicitation for complex system design
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run architectural validation checklist
- research {topic}: Generate deep research prompt for architectural decisions
- exit: Say goodbye as the Architect, and then abandon inhabiting this persona
dependencies:
tasks:
- create-doc
@@ -366,7 +365,7 @@ dependencies:
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:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
@@ -398,15 +397,15 @@ persona:
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Product Owner consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*execute-checklist {checklist}" - Run validation checklist (default->po-master-checklist)'
- '*shard-doc {document}" - Break down document into actionable parts'
- '*correct-course" - Analyze and suggest project course corrections'
- '*create-epic" - Create epic for brownfield projects (task brownfield-create-epic)'
- '*create-story" - Create user story from requirements (task brownfield-create-story)'
- '*exit" - Say Goodbye, You are no longer this Agent'
- help: Show numbered list of the following commands to allow selection
- chat-mode: (Default) Product Owner consultation with advanced-elicitation
- create-doc {template}: Create doc (no template = show available templates)
- execute-checklist {checklist}: Run validation checklist (default->po-master-checklist)
- shard-doc {document}: Break down document into actionable parts
- correct-course: Analyze and suggest project course corrections
- create-epic: Create epic for brownfield projects (task brownfield-create-epic)
- create-story: Create user story from requirements (task brownfield-create-story)
- exit: Say goodbye as the Product Owner, and then abandon inhabiting this persona
dependencies:
tasks:
- execute-checklist
@@ -611,6 +610,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
- **Reusable Resources**: Portable templates, tasks, and checklists
- **Slash Command Integration**: Quick agent switching and control
### When to Use BMAD
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
- **Team Collaboration**: Multiple roles working together
- **Quality Assurance**: Structured testing and validation
- **Documentation**: Professional PRDs, architecture docs, user stories
## Getting Started
### Quick Start Options
#### Option 1: Web UI
**Best for**: ChatGPT, Claude, Gemini users who want to start immediately
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
5. Type `/help` to see available commands
#### Option 2: IDE Integration
**Best for**: Cursor, Claude Code, Windsurf, VS Code users
```bash
# Interactive installation (recommended)
npx bmad-method install
```
**Installation Steps**:
- Choose "Complete installation"
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
**Verify Installation**:
- `.bmad-core/` folder created with all agents
- IDE-specific integration files created
- All agent commands/rules/modes available
### Environment Selection Guide
**Use Web UI for**:
- Initial planning and documentation (PRD, architecture)
- Cost-effective document creation (especially with Gemini)
- Brainstorming and analysis phases
- Multi-agent consultation and planning
**Use IDE for**:
- Active development and coding
- File operations and project integration
- Document sharding and story management
- Implementation workflow (SM/Dev cycles)
**Cost-Saving Tip**: Create large documents (PRDs, architecture) in web UI, then copy to `docs/prd.md` and `docs/architecture.md` in your project before switching to IDE for development.
## Core Philosophy
### Vibe CEO'ing
@@ -632,18 +685,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
## IDE Development Workflow
### Key Workflow Principles
1. Shard the PRD (And Architecture documents if they exist also based on workflow type) using the Doc Shard task. The BMad-Master agent can help you do this. You will select the task, provide the doc to shard and the output folder. for example: `BMad Master, please Shard the docs/prd.md to the doc/prd/ folder` - this should ask you to use the md-tree-parser which is recommended, but either way shoudl result in multiple documents being created in the folder docs/prd.
2. If you have fullstack, front end and or back end architecture documents you will want to follow the same thing, but shard all of these to an architecture folder instead of a prd folder.
3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
4. The docs or architecture folder or prd folder should have a source tree document and coding standards at a minimum. These are used by the dev agent, and the many other sharded docs are used by the SM agent.
5. Use a new chat window to allow the SM agent to `draft the next story`.
6. If you agree the story is correct, mark it as approved in the status field, and then start a new chat window with the dev agent.
7. Ask the dev agent to implement the next story. If you draft the story file into the chat it will save time for the dev to have to find what the next one is. The dev should follow the tasks and subtasks marking them off as they are completed. The dev agent will also leave notes potentially for the SM to know about any deviations that might have occured to help draft the next story.
8. Once complete and you have verified, mark it done, and start a new chat. Ask the SM to draft the next story - repeating the cycle.
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
2. **Clean Handoffs**: Always start fresh when switching between agents
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
4. **Iterative Development**: Complete one story before starting the next
5. **Documentation First**: Always start with solid PRD and architecture
With this work flow, there is only 1 story in progress at a time, worked sequentially.
## Agent System
### Core Development Team
| Agent | Role | Primary Functions | When to Use |
| ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
| `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
| `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
| `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
| `dev` | Developer | Code implementation, debugging | All development tasks |
| `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
| `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
| `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
| `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
### Meta Agents
| Agent | Role | Primary Functions | When to Use |
| ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
| `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
### Agent Interaction Commands
#### IDE-Specific Syntax
**Agent Loading by IDE**:
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
**Chat Management Guidelines**:
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
- **Roo Code**: Switch modes within the same conversation
**Common Task Commands**:
- `*help` - Show available commands
- `*status` - Show current context/progress
- `*exit` - Exit the agent mode
- `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
- `*shard-doc docs/architecture.md architecture` - Shard architecture document
- `*create` - Run create-next-story task (SM agent)
**In Web UI**:
```text
/pm create-doc prd
/architect review system design
/dev implement story 1.2
/help - Show available commands
/switch agent-name - Change active agent (if orchestrator available)
```
## Team Configurations
### Pre-Built Teams
#### Team All
- **Includes**: All 10 agents + orchestrator
- **Use Case**: Complete projects requiring all roles
- **Bundle**: `team-all.txt`
#### Team Fullstack
- **Includes**: PM, Architect, Developer, QA, UX Expert
- **Use Case**: End-to-end web/mobile development
- **Bundle**: `team-fullstack.txt`
#### Team No-UI
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
- **Use Case**: Backend services, APIs, system development
- **Bundle**: `team-no-ui.txt`
## Core Architecture
### System Overview
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).
### Key Architectural Components
#### 1. Agents (`bmad-core/agents/`)
- **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
- **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
- **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
- **Startup Instructions**: Can load project-specific documentation for immediate context
#### 2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Define collections of agents bundled together for specific purposes
- **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
- **Usage**: Creates pre-packaged contexts for web UI environments
#### 3. Workflows (`bmad-core/workflows/`)
- **Purpose**: YAML files defining prescribed sequences of steps for specific project types
- **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
- **Structure**: Defines agent interactions, artifacts created, and transition conditions
#### 4. Reusable Resources
- **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
- **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
- **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
- **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
### Dual Environment Architecture
#### IDE Environment
- Users interact directly with agent markdown files
- Agents can access all dependencies dynamically
- Supports real-time file operations and project integration
- Optimized for development workflow execution
#### Web UI Environment
- Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
- Single text files containing all agent dependencies are in `dist/agents/` - these are unnecessary unless you want to create a web agent that is only a single agent and not a team
- Created by the web-builder tool for upload to web interfaces
- Provides complete context in one package
### Template Processing System
BMAD employs a sophisticated template system with three key components:
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
**Template Features**:
- **Self-contained**: Templates embed both output structure and processing instructions
- **Variable Substitution**: `{{placeholders}}` for dynamic content
- **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
- **Interactive Refinement**: Built-in elicitation processes for quality improvement
### Technical Preferences Integration
The `technical-preferences.md` file serves as a persistent technical profile that:
- Ensures consistency across all agents and projects
- Eliminates repetitive technology specification
- Provides personalized recommendations aligned with user preferences
- Evolves over time with lessons learned
### Build and Delivery Process
The `web-builder.js` tool creates web-ready bundles by:
1. Reading agent or team definition files
2. Recursively resolving all dependencies
3. Concatenating content into single text files with clear separators
4. Outputting ready-to-upload bundles for web AI interfaces
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
## Complete Development Workflow
### Planning Phase (Web UI Recommended)
**Ideal for cost efficiency, especially with Gemini:**
1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
2. **Project Brief**: Create foundation document (Analyst or user)
3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
#### Example Planning Prompts
**For PRD Creation**:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
```
**For Architecture Design**:
```text
"Based on this PRD, design a scalable technical architecture
that can handle [specific requirements]."
```
### Critical Transition: Web UI to IDE
**Once planning is complete, you MUST switch to IDE for development:**
- **Why**: Development workflow requires file operations, real-time project integration, and document sharding
- **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
- **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
### IDE Development Workflow
**Prerequisites**: Planning documents must exist in `docs/` folder
1. **Document Sharding**:
- `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
- If architecture exists, shard to `docs/architecture/` folder
- Results in multiple manageable documents and epic files
2. **Verify Sharded Content**:
- At least one `epic-n.md` file in `docs/prd/` with stories in development order
- Source tree document and coding standards for dev agent reference
- Sharded docs for SM agent story creation
**Resulting Folder Structure**:
- `docs/prd/` - Broken down PRD sections
- `docs/architecture/` - Broken down architecture sections
- `docs/stories/` - Generated user stories
3. **Development Cycle** (Sequential, one story at a time):
**Step 1 - Story Creation**: New chat window → `@sm` → `*create`
- SM executes create-next-story task
- Review generated story in `docs/stories/`
- Update status from "Draft" to "Approved"
**Step 2 - Story Implementation**: New chat window → `@dev`
- Agent asks which story to implement
- Include story file content to save dev agent lookup time
- Dev follows tasks/subtasks, marking completion
- Dev leaves notes for SM about any deviations
- Update status to "Done"
**Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
**Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
### Status Tracking Workflow
Stories progress through defined statuses:
- **Draft** → **Approved** → **InProgress** → **Done**
Each status change requires user verification and approval before proceeding.
### Workflow Types
#### Greenfield Development
- Business analysis and market research
- Product requirements and feature definition
- System architecture and design
- Development execution
- Testing and deployment
#### Brownfield Enhancement
- Current system analysis
- Enhancement planning
- Impact assessment
- Incremental development
- Integration testing
## Document Creation Best Practices
### Required File Naming for Framework Integration
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter**:
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
### Cost-Effective Document Creation Workflow
**Recommended for Large Documents (PRD, Architecture):**
1. **Use Web UI**: Create documents in web interface for cost efficiency
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
4. **Switch to IDE**: Use IDE agents for development and smaller documents
### Document Sharding
Templates with Level 2 headings (`##`) can be automatically sharded:
**Original PRD**:
```markdown
## Goals and Background Context
## Requirements
## User Interface Design Goals
## Success Metrics
```
**After Sharding**:
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
## Usage Patterns and Best Practices
### Environment-Specific Usage
**Web UI Best For**:
- Initial planning and documentation phases
- Cost-effective large document creation
- Agent consultation and brainstorming
- Multi-agent workflows with orchestrator
**IDE Best For**:
- Active development and implementation
- File operations and project integration
- Story management and development cycles
- Code review and debugging
### Quality Assurance
- Use appropriate agents for specialized tasks
- Follow Agile ceremonies and review processes
- Maintain document consistency with PO agent
- Regular validation with checklists and templates
### Performance Optimization
- Use specific agents vs. `bmad-master` for focused tasks
- Choose appropriate team size for project needs
- Leverage technical preferences for consistency
- Regular context management and cache clearing
## Success Tips
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
- **Use bmad-master for document organization** - Sharding creates manageable chunks
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Getting Help
- **Commands**: Use `/help` in any environment to see available commands
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
- **Documentation**: Check `docs/` folder for project-specific context
- **Community**: Discord and GitHub resources available for support
==================== END: data#bmad-kb ====================
==================== START: utils#workflow-management ====================
@@ -1449,6 +1829,8 @@ Present these numbered options to the user:
==================== START: templates#project-brief-tmpl ====================
# Project Brief: {{Project Name}}
[[LLM: The default path and filename unless specified is docs/brief.md]]
[[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
Start by asking the user which mode they prefer:
@@ -1680,6 +2062,8 @@ These replace the standard elicitation options when working on project brief doc
==================== START: templates#market-research-tmpl ====================
# Market Research Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/market-research.md]]
[[LLM: This template guides the creation of a comprehensive market research report. Begin by understanding what market insights the user needs and why. Work through each section systematically, using the appropriate analytical frameworks based on the research objectives.]]
## Executive Summary
@@ -1944,6 +2328,8 @@ These replace the standard elicitation options when working on market research d
==================== START: templates#competitor-analysis-tmpl ====================
# Competitive Analysis Report: {{Project/Product Name}}
[[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
[[LLM: This template guides comprehensive competitor analysis. Start by understanding the user's competitive intelligence needs and strategic objectives. Help them identify and prioritize competitors before diving into detailed analysis.]]
## Executive Summary
@@ -2901,6 +3287,8 @@ Document sharded successfully:
==================== START: templates#prd-tmpl ====================
# {{Project Name}} Product Requirements Document (PRD)
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
## Goals and Background Context
@@ -3104,6 +3492,8 @@ so that {{benefit}}.
==================== START: templates#brownfield-prd-tmpl ====================
# {{Project Name}} Brownfield Enhancement PRD
[[LLM: The default path and filename unless specified is docs/prd.md]]
[[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
@@ -4310,6 +4700,8 @@ Present a summary of what was created and ask if any additional documentation wo
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot local `docs/prd.md` ask the user what docs will provide the basis for the architecture.]]
[[LLM: The default path and filename unless specified is docs/architecture.md]]
## Introduction
[[LLM: This section establishes the document's purpose and scope. Keep the content below but ensure project name is properly substituted.
@@ -5085,6 +5477,8 @@ Note: Basic info goes in Coding Standards for dev agent. This detailed section i
==================== START: templates#front-end-architecture-tmpl ====================
# {{Project Name}} Frontend Architecture Document
[[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
[[LLM: Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.]]
## Template and Framework Selection
@@ -5261,6 +5655,8 @@ Document the starter template decision and any constraints it imposes before pro
==================== START: templates#fullstack-architecture-tmpl ====================
# {{Project Name}} Fullstack Architecture Document
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.]]
## Introduction
@@ -6280,6 +6676,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
==================== START: templates#brownfield-architecture-tmpl ====================
# {{Project Name}} Brownfield Enhancement Architecture
[[LLM: The default path and filename unless specified is docs/architecture.md]]
[[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
This architecture document is for SIGNIFICANT enhancements to existing projects that require comprehensive architectural planning. Before proceeding:

View File

@@ -33,11 +33,13 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
Use Google's Gemini for collaborative planning with the full team:
1. **Open [Google AI Studio](https://aistudio.google.com/)**
2. **Load team-fullstack**:
- Copy contents of: `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
- Paste into new Gemini chat
3. **Collaborate with the team**:
1. **Open [Google Gems](https://gemini.google.com/gems/view)**
2. **Create a new Gem**:
- Give it a title and description (e.g., "BMAD Team Fullstack")
3. **Load team-fullstack**:
- Copy contents of: `dist/teams/team-fullstack.txt` from your project
- Paste this content into the Gem setup to configure the team
4. **Collaborate with the team**:
- Business Analyst: Requirements gathering
- Product Manager: Feature prioritization
- Solution Architect: Technical design
@@ -53,9 +55,9 @@ Help me brainstorm features and create a comprehensive PRD."
that can handle [specific requirements]."
```
4. **Export planning documents**:
- Save PRD as `docs/prd.md`
- Save architecture as `docs/architecture.md`
5. **Export planning documents**:
- Copy the PRD output and save as `docs/prd.md` in your project
- Copy the architecture output and save as `docs/architecture.md` in your project
### Phase 3: Document Organization (IDE)

View File

@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
1. Open [Google gems](https://gemini.google.com/gems/view)
2. Create a new Gem - give it a title and description
3. Copy the contents of `.<install location>/web-bundles/teams/team-fullstack.txt`
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
4. Paste this content into Gemini to set up the team
### Gemini Planning Phase

View File

@@ -16,7 +16,7 @@ The system facilitates a full development lifecycle:
The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
```mermaid
````mermaid
graph TD
subgraph BMAD Method Project
subgraph Core Framework
@@ -35,7 +35,7 @@ graph TD
end
subgraph Outputs
J[".bmad-core/web-bundles"]
J["dist"]
end
B -- defines dependencies for --> E
@@ -133,17 +133,17 @@ The framework is designed for two primary environments: local IDEs and web-based
### 4.1. Web Builder (`tools/builders/web-builder.js`)
- **Purpose**: This Node.js script is responsible for creating the `.txt` bundles found in `.bmad-core/web-bundles/`.
- **Purpose**: This Node.js script is responsible for creating the `.txt` bundles found in `dist`.
- **Process**:
1. **Resolves Dependencies**: For a given agent or team, the script reads its definition file.
2. It recursively finds all dependent resources (tasks, templates, etc.) that the agent/team needs.
3. **Bundles Content**: It reads the content of all these files and concatenates them into a single, large text file, with clear separators indicating the original file path of each section.
4. **Outputs Bundle**: The final `.txt` file is saved in the `web-bundles` directory, ready to be uploaded to a web UI.
4. **Outputs Bundle**: The final `.txt` file is saved in the `dist` directory, ready to be uploaded to a web UI.
### 4.2. Environment-Specific Usage
- **For IDEs**: Users interact with the agents directly via their markdown files in `.bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
- **For Web UIs**: Users upload a pre-built bundle from `.bmad-core/web-bundles/`. This single file provides the AI with the context of the entire team and all their required tools and knowledge.
- **For Web UIs**: Users upload a pre-built bundle from `dist`. This single file provides the AI with the context of the entire team and all their required tools and knowledge.
## 5. BMAD Workflows
@@ -168,12 +168,12 @@ graph TD
I --> L["📁 Switch to IDE"]
L --> M["PO: Shard Documents"]
M --> N["Ready for SM/Dev Cycle"]
style I fill:#34a853,color:#fff
style G fill:#f9ab00,color:#fff
style L fill:#1a73e8,color:#fff
style N fill:#34a853,color:#fff
```
````
**Key Planning Phases:**

View File

@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
1. Open [Google gems](https://gemini.google.com/gems/view)
2. Create a new Gem - give it a title and description
3. Copy the contents of `.<install location>/web-bundles/teams/team-fullstack.txt`
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
4. Paste this content into Gemini to set up the team
### Gemini Planning Phase

View File

@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
1. Open [Google gems](https://gemini.google.com/gems/view)
2. Create a new Gem - give it a title and description
3. Copy the contents of `.<install location>/web-bundles/teams/team-fullstack.txt`
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
4. Paste this content into Gemini to set up the team
### Gemini Planning Phase

View File

@@ -46,7 +46,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent
Best for: ChatGPT, Claude, Gemini users
1. Navigate to `.bmad-core/web-bundles/teams/`
1. Navigate to `dist/teams/`
2. Copy `team-fullstack.txt` content
3. Create new Gemini Gem or CustomGPT
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
@@ -56,12 +56,9 @@ Best for: ChatGPT, Claude, Gemini users
Best for: Cursor, Claude Code, Windsurf, VS Code users
```bash
````bash
# Interactive installation (recommended)
npx bmad-method install
# Command line installation
npx bmad-method install --full --directory ./my-project --ide cursor
```text
### First Steps
@@ -109,7 +106,7 @@ dependencies:
- shard-doc.md
data:
- bmad-kb.md
```
````
**Key Points:**
@@ -121,7 +118,7 @@ dependencies:
**In IDE:**
```bash
````bash
# Cursor or Windsurf (manual rules - loaded with @)
@pm Create a PRD for a task management app
@architect Design the system architecture
@@ -138,7 +135,7 @@ dependencies:
/pm create-doc prd
/architect review system design
/dev implement story 1.2
```
````
## Templates and Document Creation
@@ -178,7 +175,7 @@ Templates follow the `template-format.md` specification:
- **Template**: `architecture-template.md`
- **Agent**: Architect
- **Use Case**: System design, technical planning
- **Use Case**: System design, technical planning
- **Command**: `/architect create-doc architecture`
- **💡 Cost-Saving Tip**: For Gemini users, create architecture docs in the web UI to avoid high IDE token costs. Copy the final markdown output to `docs/architecture.md` in your project.
@@ -203,10 +200,12 @@ For cost efficiency, especially with Gemini:
#### File Naming Conventions
**Required Names for Framework Integration:**
- `docs/prd.md` - Product Requirements Document
- `docs/architecture.md` - System Architecture Document
**Why These Names Matter:**
- Agents automatically reference these files during development
- Sharding tasks expect these specific filenames
- Workflow automation depends on standard naming
@@ -214,6 +213,7 @@ For cost efficiency, especially with Gemini:
#### IDE Document Creation
When working directly in IDEs:
- Agents should create documents in `docs/` folder automatically
- If agents name files differently (e.g., `product-requirements.md`), rename to `prd.md`
- Verify document location matches `docs/prd.md` and `docs/architecture.md`
@@ -224,9 +224,10 @@ When working directly in IDEs:
Templates can include `advanced-elicitation.md` for enhanced interaction:
```markdown
`````markdown
[[LLM: Use advanced-elicitation actions 0-3 to refine requirements]]
```text
````text
This provides 10 structured brainstorming actions:
@@ -262,12 +263,15 @@ graph TD
I --> L["📁 Switch to IDE"]
L --> M["PO: Shard Documents"]
M --> N["Ready for SM/Dev Cycle"]
style I fill:#34a853,color:#fff
style G fill:#f9ab00,color:#fff
style L fill:#1a73e8,color:#fff
style N fill:#34a853,color:#fff
```
````
`````
`````
#### Web UI to IDE Transition
@@ -282,7 +286,7 @@ graph TD
Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
```mermaid
````mermaid
graph TD
A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
B --> C["PO: Shard Arch"]
@@ -387,7 +391,7 @@ agents:
- qa
workflows:
- greenfield-fullstack
```
`````
## IDE Integration
@@ -487,11 +491,13 @@ workflows:
Web UI agents focus on planning and documentation. Here's how to interact with each:
#### Agent Switching and Conversation
- **Switch Agents**: Use `/pm`, `/architect`, `/analyst`, `/po` to switch between roles
- **Agent Consultation**: Each agent offers their specialized options and capabilities
- **Natural Conversation**: Agents guide you through their processes with questions and suggestions
#### Planning Phase Agents
- **Analyst**: `/analyst` - Brainstorming, market research, competitive analysis
- **PM**: `/pm` - Product requirements, feature definition, roadmaps
- **Architect**: `/architect` - System design, technical architecture
@@ -511,12 +517,13 @@ Web UI agents focus on planning and documentation. Here's how to interact with e
1. **Use Web UI for PRD and Architecture**: These are token-heavy documents, especially in Gemini
2. **Copy Final Output**: Save complete markdown to your project
3. **Standard File Names**:
3. **Standard File Names**:
- Save PRD as `docs/prd.md`
- Save Architecture as `docs/architecture.md`
4. **IDE for Development**: Switch to IDE agents for implementation tasks
**Why This Saves Money:**
- Web UI pricing is typically more cost-effective for large context windows
- PRD and architecture creation involves extensive back-and-forth refinement
- IDE token costs can accumulate quickly with large document generation
@@ -536,7 +543,7 @@ BMAD's dependency system ensures agents only load necessary resources:
Create custom templates following `template-format.md`:
```markdown
`````markdown
---
title: Custom Template
description: Your custom document type
@@ -557,7 +564,8 @@ dependencies:
## Section 2
{{section_2_content}}
```text
````text
### Workflow Customization
@@ -586,7 +594,10 @@ phases:
deliverables:
- implementation
- tests
```
````
`````
`````
### Creating Custom Templates
@@ -594,7 +605,7 @@ Templates are self-contained documents that embed both output structure and proc
#### Template Structure
```markdown
````markdown
# {{Project Name}} Document Title
[[LLM: Opening instruction for AI processing]]
@@ -611,10 +622,13 @@ Templates are self-contained documents that embed both output structure and proc
@{example: Example content for AI guidance}
^^CONDITION: condition_name^^
## Conditional Section
[[LLM: Only include if condition is met]]
^^/CONDITION^^
```text
````text
#### Key Template Patterns
@@ -634,23 +648,30 @@ Templates are self-contained documents that embed both output structure and proc
## User Interface Section
[[LLM: Only include for UI projects]]
^^/CONDITION^^
```
`````
`````
#### Document Sharding
Level 2 headings (`##`) in templates can be automatically sharded into separate documents:
**Original PRD:**
```markdown
````markdown
## Goals and Background Context
## Requirements
## Requirements
## User Interface Design Goals
## Success Metrics
```text
````text
**After Sharding:**
- `docs/prd/goals-and-background-context.md`
- `docs/prd/requirements.md`
- `docs/prd/requirements.md`
- `docs/prd/user-interface-design-goals.md`
- `docs/prd/success-metrics.md`
@@ -676,32 +697,40 @@ Tasks are reusable automation instructions that agents can execute. They follow
- Detailed instructions for the agent
- Specific behaviors and outputs expected
### 2. Step Two
### 2. Step Two
- Additional processing steps
- Integration with other resources
## Examples
@{example: Concrete usage examples}
```
`````
`````
#### Task Patterns
**Resource Integration:**
```markdown
````markdown
[[LLM: Check if docs/coding-standards.md exists and reference it]]
[[LLM: Load docs/openapi-spec.yaml for API context]]
```text
````text
**Advanced Elicitation:**
```markdown
[[LLM: Apply tasks#advanced-elicitation protocol after completion]]
```
`````
`````
**Conditional Logic:**
```markdown
````markdown
[[LLM: If project has UI components, also check frontend standards]]
```text
````text
### Creating Custom Agents
@@ -735,13 +764,15 @@ dependencies:
- custom-task.md
data:
- domain-knowledge.md
```
`````
`````
#### Agent Startup Instructions
Agents can load project-specific documents and provide custom context:
```yaml
````yaml
startup:
- Load docs/coding-standards.md if available
- Review docs/project-structure.md for context
@@ -764,10 +795,10 @@ Agents can reference and load documents from the `docs/` folder:
```markdown
[[LLM: Before beginning, check for and load relevant context:
- docs/coding-standards.md for development standards
- docs/brand-guidelines.md for design consistency
- docs/brand-guidelines.md for design consistency
- docs/third-party-apis/ for integration requirements
- Any project-specific documentation in docs/ folder]]
```
`````
### Technical Preferences System
@@ -780,23 +811,28 @@ This file allows you to define your preferred technologies, patterns, and standa
#### What to Include
**Technology Stack Preferences:**
```markdown
`````markdown
## Preferred Technologies
### Frontend
- React with TypeScript
- Tailwind CSS for styling
- Next.js for full-stack applications
### Backend
### Backend
- Node.js with Express
- PostgreSQL for relational data
- Redis for caching
### Deployment
- Vercel for frontend
- Railway for backend services
```text
````text
**Design Patterns & Standards:**
```markdown
@@ -810,20 +846,27 @@ This file allows you to define your preferred technologies, patterns, and standa
- Microservices for complex applications
- RESTful APIs with OpenAPI documentation
- Event-driven architecture for real-time features
```
````
`````
`````
**External Services & APIs:**
```markdown
````markdown
## Preferred External Services
- Auth0 for authentication
- Stripe for payments
- SendGrid for email
- Cloudinary for image processing
## APIs to Avoid
- Legacy SOAP services
- Services without proper documentation
```text
````text
#### How Agents Use This File
@@ -847,7 +890,9 @@ This file allows you to define your preferred technologies, patterns, and standa
- Want to try Framework A on next appropriate project
- Interested in Pattern B for microservices
- Consider Service C for better performance
```
`````
````
#### Using with Web Bundles
@@ -1005,3 +1050,4 @@ Remember: BMAD is designed to enhance your development process, not replace your
---
For additional support, join our [Discord community](https://discord.gg/g6ypHytrCB) or check out the [YouTube channel](https://www.youtube.com/@BMadCode) for video tutorials and walkthroughs.
````

View File

@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
1. Open [Google gems](https://gemini.google.com/gems/view)
2. Create a new Gem - give it a title and description
3. Copy the contents of `.<install location>/web-bundles/teams/team-fullstack.txt`
3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
4. Paste this content into Gemini to set up the team
### Gemini Planning Phase

View File

@@ -3,6 +3,7 @@ bundle:
icon: 🎮
description: Game Development team specialized in 2D games using Phaser 3 and TypeScript.
agents:
- analyst
- bmad-orchestrator
- game-designer
- game-developer

View File

@@ -39,11 +39,13 @@ You are developing games as a "Player Experience CEO" - thinking like a game dir
### Phase 1: Game Concept and Design
1. **Game Designer**: Start with brainstorming and concept development
- Use *brainstorm to explore game concepts and mechanics
- Use \*brainstorm to explore game concepts and mechanics
- Create Game Brief using game-brief-tmpl
- Develop core game pillars and player experience goals
2. **Game Designer**: Create comprehensive Game Design Document
- Use game-design-doc-tmpl to create detailed GDD
- Define all game mechanics, progression, and balance
- Specify technical requirements and platform targets
@@ -63,11 +65,13 @@ You are developing games as a "Player Experience CEO" - thinking like a game dir
### Phase 3: Story-Driven Development
5. **Game Scrum Master**: Break down design into development stories
- Use create-game-story task to create detailed implementation stories
- Each story should be immediately actionable by game developers
- Apply game-story-dod-checklist to ensure story quality
6. **Game Developer**: Implement game features story by story
- Follow TypeScript strict mode and Phaser 3 best practices
- Maintain 60 FPS performance target throughout development
- Use test-driven development for game logic components
@@ -82,6 +86,7 @@ You are developing games as a "Player Experience CEO" - thinking like a game dir
### Phaser 3 + TypeScript Standards
**Project Structure:**
```text
game-project/
├── src/
@@ -99,12 +104,14 @@ game-project/
```
**Performance Requirements:**
- Maintain 60 FPS on target devices
- Memory usage under specified limits per level
- Loading times under 3 seconds for levels
- Smooth animation and responsive controls
**Code Quality:**
- TypeScript strict mode compliance
- Component-based architecture
- Object pooling for frequently created/destroyed objects
@@ -113,6 +120,7 @@ game-project/
### Game Development Story Structure
**Story Requirements:**
- Clear reference to Game Design Document section
- Specific acceptance criteria for game functionality
- Technical implementation details for Phaser 3
@@ -120,6 +128,7 @@ game-project/
- Testing requirements including gameplay validation
**Story Categories:**
- **Core Mechanics**: Fundamental gameplay systems
- **Level Content**: Individual levels and content implementation
- **UI/UX**: User interface and player experience features
@@ -129,6 +138,7 @@ game-project/
### Quality Assurance for Games
**Testing Approach:**
- Unit tests for game logic (separate from Phaser)
- Integration tests for game systems
- Performance benchmarking and profiling
@@ -136,6 +146,7 @@ game-project/
- Cross-platform compatibility testing
**Performance Monitoring:**
- Frame rate consistency tracking
- Memory usage monitoring
- Asset loading performance
@@ -145,16 +156,19 @@ game-project/
## Game Development Team Roles
### Game Designer (Alex)
- **Primary Focus**: Game mechanics, player experience, design documentation
- **Key Outputs**: Game Brief, Game Design Document, Level Design Framework
- **Specialties**: Brainstorming, game balance, player psychology, creative direction
### Game Developer (Maya)
- **Primary Focus**: Phaser 3 implementation, technical excellence, performance
- **Key Outputs**: Working game features, optimized code, technical architecture
- **Specialties**: TypeScript/Phaser 3, performance optimization, cross-platform development
### Game Scrum Master (Jordan)
- **Primary Focus**: Story creation, development planning, agile process
- **Key Outputs**: Detailed implementation stories, sprint planning, quality assurance
- **Specialties**: Story breakdown, developer handoffs, process optimization
@@ -162,18 +176,21 @@ game-project/
## Platform-Specific Considerations
### Web Platform
- Browser compatibility across modern browsers
- Progressive loading for large assets
- Touch-friendly mobile controls
- Responsive design for different screen sizes
### Mobile Optimization
- Touch gesture support and responsive controls
- Battery usage optimization
- Performance scaling for different device capabilities
- App store compliance and packaging
### Performance Targets
- **Desktop**: 60 FPS at 1080p resolution
- **Mobile**: 60 FPS on mid-range devices, 30 FPS minimum on low-end
- **Loading**: Initial load under 5 seconds, level transitions under 2 seconds
@@ -182,18 +199,21 @@ game-project/
## Success Metrics for Game Development
### Technical Metrics
- Frame rate consistency (>90% of time at target FPS)
- Memory usage within budgets
- Loading time targets met
- Zero critical bugs in core gameplay systems
### Player Experience Metrics
- Tutorial completion rate >80%
- Level completion rates appropriate for difficulty curve
- Average session length meets design targets
- Player retention and engagement metrics
### Development Process Metrics
- Story completion within estimated timeframes
- Code quality metrics (test coverage, linting compliance)
- Documentation completeness and accuracy
@@ -202,6 +222,7 @@ game-project/
## Common Game Development Patterns
### Scene Management
- Boot scene for initial setup and configuration
- Preload scene for asset loading with progress feedback
- Menu scene for navigation and settings
@@ -209,22 +230,25 @@ game-project/
- Clean transitions between scenes with proper cleanup
### Game State Management
- Persistent data (player progress, unlocks, settings)
- Session data (current level, score, temporary state)
- Save/load system with error recovery
- Settings management with platform storage
### Input Handling
- Cross-platform input abstraction
- Touch gesture support for mobile
- Keyboard and gamepad support for desktop
- Customizable control schemes
### Performance Optimization
- Object pooling for bullets, effects, enemies
- Texture atlasing and sprite optimization
- Audio compression and streaming
- Culling and level-of-detail systems
- Memory management and garbage collection optimization
This knowledge base provides the foundation for effective game development using the BMAD-METHOD framework with specialized focus on 2D game creation using Phaser 3 and TypeScript.
This knowledge base provides the foundation for effective game development using the BMAD-METHOD framework with specialized focus on 2D game creation using Phaser 3 and TypeScript.

View File

@@ -0,0 +1,3 @@
# Usage Information
TODO

View File

@@ -10,12 +10,13 @@
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:
```yml
````yml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- 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
- Command
agent:
name: [AGENT_NAME]
@@ -36,7 +37,9 @@ persona:
# Add more principles as needed
startup:
- [STARTUP_INSTRUCTIONS]
- Greet the user with your name and role, and inform of the *help command.
- [STARTUP_INSTRUCTION]
- [STARTUP_INSTRUCTION]...
commands:
- "*help" - Show: numbered list of the following commands to allow selection
@@ -137,4 +140,4 @@ dependencies:
- 'materials-guide.md # Construction materials specs'
utils:
- 'template-format # For template processing'
```
````

10
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "bmad-method",
"version": "4.6.0",
"version": "4.8.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "bmad-method",
"version": "4.6.0",
"version": "4.8.0",
"license": "MIT",
"dependencies": {
"@kayvan/markdown-tree-parser": "^1.5.0",
@@ -443,9 +443,9 @@
}
},
"node_modules/@kayvan/markdown-tree-parser": {
"version": "1.5.1",
"resolved": "https://registry.npmjs.org/@kayvan/markdown-tree-parser/-/markdown-tree-parser-1.5.1.tgz",
"integrity": "sha512-Npd6OIKwZ+0eOPxKOA/yd3BZ8k/tGgz24wJVMXUDODzhRm6LswXoWl0/rg4ZB3DOYsTO4yHwc6gIySCxd9B6Rw==",
"version": "1.6.0",
"resolved": "https://registry.npmjs.org/@kayvan/markdown-tree-parser/-/markdown-tree-parser-1.6.0.tgz",
"integrity": "sha512-d/6L71xHwjNGA+rt2rhGFKpxP/WTxO6egiGkNdoqIuGEgHYNUXJKDpnmDBMfESSHLXqgPargaPxmR74U8JxxXQ==",
"license": "MIT",
"dependencies": {
"remark-parse": "^11.0.0",

View File

@@ -1,6 +1,6 @@
{
"name": "bmad-method",
"version": "4.6.0",
"version": "4.8.0",
"description": "Breakthrough Method of Agile AI-driven Development",
"main": "tools/cli.js",
"bin": {

View File

@@ -1,15 +1,23 @@
const fs = require('node:fs').promises;
const path = require('node:path');
const DependencyResolver = require('../lib/dependency-resolver');
const fs = require("node:fs").promises;
const path = require("node:path");
const DependencyResolver = require("../lib/dependency-resolver");
class WebBuilder {
constructor(options = {}) {
this.rootDir = options.rootDir || process.cwd();
this.outputDirs = options.outputDirs || [
path.join(this.rootDir, 'dist')
];
this.outputDirs = options.outputDirs || [path.join(this.rootDir, "dist")];
this.resolver = new DependencyResolver(this.rootDir);
this.templatePath = path.join(this.rootDir, 'bmad-core', 'templates', 'web-agent-startup-instructions-template.md');
this.templatePath = path.join(
this.rootDir,
"bmad-core",
"utils",
"web-agent-startup-instructions.md"
);
}
parseYaml(content) {
const yaml = require("js-yaml");
return yaml.load(content);
}
async cleanOutputDirs() {
@@ -33,10 +41,10 @@ class WebBuilder {
// Write to all output directories
for (const outputDir of this.outputDirs) {
const outputPath = path.join(outputDir, 'agents');
const outputPath = path.join(outputDir, "agents");
await fs.mkdir(outputPath, { recursive: true });
const outputFile = path.join(outputPath, `${agentId}.txt`);
await fs.writeFile(outputFile, bundle, 'utf8');
await fs.writeFile(outputFile, bundle, "utf8");
}
}
@@ -52,10 +60,10 @@ class WebBuilder {
// Write to all output directories
for (const outputDir of this.outputDirs) {
const outputPath = path.join(outputDir, 'teams');
const outputPath = path.join(outputDir, "teams");
await fs.mkdir(outputPath, { recursive: true });
const outputFile = path.join(outputPath, `${teamId}.txt`);
await fs.writeFile(outputFile, bundle, 'utf8');
await fs.writeFile(outputFile, bundle, "utf8");
}
}
@@ -64,7 +72,7 @@ class WebBuilder {
async buildAgentBundle(agentId) {
const dependencies = await this.resolver.resolveAgentDependencies(agentId);
const template = await fs.readFile(this.templatePath, 'utf8');
const template = await fs.readFile(this.templatePath, "utf8");
const sections = [template];
@@ -76,12 +84,12 @@ class WebBuilder {
sections.push(this.formatSection(resource.path, resource.content));
}
return sections.join('\n');
return sections.join("\n");
}
async buildTeamBundle(teamId) {
const dependencies = await this.resolver.resolveTeamDependencies(teamId);
const template = await fs.readFile(this.templatePath, 'utf8');
const template = await fs.readFile(this.templatePath, "utf8");
const sections = [template];
@@ -98,21 +106,72 @@ class WebBuilder {
sections.push(this.formatSection(resource.path, resource.content));
}
return sections.join('\n');
return sections.join("\n");
}
processAgentContent(content) {
// First, replace content before YAML with the template
const yamlMatch = content.match(/```ya?ml\n([\s\S]*?)\n```/);
if (!yamlMatch) return content;
const yamlContent = yamlMatch[1];
const yamlStartIndex = content.indexOf(yamlMatch[0]);
const yamlEndIndex = yamlStartIndex + yamlMatch[0].length;
// Parse YAML and remove root and IDE-FILE-RESOLUTION properties
try {
const yaml = require("js-yaml");
const parsed = yaml.load(yamlContent);
// Remove the properties if they exist at root level
delete parsed.root;
delete parsed['IDE-FILE-RESOLUTION'];
delete parsed['REQUEST-RESOLUTION'];
// Also remove from activation-instructions if they exist
if (parsed['activation-instructions'] && Array.isArray(parsed['activation-instructions'])) {
parsed['activation-instructions'] = parsed['activation-instructions'].filter(instruction => {
return !instruction.startsWith('IDE-FILE-RESOLUTION:') &&
!instruction.startsWith('REQUEST-RESOLUTION:');
});
}
// Reconstruct the YAML
const cleanedYaml = yaml.dump(parsed, { lineWidth: -1 });
// Get the agent name from the YAML for the header
const agentName = parsed.agent?.id || 'agent';
// Build the new content with just the agent header and YAML
const newHeader = `# ${agentName}\n\nCRITICAL: 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:\n\n`;
const afterYaml = content.substring(yamlEndIndex);
return newHeader + "```yaml\n" + cleanedYaml.trim() + "\n```" + afterYaml;
} catch (error) {
console.warn("Failed to process agent YAML:", error.message);
// If parsing fails, return original content
return content;
}
}
formatSection(path, content) {
const separator = '====================';
const separator = "====================";
// Process agent content if this is an agent file
if (path.startsWith("agents#")) {
content = this.processAgentContent(content);
}
return [
`${separator} START: ${path} ${separator}`,
content.trim(),
`${separator} END: ${path} ${separator}`,
''
].join('\n');
"",
].join("\n");
}
async validate() {
console.log('Validating agent configurations...');
console.log("Validating agent configurations...");
const agents = await this.resolver.listAgents();
for (const agentId of agents) {
try {
@@ -124,7 +183,7 @@ class WebBuilder {
}
}
console.log('\nValidating team configurations...');
console.log("\nValidating team configurations...");
const teams = await this.resolver.listTeams();
for (const teamId of teams) {
try {
@@ -149,10 +208,8 @@ class WebBuilder {
}
async buildExpansionPack(packName, options = {}) {
const packDir = path.join(this.rootDir, 'expansion-packs', packName);
const outputDirs = [
path.join(this.rootDir, 'dist', 'expansion-packs', packName)
];
const packDir = path.join(this.rootDir, "expansion-packs", packName);
const outputDirs = [path.join(this.rootDir, "dist", "expansion-packs", packName)];
// Clean output directories if requested
if (options.clean !== false) {
@@ -166,27 +223,27 @@ class WebBuilder {
}
// Build individual agents first
const agentsDir = path.join(packDir, 'agents');
const agentsDir = path.join(packDir, "agents");
try {
const agentFiles = await fs.readdir(agentsDir);
const agentMarkdownFiles = agentFiles.filter(f => f.endsWith('.md'));
const agentMarkdownFiles = agentFiles.filter((f) => f.endsWith(".md"));
if (agentMarkdownFiles.length > 0) {
console.log(` Building individual agents for ${packName}:`);
for (const agentFile of agentMarkdownFiles) {
const agentName = agentFile.replace('.md', '');
const agentName = agentFile.replace(".md", "");
console.log(` - ${agentName}`);
// Build individual agent bundle
const bundle = await this.buildExpansionAgentBundle(packName, packDir, agentName);
// Write to all output directories
for (const outputDir of outputDirs) {
const agentsOutputDir = path.join(outputDir, 'agents');
const agentsOutputDir = path.join(outputDir, "agents");
await fs.mkdir(agentsOutputDir, { recursive: true });
const outputFile = path.join(agentsOutputDir, `${agentName}.txt`);
await fs.writeFile(outputFile, bundle, 'utf8');
await fs.writeFile(outputFile, bundle, "utf8");
}
}
}
@@ -195,24 +252,24 @@ class WebBuilder {
}
// Build team bundle
const agentTeamsDir = path.join(packDir, 'agent-teams');
const agentTeamsDir = path.join(packDir, "agent-teams");
try {
const teamFiles = await fs.readdir(agentTeamsDir);
const teamFile = teamFiles.find(f => f.endsWith('.yml'));
const teamFile = teamFiles.find((f) => f.endsWith(".yml"));
if (teamFile) {
console.log(` Building team bundle for ${packName}`);
const teamConfigPath = path.join(agentTeamsDir, teamFile);
// Build expansion pack as a team bundle
const bundle = await this.buildExpansionTeamBundle(packName, packDir, teamConfigPath);
// Write to all output directories
for (const outputDir of outputDirs) {
const teamsOutputDir = path.join(outputDir, 'teams');
const teamsOutputDir = path.join(outputDir, "teams");
await fs.mkdir(teamsOutputDir, { recursive: true });
const outputFile = path.join(teamsOutputDir, teamFile.replace('.yml', '.txt'));
await fs.writeFile(outputFile, bundle, 'utf8');
const outputFile = path.join(teamsOutputDir, teamFile.replace(".yml", ".txt"));
await fs.writeFile(outputFile, bundle, "utf8");
console.log(` ✓ Created bundle: ${path.relative(this.rootDir, outputFile)}`);
}
} else {
@@ -224,32 +281,70 @@ class WebBuilder {
}
async buildExpansionAgentBundle(packName, packDir, agentName) {
const template = await fs.readFile(this.templatePath, 'utf8');
const template = await fs.readFile(this.templatePath, "utf8");
const sections = [template];
// Add agent configuration
const agentPath = path.join(packDir, 'agents', `${agentName}.md`);
const agentContent = await fs.readFile(agentPath, 'utf8');
const agentPath = path.join(packDir, "agents", `${agentName}.md`);
const agentContent = await fs.readFile(agentPath, "utf8");
sections.push(this.formatSection(`agents#${agentName}`, agentContent));
// Resolve and add agent dependencies from expansion pack
// Resolve and add agent dependencies
const agentYaml = agentContent.match(/```yaml\n([\s\S]*?)\n```/);
if (agentYaml) {
try {
const yaml = require('js-yaml');
const yaml = require("js-yaml");
const agentConfig = yaml.load(agentYaml[1]);
if (agentConfig.dependencies) {
// Add resources from expansion pack
// Add resources, first try expansion pack, then core
for (const [resourceType, resources] of Object.entries(agentConfig.dependencies)) {
if (Array.isArray(resources)) {
for (const resourceName of resources) {
const resourcePath = path.join(packDir, resourceType, `${resourceName}.md`);
try {
const resourceContent = await fs.readFile(resourcePath, 'utf8');
sections.push(this.formatSection(`${resourceType}#${resourceName}`, resourceContent));
} catch (error) {
// Resource might not exist in expansion pack, that's ok
let found = false;
const extensions = [".md", ".yml", ".yaml"];
// Try expansion pack first
for (const ext of extensions) {
const resourcePath = path.join(packDir, resourceType, `${resourceName}${ext}`);
try {
const resourceContent = await fs.readFile(resourcePath, "utf8");
sections.push(
this.formatSection(`${resourceType}#${resourceName}`, resourceContent)
);
found = true;
break;
} catch (error) {
// Not in expansion pack, continue
}
}
// If not found in expansion pack, try core
if (!found) {
for (const ext of extensions) {
const corePath = path.join(
this.rootDir,
"bmad-core",
resourceType,
`${resourceName}${ext}`
);
try {
const coreContent = await fs.readFile(corePath, "utf8");
sections.push(
this.formatSection(`${resourceType}#${resourceName}`, coreContent)
);
found = true;
break;
} catch (error) {
// Not in core either, continue
}
}
}
if (!found) {
console.warn(
` ⚠ Dependency ${resourceType}#${resourceName} not found in expansion pack or core`
);
}
}
}
@@ -260,67 +355,205 @@ class WebBuilder {
}
}
return sections.join('\n');
return sections.join("\n");
}
async buildExpansionTeamBundle(packName, packDir, teamConfigPath) {
const template = await fs.readFile(this.templatePath, 'utf8');
const template = await fs.readFile(this.templatePath, "utf8");
const sections = [template];
// Add team configuration
const teamContent = await fs.readFile(teamConfigPath, 'utf8');
const teamFileName = path.basename(teamConfigPath, '.yml');
// Add team configuration and parse to get agent list
const teamContent = await fs.readFile(teamConfigPath, "utf8");
const teamFileName = path.basename(teamConfigPath, ".yml");
const teamConfig = this.parseYaml(teamContent);
sections.push(this.formatSection(`agent-teams#${teamFileName}`, teamContent));
// Add bmad-orchestrator (required for all teams)
const orchestratorPath = path.join(this.rootDir, 'bmad-core', 'agents', 'bmad-orchestrator.md');
const orchestratorContent = await fs.readFile(orchestratorPath, 'utf8');
sections.push(this.formatSection('agents#bmad-orchestrator', orchestratorContent));
// Add expansion pack agents
const agentsDir = path.join(packDir, 'agents');
// Get list of expansion pack agents
const expansionAgents = new Set();
const agentsDir = path.join(packDir, "agents");
try {
const agentFiles = await fs.readdir(agentsDir);
for (const agentFile of agentFiles.filter(f => f.endsWith('.md'))) {
const agentPath = path.join(agentsDir, agentFile);
const agentContent = await fs.readFile(agentPath, 'utf8');
const agentName = agentFile.replace('.md', '');
sections.push(this.formatSection(`agents#${agentName}`, agentContent));
for (const agentFile of agentFiles.filter((f) => f.endsWith(".md"))) {
const agentName = agentFile.replace(".md", "");
expansionAgents.add(agentName);
}
} catch (error) {
console.warn(` ⚠ No agents directory found in ${packName}`);
}
// Add expansion pack resources (templates, tasks, checklists)
const resourceDirs = ['templates', 'tasks', 'checklists', 'workflows', 'data'];
// Build a map of all available expansion pack resources for override checking
const expansionResources = new Map();
const resourceDirs = ["templates", "tasks", "checklists", "workflows", "data"];
for (const resourceDir of resourceDirs) {
const resourcePath = path.join(packDir, resourceDir);
try {
const resourceFiles = await fs.readdir(resourcePath);
for (const resourceFile of resourceFiles.filter(f => f.endsWith('.md') || f.endsWith('.yml'))) {
const filePath = path.join(resourcePath, resourceFile);
const fileContent = await fs.readFile(filePath, 'utf8');
const fileName = resourceFile.replace(/\.(md|yml)$/, '');
sections.push(this.formatSection(`${resourceDir}#${fileName}`, fileContent));
for (const resourceFile of resourceFiles.filter(
(f) => f.endsWith(".md") || f.endsWith(".yml")
)) {
const fileName = resourceFile.replace(/\.(md|yml)$/, "");
expansionResources.set(`${resourceDir}#${fileName}`, true);
}
} catch (error) {
// Directory might not exist, that's fine
}
}
return sections.join('\n');
// Process all agents listed in team configuration
const agentsToProcess = teamConfig.agents || [];
// Ensure bmad-orchestrator is always included for teams
if (!agentsToProcess.includes("bmad-orchestrator")) {
console.warn(` ⚠ Team ${teamFileName} missing bmad-orchestrator, adding automatically`);
agentsToProcess.unshift("bmad-orchestrator");
}
// Track all dependencies from all agents (deduplicated)
const allDependencies = new Map();
for (const agentId of agentsToProcess) {
if (expansionAgents.has(agentId)) {
// Use expansion pack version (override)
const agentPath = path.join(agentsDir, `${agentId}.md`);
const agentContent = await fs.readFile(agentPath, "utf8");
sections.push(this.formatSection(`agents#${agentId}`, agentContent));
// Parse and collect dependencies from expansion agent
const agentYaml = agentContent.match(/```yaml\n([\s\S]*?)\n```/);
if (agentYaml) {
try {
const agentConfig = this.parseYaml(agentYaml[1]);
if (agentConfig.dependencies) {
for (const [resourceType, resources] of Object.entries(agentConfig.dependencies)) {
if (Array.isArray(resources)) {
for (const resourceName of resources) {
const key = `${resourceType}#${resourceName}`;
if (!allDependencies.has(key)) {
allDependencies.set(key, { type: resourceType, name: resourceName });
}
}
}
}
}
} catch (error) {
console.debug(`Failed to parse agent YAML for ${agentId}:`, error.message);
}
}
} else {
// Use core BMAD version
try {
const coreAgentPath = path.join(this.rootDir, "bmad-core", "agents", `${agentId}.md`);
const coreAgentContent = await fs.readFile(coreAgentPath, "utf8");
sections.push(this.formatSection(`agents#${agentId}`, coreAgentContent));
// Parse and collect dependencies from core agent
const agentYaml = coreAgentContent.match(/```yaml\n([\s\S]*?)\n```/);
if (agentYaml) {
try {
// Clean up the YAML to handle command descriptions after dashes
let yamlContent = agentYaml[1];
yamlContent = yamlContent.replace(/^(\s*-)(\s*"[^"]+")(\s*-\s*.*)$/gm, "$1$2");
const agentConfig = this.parseYaml(yamlContent);
if (agentConfig.dependencies) {
for (const [resourceType, resources] of Object.entries(agentConfig.dependencies)) {
if (Array.isArray(resources)) {
for (const resourceName of resources) {
const key = `${resourceType}#${resourceName}`;
if (!allDependencies.has(key)) {
allDependencies.set(key, { type: resourceType, name: resourceName });
}
}
}
}
}
} catch (error) {
console.debug(`Failed to parse agent YAML for ${agentId}:`, error.message);
}
}
} catch (error) {
console.warn(` ⚠ Agent ${agentId} not found in core or expansion pack`);
}
}
}
// Add all collected dependencies from agents
// Always prefer expansion pack versions if they exist
for (const [key, dep] of allDependencies) {
let found = false;
const extensions = [".md", ".yml", ".yaml"];
// Always check expansion pack first, even if the dependency came from a core agent
if (expansionResources.has(key)) {
// We know it exists in expansion pack, find and load it
for (const ext of extensions) {
const expansionPath = path.join(packDir, dep.type, `${dep.name}${ext}`);
try {
const content = await fs.readFile(expansionPath, "utf8");
sections.push(this.formatSection(key, content));
console.log(` ✓ Using expansion override for ${key}`);
found = true;
break;
} catch (error) {
// Try next extension
}
}
}
// If not found in expansion pack (or doesn't exist there), try core
if (!found) {
for (const ext of extensions) {
const corePath = path.join(this.rootDir, "bmad-core", dep.type, `${dep.name}${ext}`);
try {
const content = await fs.readFile(corePath, "utf8");
sections.push(this.formatSection(key, content));
found = true;
break;
} catch (error) {
// Not in core either, continue
}
}
}
if (!found) {
console.warn(` ⚠ Dependency ${key} not found in expansion pack or core`);
}
}
// Add remaining expansion pack resources not already included as dependencies
for (const resourceDir of resourceDirs) {
const resourcePath = path.join(packDir, resourceDir);
try {
const resourceFiles = await fs.readdir(resourcePath);
for (const resourceFile of resourceFiles.filter(
(f) => f.endsWith(".md") || f.endsWith(".yml")
)) {
const filePath = path.join(resourcePath, resourceFile);
const fileContent = await fs.readFile(filePath, "utf8");
const fileName = resourceFile.replace(/\.(md|yml)$/, "");
// Only add if not already included as a dependency
const resourceKey = `${resourceDir}#${fileName}`;
if (!allDependencies.has(resourceKey)) {
sections.push(this.formatSection(resourceKey, fileContent));
}
}
} catch (error) {
// Directory might not exist, that's fine
}
}
return sections.join("\n");
}
async listExpansionPacks() {
const expansionPacksDir = path.join(this.rootDir, 'expansion-packs');
const expansionPacksDir = path.join(this.rootDir, "expansion-packs");
try {
const entries = await fs.readdir(expansionPacksDir, { withFileTypes: true });
return entries
.filter(entry => entry.isDirectory())
.map(entry => entry.name);
return entries.filter((entry) => entry.isDirectory()).map((entry) => entry.name);
} catch (error) {
console.warn('No expansion-packs directory found');
console.warn("No expansion-packs directory found");
return [];
}
}
@@ -330,4 +563,4 @@ class WebBuilder {
}
}
module.exports = WebBuilder;
module.exports = WebBuilder;

View File

@@ -1,6 +1,7 @@
#!/usr/bin/env node
const { program } = require('commander');
const path = require('path');
// Dynamic imports for ES modules
let chalk, inquirer;
@@ -57,7 +58,9 @@ program
if (!options.full && !options.agent && !options.team && !options.expansionOnly) {
// Interactive mode
const answers = await promptInstallation();
await installer.install(answers);
if (!answers._alreadyInstalled) {
await installer.install(answers);
}
} else {
// Direct mode
let installType = 'full';
@@ -158,6 +161,35 @@ async function promptInstallation() {
]);
answers.directory = directory;
// Check if this is an existing v4 installation
const installDir = path.resolve(answers.directory);
const state = await installer.detectInstallationState(installDir);
if (state.type === 'v4_existing') {
console.log(chalk.yellow('\n🔍 Found existing BMAD v4 installation'));
console.log(` Directory: ${installDir}`);
console.log(` Version: ${state.manifest?.version || 'Unknown'}`);
console.log(` Installed: ${state.manifest?.installed_at ? new Date(state.manifest.installed_at).toLocaleDateString() : 'Unknown'}`);
const { shouldUpdate } = await inquirer.prompt([
{
type: 'confirm',
name: 'shouldUpdate',
message: 'Would you like to update your existing BMAD v4 installation?',
default: true
}
]);
if (shouldUpdate) {
// Skip other prompts and go directly to update
answers.installType = 'update';
answers._alreadyInstalled = true; // Flag to prevent double installation
await installer.install(answers);
return answers; // Return the answers object
}
// If user doesn't want to update, continue with normal flow
}
// Ask for installation type
const { installType } = await inquirer.prompt([
{
@@ -373,7 +405,7 @@ async function promptInstallation() {
type: 'input',
name: 'webBundlesDirectory',
message: 'Enter directory for web bundles:',
default: `${directory}/web-bundles`,
default: `${answers.directory}/web-bundles`,
validate: (input) => {
if (!input.trim()) {
return 'Please enter a valid directory path';

View File

@@ -2,6 +2,7 @@ const fs = require("fs-extra");
const path = require("path");
const crypto = require("crypto");
const glob = require("glob");
const yaml = require("js-yaml");
// Dynamic import for ES module
let chalk;
@@ -106,7 +107,7 @@ class FileManager {
// Write manifest
await fs.ensureDir(path.dirname(manifestPath));
await fs.writeFile(manifestPath, JSON.stringify(manifest, null, 2));
await fs.writeFile(manifestPath, yaml.dump(manifest, { indent: 2 }));
return manifest;
}
@@ -120,7 +121,7 @@ class FileManager {
try {
const content = await fs.readFile(manifestPath, "utf8");
return JSON.parse(content);
return yaml.load(content);
} catch (error) {
return null;
}

View File

@@ -39,20 +39,13 @@ class IdeSetup {
async setupCursor(installDir, selectedAgent) {
const cursorRulesDir = path.join(installDir, ".cursor", "rules");
const agents = selectedAgent
? [selectedAgent]
: await this.getAllAgentIds(installDir);
const agents = selectedAgent ? [selectedAgent] : await this.getAllAgentIds(installDir);
await fileManager.ensureDirectory(cursorRulesDir);
for (const agentId of agents) {
// Check if .bmad-core is a subdirectory (full install) or if agents are in root (single agent install)
let agentPath = path.join(
installDir,
".bmad-core",
"agents",
`${agentId}.md`
);
let agentPath = path.join(installDir, ".bmad-core", "agents", `${agentId}.md`);
if (!(await fileManager.pathExists(agentPath))) {
agentPath = path.join(installDir, "agents", `${agentId}.md`);
}
@@ -103,20 +96,13 @@ class IdeSetup {
async setupClaudeCode(installDir, selectedAgent) {
const commandsDir = path.join(installDir, ".claude", "commands");
const agents = selectedAgent
? [selectedAgent]
: await this.getAllAgentIds(installDir);
const agents = selectedAgent ? [selectedAgent] : await this.getAllAgentIds(installDir);
await fileManager.ensureDirectory(commandsDir);
for (const agentId of agents) {
// Check if .bmad-core is a subdirectory (full install) or if agents are in root (single agent install)
let agentPath = path.join(
installDir,
".bmad-core",
"agents",
`${agentId}.md`
);
let agentPath = path.join(installDir, ".bmad-core", "agents", `${agentId}.md`);
if (!(await fileManager.pathExists(agentPath))) {
agentPath = path.join(installDir, "agents", `${agentId}.md`);
}
@@ -136,29 +122,20 @@ class IdeSetup {
}
}
console.log(
chalk.green(`\n✓ Created Claude Code commands in ${commandsDir}`)
);
console.log(chalk.green(`\n✓ Created Claude Code commands in ${commandsDir}`));
return true;
}
async setupWindsurf(installDir, selectedAgent) {
const windsurfRulesDir = path.join(installDir, ".windsurf", "rules");
const agents = selectedAgent
? [selectedAgent]
: await this.getAllAgentIds(installDir);
const agents = selectedAgent ? [selectedAgent] : await this.getAllAgentIds(installDir);
await fileManager.ensureDirectory(windsurfRulesDir);
for (const agentId of agents) {
// Check if .bmad-core is a subdirectory (full install) or if agents are in root (single agent install)
let agentPath = path.join(
installDir,
".bmad-core",
"agents",
`${agentId}.md`
);
let agentPath = path.join(installDir, ".bmad-core", "agents", `${agentId}.md`);
if (!(await fileManager.pathExists(agentPath))) {
agentPath = path.join(installDir, "agents", `${agentId}.md`);
}
@@ -197,9 +174,7 @@ class IdeSetup {
}
}
console.log(
chalk.green(`\n✓ Created Windsurf rules in ${windsurfRulesDir}`)
);
console.log(chalk.green(`\n✓ Created Windsurf rules in ${windsurfRulesDir}`));
return true;
}
@@ -233,13 +208,7 @@ class IdeSetup {
}
async setupRoo(installDir, selectedAgent) {
const agents = selectedAgent
? [selectedAgent]
: await this.getAllAgentIds(installDir);
// Create .roo directory first
const rooDir = path.join(installDir, ".roo");
await fileManager.ensureDirectory(rooDir);
const agents = selectedAgent ? [selectedAgent] : await this.getAllAgentIds(installDir);
// Check for existing .roomodes file in project root
const roomodesPath = path.join(installDir, ".roomodes");
@@ -253,11 +222,7 @@ class IdeSetup {
for (const match of modeMatches) {
existingModes.push(match[1]);
}
console.log(
chalk.yellow(
`Found existing .roomodes file with ${existingModes.length} modes`
)
);
console.log(chalk.yellow(`Found existing .roomodes file with ${existingModes.length} modes`));
}
// Create new modes content
@@ -265,55 +230,48 @@ class IdeSetup {
// Define file permissions for each agent type
const agentPermissions = {
'analyst': {
fileRegex: '\\.(md|txt)$',
description: 'Documentation and text files'
analyst: {
fileRegex: "\\.(md|txt)$",
description: "Documentation and text files",
},
'pm': {
fileRegex: '\\.(md|txt)$',
description: 'Product documentation'
pm: {
fileRegex: "\\.(md|txt)$",
description: "Product documentation",
},
'architect': {
fileRegex: '\\.(md|txt|yml|yaml|json)$',
description: 'Architecture docs and configs'
architect: {
fileRegex: "\\.(md|txt|yml|yaml|json)$",
description: "Architecture docs and configs",
},
'dev': null, // Full edit access
'qa': {
fileRegex: '\\.(test|spec)\\.(js|ts|jsx|tsx)$|\\.md$',
description: 'Test files and documentation'
dev: null, // Full edit access
qa: {
fileRegex: "\\.(test|spec)\\.(js|ts|jsx|tsx)$|\\.md$",
description: "Test files and documentation",
},
'ux-expert': {
fileRegex: '\\.(md|css|scss|html|jsx|tsx)$',
description: 'Design-related files'
"ux-expert": {
fileRegex: "\\.(md|css|scss|html|jsx|tsx)$",
description: "Design-related files",
},
'po': {
fileRegex: '\\.(md|txt)$',
description: 'Story and requirement docs'
po: {
fileRegex: "\\.(md|txt)$",
description: "Story and requirement docs",
},
'sm': {
fileRegex: '\\.(md|txt)$',
description: 'Process and planning docs'
sm: {
fileRegex: "\\.(md|txt)$",
description: "Process and planning docs",
},
'bmad-orchestrator': null, // Full edit access
'bmad-master': null // Full edit access
"bmad-orchestrator": null, // Full edit access
"bmad-master": null, // Full edit access
};
for (const agentId of agents) {
// Skip if already exists
if (existingModes.includes(`bmad-${agentId}`)) {
console.log(
chalk.dim(`Skipping ${agentId} - already exists in .roomodes`)
);
console.log(chalk.dim(`Skipping ${agentId} - already exists in .roomodes`));
continue;
}
// Read agent file to extract all information
let agentPath = path.join(
installDir,
".bmad-core",
"agents",
`${agentId}.md`
);
let agentPath = path.join(installDir, ".bmad-core", "agents", `${agentId}.md`);
if (!(await fileManager.pathExists(agentPath))) {
agentPath = path.join(installDir, "agents", `${agentId}.md`);
}
@@ -334,9 +292,7 @@ class IdeSetup {
const title = titleMatch ? titleMatch[1].trim() : this.getAgentTitle(agentId);
const icon = iconMatch ? iconMatch[1].trim() : "🤖";
const whenToUse = whenToUseMatch
? whenToUseMatch[1].trim()
: `Use for ${title} tasks`;
const whenToUse = whenToUseMatch ? whenToUseMatch[1].trim() : `Use for ${title} tasks`;
const roleDefinition = roleDefinitionMatch
? roleDefinitionMatch[1].trim()
: `You are a ${title} specializing in ${title.toLowerCase()} tasks and responsibilities.`;
@@ -360,9 +316,7 @@ class IdeSetup {
newModesContent += ` - edit\n`;
}
console.log(
chalk.green(`✓ Added mode: bmad-${agentId} (${icon} ${title})`)
);
console.log(chalk.green(`✓ Added mode: bmad-${agentId} (${icon} ${title})`));
}
}
}
@@ -381,46 +335,8 @@ class IdeSetup {
await fileManager.writeFile(roomodesPath, roomodesContent);
console.log(chalk.green("✓ Created .roomodes file in project root"));
// Create README in .roo directory
const rooReadme = `# Roo Code Custom Modes for BMAD-METHOD
This directory contains custom mode configurations for Roo Code to enable BMAD agent personalities.
## Setup
The \`.roomodes\` file defines all BMAD agents as custom modes using the proper \`customModes:\` structure. Modes are automatically available in Roo Code when you open this project.
## Available Modes
${agents.map((id) => `- **bmad-${id}** - ${this.getAgentTitle(id)}`).join("\n")}
## Usage
In Roo Code:
1. Open the mode selector (usually in the status bar)
2. Select any BMAD agent mode
3. The AI will adopt that agent's personality and expertise
## File Permissions
Each agent has specific file access permissions:
- **Analysts, PM, PO, SM**: Limited to documentation files (.md, .txt)
- **Architect**: Architecture docs and configs (.md, .txt, .yml, .yaml, .json)
- **QA**: Test files and documentation
- **UX Expert**: Design-related files (.md, .css, .scss, .html, .jsx, .tsx)
- **Developer, Orchestrator, Master**: Full edit access to all files
`;
const readmePath = path.join(rooDir, "README.md");
await fileManager.writeFile(readmePath, rooReadme);
console.log(chalk.green("✓ Created .roo/README.md"));
console.log(chalk.green(`\n✓ Roo Code setup complete!`));
console.log(
chalk.dim(
"Custom modes will be available when you open this project in Roo Code"
)
);
console.log(chalk.dim("Custom modes will be available when you open this project in Roo Code"));
return true;
}

View File

@@ -102,6 +102,17 @@ class Installer {
spinner.start("Analyzing installation directory...");
}
// If this is an update request from early detection, handle it directly
if (config.installType === 'update') {
const state = await this.detectInstallationState(installDir);
if (state.type === 'v4_existing') {
return await this.performUpdate(config, installDir, state.manifest, spinner);
} else {
spinner.fail('No existing v4 installation found to update');
throw new Error('No existing v4 installation found');
}
}
// Detect current state
const state = await this.detectInstallationState(installDir);
@@ -425,7 +436,10 @@ class Installer {
console.log(chalk.cyan("\n📦 Starting v3 to v4 upgrade process..."));
const V3ToV4Upgrader = require("../../upgraders/v3-to-v4-upgrader");
const upgrader = new V3ToV4Upgrader();
return await upgrader.upgrade({ projectPath: installDir });
return await upgrader.upgrade({
projectPath: installDir,
ides: config.ides || [] // Pass IDE selections from initial config
});
}
case "alongside":
return await this.performFreshInstall(config, installDir, spinner);
@@ -538,7 +552,8 @@ class Installer {
installType: manifest.install_type,
agent: manifest.agent,
directory: installDir,
ide: newConfig.ide || manifest.ide_setup, // Use new IDE choice if provided
ide: newConfig?.ide || manifest.ide_setup, // Use new IDE choice if provided
ides: newConfig?.ides || manifest.ides_setup || [],
};
await this.performFreshInstall(config, installDir, spinner);

View File

@@ -1,6 +1,6 @@
{
"name": "bmad-method",
"version": "4.6.0",
"version": "4.8.0",
"description": "BMAD Method installer - AI-powered Agile development framework",
"main": "lib/installer.js",
"bin": {

View File

@@ -98,7 +98,7 @@ class V3ToV4Upgrader {
// 8. Setup IDE
if (!options.dryRun) {
await this.setupIDE(projectPath);
await this.setupIDE(projectPath, options.ides);
}
// 9. Show completion report
@@ -379,8 +379,8 @@ class V3ToV4Upgrader {
const spinner = ora("Installing V4 structure...").start();
try {
// Get the source .bmad-core directory
const sourcePath = path.join(__dirname, "..", "..", ".bmad-core");
// Get the source bmad-core directory (without dot prefix)
const sourcePath = path.join(__dirname, "..", "..", "bmad-core");
const destPath = path.join(projectPath, ".bmad-core");
// Copy .bmad-core
@@ -545,47 +545,37 @@ class V3ToV4Upgrader {
}
}
async setupIDE(projectPath) {
const { ide } = await inquirer.prompt([
{
type: "list",
name: "ide",
message: "Which IDE are you using?",
choices: [
{ name: "Cursor", value: "cursor" },
{ name: "Claude Code", value: "claude-code" },
{ name: "Windsurf", value: "windsurf" },
{ name: "Roo Code", value: "roo" },
{ name: "VS Code", value: "skip" },
{ name: "Other/Skip", value: "skip" },
],
},
]);
async setupIDE(projectPath, selectedIdes) {
// Use the IDE selections passed from the installer
if (!selectedIdes || selectedIdes.length === 0) {
console.log(chalk.dim("No IDE setup requested - skipping"));
return;
}
const selectedIde = ide === "skip" ? null : ide;
const ideSetup = require("../installer/lib/ide-setup");
const spinner = ora("Setting up IDE rules for all agents...").start();
if (selectedIde) {
const ideSetup = require("../installer/lib/ide-setup");
const spinner = ora("Setting up IDE rules for all agents...").start();
try {
const ideMessages = {
cursor: "Rules created in .cursor/rules/",
"claude-code": "Commands created in .claude/commands/",
windsurf: "Rules created in .windsurf/rules/",
roo: "Custom modes created in .roomodes",
};
try {
await ideSetup.setup(selectedIde, projectPath);
spinner.succeed("IDE setup complete!");
const ideMessages = {
cursor: "Rules created in .cursor/rules/",
"claude-code": "Commands created in .claude/commands/",
windsurf: "Rules created in .windsurf/rules/",
roo: "Custom modes created in .roomodes",
};
console.log(chalk.green(`- ${ideMessages[selectedIde]}`));
} catch (error) {
spinner.fail("IDE setup failed");
console.error(
chalk.yellow("IDE setup failed, but upgrade is complete.")
);
// Setup each selected IDE
for (const ide of selectedIdes) {
spinner.text = `Setting up ${ide}...`;
await ideSetup.setup(ide, projectPath);
console.log(chalk.green(`\n${ideMessages[ide]}`));
}
spinner.succeed(`IDE setup complete for ${selectedIdes.length} IDE(s)!`);
} catch (error) {
spinner.fail("IDE setup failed");
console.error(
chalk.yellow("IDE setup failed, but upgrade is complete.")
);
}
}