bmad-method 4.6.3 → 4.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/.prettierignore +0 -1
  2. package/CHANGELOG.md +24 -0
  3. package/README.md +18 -1
  4. package/bmad-core/agents/analyst.md +11 -8
  5. package/bmad-core/agents/architect.md +10 -7
  6. package/bmad-core/agents/bmad-master.md +13 -11
  7. package/bmad-core/agents/bmad-orchestrator.md +3 -0
  8. package/bmad-core/agents/dev.md +19 -14
  9. package/bmad-core/agents/pm.md +8 -5
  10. package/bmad-core/agents/po.md +13 -10
  11. package/bmad-core/agents/qa.md +8 -5
  12. package/bmad-core/agents/sm.md +15 -25
  13. package/bmad-core/agents/ux-expert.md +11 -8
  14. package/bmad-core/core-config.yml +24 -0
  15. package/bmad-core/data/bmad-kb.md +391 -10
  16. package/bmad-core/tasks/create-next-story.md +63 -45
  17. package/bmad-core/utils/file-resolution-context.md +10 -0
  18. package/dist/agents/analyst.txt +404 -17
  19. package/dist/agents/architect.txt +14 -6
  20. package/dist/agents/bmad-master.txt +485 -109
  21. package/dist/agents/bmad-orchestrator.txt +402 -22
  22. package/dist/agents/dev.txt +26 -34
  23. package/dist/agents/pm.txt +9 -5
  24. package/dist/agents/po.txt +10 -10
  25. package/dist/agents/qa.txt +4 -4
  26. package/dist/agents/sm.txt +74 -63
  27. package/dist/agents/ux-expert.txt +9 -7
  28. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +49 -20
  29. package/dist/expansion-packs/expansion-creator/agents/bmad-the-creator.txt +6 -3
  30. package/dist/teams/team-all.txt +561 -158
  31. package/dist/teams/team-fullstack.txt +457 -57
  32. package/dist/teams/team-ide-minimal.txt +516 -133
  33. package/dist/teams/team-no-ui.txt +448 -50
  34. package/docs/bmad-workflow-guide.md +10 -8
  35. package/docs/claude-code-guide.md +1 -1
  36. package/docs/core-architecture.md +4 -4
  37. package/docs/cursor-guide.md +1 -1
  38. package/docs/roo-code-guide.md +1 -1
  39. package/docs/user-guide.md +30 -21
  40. package/docs/windsurf-guide.md +1 -1
  41. package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +3 -0
  42. package/expansion-packs/expansion-creator/templates/agent-tmpl.md +4 -1
  43. package/package.json +1 -1
  44. package/tools/builders/web-builder.js +158 -94
  45. package/tools/installer/bin/bmad.js +34 -2
  46. package/tools/installer/lib/file-manager.js +3 -2
  47. package/tools/installer/lib/ide-setup.js +39 -123
  48. package/tools/installer/lib/installer.js +13 -1
  49. package/tools/installer/package.json +1 -1
  50. /package/bmad-core/{templates/web-agent-startup-instructions-template.md → utils/web-agent-startup-instructions.md} +0 -0
@@ -41,9 +41,9 @@ These references map directly to bundle sections:
41
41
  ==================== START: agents#bmad-master ====================
42
42
  # bmad-master
43
43
 
44
- 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:
44
+ 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:
45
45
 
46
- ```yml
46
+ ```yaml
47
47
  agent:
48
48
  name: BMad Master
49
49
  id: bmad-master
@@ -63,21 +63,21 @@ persona:
63
63
  - Use numbered lists for choices
64
64
  - Process (*) commands immediately
65
65
  startup:
66
- - 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.
66
+ - Greet the user with your name and role, and inform of the *help command.
67
67
  - CRITICAL: Do NOT scan filesystem or load any resources during startup
68
68
  - CRITICAL: Do NOT run discovery tasks automatically
69
69
  - Wait for user request before any tool use
70
70
  - Match request to resources, offer numbered options if unclear
71
71
  - Load resources only when explicitly requested
72
72
  commands:
73
- - '*help" - Show commands'
74
- - '*chat" - Advanced elicitation + KB mode'
75
- - '*status" - Current context'
76
- - '*task/template/util/checklist/workflow {name}" - Execute (list if no name)'
77
- - '*list {type}" - List resources by type'
78
- - '*exit" - Exit (confirm)'
79
- - '*yolo" - Skip confirmations'
80
- - '*doc-out" - Output full document'
73
+ - help: Show commands
74
+ - chat: Advanced elicitation + KB mode
75
+ - status: Current context
76
+ - task {template|util|checklist|workflow}: Execute
77
+ - list {task|template|util|checklist|workflow}: List resources by type
78
+ - exit: Exit (confirm)
79
+ - yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
80
+ - doc-out: Output full document
81
81
  fuzzy-matching:
82
82
  - 85% confidence threshold
83
83
  - Show numbered list if unsure
@@ -115,7 +115,6 @@ dependencies:
115
115
  - prd-tmpl
116
116
  - project-brief-tmpl
117
117
  - story-tmpl
118
- - web-agent-startup-instructions-template
119
118
  data:
120
119
  - bmad-kb
121
120
  - technical-preferences
@@ -1722,45 +1721,42 @@ Present a summary of what was created and ask if any additional documentation wo
1722
1721
 
1723
1722
  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.
1724
1723
 
1725
- ## Inputs for this Task
1726
-
1727
- - Access to the project's documentation repository, specifically:
1728
- - `docs/index.md` (hereafter "Index Doc")
1729
- - All Epic files - located in one of these locations:
1730
- - Primary: `docs/prd/epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
1731
- - Secondary: `docs/epics/epic-{n}-{description}.md`
1732
- - User-specified location if not found in above paths
1733
- - Existing story files in `docs/stories/`
1734
- - Main PRD (hereafter "PRD Doc")
1735
- - Main Architecture Document (hereafter "Main Arch Doc")
1736
- - Frontend Architecture Document (hereafter "Frontend Arch Doc," if relevant)
1737
- - Project Structure Guide (`docs/project-structure.md`)
1738
- - Operational Guidelines Document (`docs/operational-guidelines.md`)
1739
- - Technology Stack Document (`docs/tech-stack.md`)
1740
- - Data Models Document (as referenced in Index Doc)
1741
- - API Reference Document (as referenced in Index Doc)
1742
- - UI/UX Specifications, Style Guides, Component Guides (if relevant, as referenced in Index Doc)
1743
- - The `bmad-core/templates/story-tmpl.md` (hereafter "Story Template")
1744
- - The `bmad-core/checklists/story-draft-checklist.md` (hereafter "Story Draft Checklist")
1745
- - User confirmation to proceed with story identification and, if needed, to override warnings about incomplete prerequisite stories.
1746
-
1747
1724
  ## Task Execution Instructions
1748
1725
 
1726
+ ### 0. Load Core Configuration
1727
+
1728
+ [[LLM: CRITICAL - This MUST be your first step]]
1729
+
1730
+ - Load `.bmad-core/core-config.yml` from the project root
1731
+ - If the file does not exist:
1732
+ - HALT and inform the user: "core-config.yml not found. This file is required for story creation. You can:
1733
+ 1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yml and configure it for your project
1734
+ 2. Run the BMAD installer against your project to upgrade and add the file automatically
1735
+ Please add and configure core-config.yml before proceeding."
1736
+ - Extract the following key configurations:
1737
+ - `dev-story-location`: Where to save story files
1738
+ - `prd.prdSharded`: Whether PRD is sharded or monolithic
1739
+ - `prd.prd-file`: Location of monolithic PRD (if not sharded)
1740
+ - `prd.prdShardedLocation`: Location of sharded epic files
1741
+ - `prd.epicFilePattern`: Pattern for epic files (e.g., `epic-{n}*.md`)
1742
+ - `architecture.architectureVersion`: Architecture document version
1743
+ - `architecture.architectureSharded`: Whether architecture is sharded
1744
+ - `architecture.architecture-file`: Location of monolithic architecture
1745
+ - `architecture.architectureShardedLocation`: Location of sharded architecture files
1746
+
1749
1747
  ### 1. Identify Next Story for Preparation
1750
1748
 
1751
1749
  #### 1.1 Locate Epic Files
1752
1750
 
1753
- - First, determine where epic files are located:
1754
- - Check `docs/prd/` for files matching pattern `epic-{n}-*.md`
1755
- - If not found, check `docs/epics/` for files matching pattern `epic-{n}-*.md`
1756
- - If still not found, ask user: "Unable to locate epic files. Please specify the path where epic files are stored."
1757
- - Note: Epic files follow naming convention `epic-{n}-{description}.md` (e.g., `epic-1-foundation-core-infrastructure.md`)
1751
+ - Based on `prdSharded` from config:
1752
+ - **If `prdSharded: true`**: Look for epic files in `prdShardedLocation` using `epicFilePattern`
1753
+ - **If `prdSharded: false`**: Load the full PRD from `prd-file` and extract epics from section headings (## Epic N or ### Epic N)
1758
1754
 
1759
1755
  #### 1.2 Review Existing Stories
1760
1756
 
1761
- - Review `docs/stories/` to find the highest-numbered story file.
1757
+ - Check `dev-story-location` from config (e.g., `docs/stories/`) for existing story files
1758
+ - If the directory exists and has at least 1 file, find the highest-numbered story file.
1762
1759
  - **If a highest story file exists (`{lastEpicNum}.{lastStoryNum}.story.md`):**
1763
-
1764
1760
  - Verify its `Status` is 'Done' (or equivalent).
1765
1761
  - If not 'Done', present an alert to the user:
1766
1762
 
@@ -1778,17 +1774,17 @@ To identify the next logical story based on project progress and epic definition
1778
1774
  ```
1779
1775
 
1780
1776
  - Proceed only if user selects option 3 (Override) or if the last story was 'Done'.
1781
- - 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.
1782
- - 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.
1777
+ - 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.
1778
+ - 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.
1783
1779
 
1784
1780
  - **If no story files exist in `docs/stories/`:**
1785
1781
  - 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.
1786
1782
  - 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.
1787
1783
  - Announce the identified story to the user: "Identified next story for preparation: {epicNum}.{storyNum} - {Story Title}".
1788
1784
 
1789
- ### 2. Gather Core Story Requirements (from Epic File)
1785
+ ### 2. Gather Core Story Requirements (from Epic)
1790
1786
 
1791
- - For the identified story, open its parent Epic File (e.g., `epic-{epicNum}-*.md` from the location identified in step 1.1).
1787
+ - For the identified story, review its parent Epic (e.g., `epic-{epicNum}*.md` from the location identified in step 1.1).
1792
1788
  - Extract: Exact Title, full Goal/User Story statement, initial list of Requirements, all Acceptance Criteria (ACs), and any predefined high-level Tasks.
1793
1789
  - Keep a record of this original epic-defined scope for later deviation analysis.
1794
1790
 
@@ -1797,7 +1793,7 @@ To identify the next logical story based on project progress and epic definition
1797
1793
  [[LLM: This step is CRITICAL for continuity and learning from implementation experience]]
1798
1794
 
1799
1795
  - If this is not the first story (i.e., previous story exists):
1800
- - Read the previous story file: `docs/stories/{prevEpicNum}.{prevStoryNum}.story.md`
1796
+ - Read the previous sequential story from `docs/stories`
1801
1797
  - Pay special attention to:
1802
1798
  - Dev Agent Record sections (especially Completion Notes and Debug Log References)
1803
1799
  - Any deviations from planned implementation
@@ -1806,18 +1802,30 @@ To identify the next logical story based on project progress and epic definition
1806
1802
  - Any "lessons learned" or notes for future stories
1807
1803
  - Extract relevant insights that might inform the current story's preparation
1808
1804
 
1809
- ### 4. Gather & Synthesize Architecture Context from Sharded Docs
1805
+ ### 4. Gather & Synthesize Architecture Context
1806
+
1807
+ [[LLM: CRITICAL - You MUST gather technical details from the architecture documents. NEVER make up technical details not found in these documents.]]
1810
1808
 
1811
- [[LLM: CRITICAL - You MUST gather technical details from the sharded architecture documents. NEVER make up technical details not found in these documents.]]
1809
+ #### 4.1 Determine Architecture Document Strategy
1812
1810
 
1813
- #### 4.1 Start with Architecture Index
1811
+ Based on configuration loaded in Step 0:
1814
1812
 
1815
- - Read `docs/architecture/index.md` to understand the full scope of available documentation
1816
- - Identify which sharded documents are most relevant to the current story
1813
+ - **If `architectureVersion: v4` and `architectureSharded: true`**:
1814
+ - Read `{architectureShardedLocation}/index.md` to understand available documentation
1815
+ - Follow the structured reading order in section 4.2 below
1816
+
1817
+ - **If `architectureVersion: v4` and `architectureSharded: false`**:
1818
+ - Load the monolithic architecture from `architecture-file`
1819
+ - Extract relevant sections based on v4 structure (tech stack, project structure, etc.)
1820
+
1821
+ - **If `architectureVersion` is NOT v4**:
1822
+ - Inform user: "Architecture document is not v4 format. Will use best judgment to find relevant information."
1823
+ - If `architectureSharded: true`: Search sharded files by filename relevance
1824
+ - If `architectureSharded: false`: Search within monolithic `architecture-file` for relevant sections
1817
1825
 
1818
- #### 4.2 Recommended Reading Order Based on Story Type
1826
+ #### 4.2 Recommended Reading Order Based on Story Type (v4 Sharded Only)
1819
1827
 
1820
- [[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.]]
1828
+ [[LLM: Use this structured approach ONLY for v4 sharded architecture. For other versions, use best judgment based on file names and content.]]
1821
1829
 
1822
1830
  **For ALL Stories:**
1823
1831
 
@@ -1826,9 +1834,18 @@ To identify the next logical story based on project progress and epic definition
1826
1834
  3. `docs/architecture/coding-standards.md` - Ensure dev follows project conventions
1827
1835
  4. `docs/architecture/testing-strategy.md` - Include testing requirements in tasks
1828
1836
 
1829
- **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)
1837
+ **For Backend/API Stories, additionally read:**
1838
+ 5. `docs/architecture/data-models.md` - Data structures and validation rules
1839
+ 6. `docs/architecture/database-schema.md` - Database design and relationships
1840
+ 7. `docs/architecture/backend-architecture.md` - Service patterns and structure
1841
+ 8. `docs/architecture/rest-api-spec.md` - API endpoint specifications
1842
+ 9. `docs/architecture/external-apis.md` - Third-party integrations (if relevant)
1830
1843
 
1831
- **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
1844
+ **For Frontend/UI Stories, additionally read:**
1845
+ 5. `docs/architecture/frontend-architecture.md` - Component structure and patterns
1846
+ 6. `docs/architecture/components.md` - Specific component designs
1847
+ 7. `docs/architecture/core-workflows.md` - User interaction flows
1848
+ 8. `docs/architecture/data-models.md` - Frontend data handling
1832
1849
 
1833
1850
  **For Full-Stack Stories:**
1834
1851
 
@@ -1861,7 +1878,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
1861
1878
 
1862
1879
  ### 6. Populate Story Template with Full Context
1863
1880
 
1864
- - Create a new story file: `docs/stories/{epicNum}.{storyNum}.story.md`.
1881
+ - Create a new story file: `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config).
1865
1882
  - Use the Story Template to structure the file.
1866
1883
  - Fill in:
1867
1884
  - Story `{EpicNum}.{StoryNum}: {Short Title Copied from Epic File}`
@@ -1908,7 +1925,7 @@ Format references as: `[Source: architecture/{filename}.md#{section}]`
1908
1925
  - Verify all source references are included for technical details
1909
1926
  - Ensure tasks align with both epic requirements and architecture constraints
1910
1927
  - Update status to "Draft"
1911
- - Save the story file to `docs/stories/{epicNum}.{storyNum}.story.md`
1928
+ - Save the story file to `{dev-story-location}/{epicNum}.{storyNum}.story.md` (using location from config)
1912
1929
 
1913
1930
  ### 9. Report Completion
1914
1931
 
@@ -2441,6 +2458,8 @@ Document sharded successfully:
2441
2458
 
2442
2459
  [[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.]]
2443
2460
 
2461
+ [[LLM: The default path and filename unless specified is docs/architecture.md]]
2462
+
2444
2463
  ## Introduction
2445
2464
 
2446
2465
  [[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
3216
3235
  ==================== START: templates#brownfield-architecture-tmpl ====================
3217
3236
  # {{Project Name}} Brownfield Enhancement Architecture
3218
3237
 
3238
+ [[LLM: The default path and filename unless specified is docs/architecture.md]]
3239
+
3219
3240
  [[LLM: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
3220
3241
 
3221
3242
  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]]
3761
3782
  ==================== START: templates#brownfield-prd-tmpl ====================
3762
3783
  # {{Project Name}} Brownfield Enhancement PRD
3763
3784
 
3785
+ [[LLM: The default path and filename unless specified is docs/prd.md]]
3786
+
3764
3787
  [[LLM: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
3765
3788
 
3766
3789
  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}}.
4004
4027
  ==================== START: templates#competitor-analysis-tmpl ====================
4005
4028
  # Competitive Analysis Report: {{Project/Product Name}}
4006
4029
 
4030
+ [[LLM: The default path and filename unless specified is docs/competitor-analysis.md]]
4031
+
4007
4032
  [[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.]]
4008
4033
 
4009
4034
  ## Executive Summary
@@ -4296,6 +4321,8 @@ These replace the standard elicitation options when working on competitive analy
4296
4321
  ==================== START: templates#front-end-architecture-tmpl ====================
4297
4322
  # {{Project Name}} Frontend Architecture Document
4298
4323
 
4324
+ [[LLM: The default path and filename unless specified is docs/ui-architecture.md]]
4325
+
4299
4326
  [[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.]]
4300
4327
 
4301
4328
  ## Template and Framework Selection
@@ -4472,6 +4499,8 @@ Document the starter template decision and any constraints it imposes before pro
4472
4499
  ==================== START: templates#front-end-spec-tmpl ====================
4473
4500
  # {{Project Name}} UI/UX Specification
4474
4501
 
4502
+ [[LLM: The default path and filename unless specified is docs/front-end-spec.md]]
4503
+
4475
4504
  [[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.]]
4476
4505
 
4477
4506
  ## Introduction
@@ -4886,6 +4915,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
4886
4915
  ==================== START: templates#fullstack-architecture-tmpl ====================
4887
4916
  # {{Project Name}} Fullstack Architecture Document
4888
4917
 
4918
+ [[LLM: The default path and filename unless specified is docs/architecture.md]]
4919
+
4889
4920
  [[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.]]
4890
4921
 
4891
4922
  ## Introduction
@@ -5905,6 +5936,8 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
5905
5936
  ==================== START: templates#market-research-tmpl ====================
5906
5937
  # Market Research Report: {{Project/Product Name}}
5907
5938
 
5939
+ [[LLM: The default path and filename unless specified is docs/market-research.md]]
5940
+
5908
5941
  [[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.]]
5909
5942
 
5910
5943
  ## Executive Summary
@@ -6169,6 +6202,8 @@ These replace the standard elicitation options when working on market research d
6169
6202
  ==================== START: templates#prd-tmpl ====================
6170
6203
  # {{Project Name}} Product Requirements Document (PRD)
6171
6204
 
6205
+ [[LLM: The default path and filename unless specified is docs/prd.md]]
6206
+
6172
6207
  [[LLM: If available, review any provided document or ask if any are optionally available: Project Brief]]
6173
6208
 
6174
6209
  ## Goals and Background Context
@@ -6372,6 +6407,8 @@ so that {{benefit}}.
6372
6407
  ==================== START: templates#project-brief-tmpl ====================
6373
6408
  # Project Brief: {{Project Name}}
6374
6409
 
6410
+ [[LLM: The default path and filename unless specified is docs/brief.md]]
6411
+
6375
6412
  [[LLM: This template guides creation of a comprehensive Project Brief that serves as the foundational input for product development.
6376
6413
 
6377
6414
  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
6664
6701
  | :--- | :------ | :---------- | :----- |
6665
6702
  ==================== END: templates#story-tmpl ====================
6666
6703
 
6667
- ==================== START: templates#web-agent-startup-instructions-template ====================
6668
- # Web Agent Bundle Instructions
6669
-
6670
- 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.
6671
-
6672
- ## Important Instructions
6673
-
6674
- 1. **Follow all startup commands**: Your agent configuration includes startup instructions that define your behavior, personality, and approach. These MUST be followed exactly.
6675
-
6676
- 2. **Resource Navigation**: This bundle contains all resources you need. Resources are marked with tags like:
6677
-
6678
- - `==================== START: folder#filename ====================`
6679
- - `==================== END: folder#filename ====================`
6680
-
6681
- When you need to reference a resource mentioned in your instructions:
6682
-
6683
- - Look for the corresponding START/END tags
6684
- - The format is always `folder#filename` (e.g., `personas#analyst`, `tasks#create-story`)
6685
- - If a section is specified (e.g., `tasks#create-story#section-name`), navigate to that section within the file
6686
-
6687
- **Understanding YAML References**: In the agent configuration, resources are referenced in the dependencies section. For example:
6688
-
6689
- ```yaml
6690
- dependencies:
6691
- utils:
6692
- - template-format
6693
- tasks:
6694
- - create-story
6695
- ```
6696
-
6697
- These references map directly to bundle sections:
6698
-
6699
- - `utils: template-format` → Look for `==================== START: utils#template-format ====================`
6700
- - `tasks: create-story` → Look for `==================== START: tasks#create-story ====================`
6701
-
6702
- 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.
6703
-
6704
- 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.
6705
-
6706
- ---
6707
- ==================== END: templates#web-agent-startup-instructions-template ====================
6708
-
6709
6704
  ==================== START: checklists#architect-checklist ====================
6710
6705
  # Architect Solution Validation Checklist
6711
6706
 
@@ -8437,6 +8432,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
8437
8432
  - **Reusable Resources**: Portable templates, tasks, and checklists
8438
8433
  - **Slash Command Integration**: Quick agent switching and control
8439
8434
 
8435
+ ### When to Use BMAD
8436
+
8437
+ - **New Projects (Greenfield)**: Complete end-to-end development
8438
+ - **Existing Projects (Brownfield)**: Feature additions and enhancements
8439
+ - **Team Collaboration**: Multiple roles working together
8440
+ - **Quality Assurance**: Structured testing and validation
8441
+ - **Documentation**: Professional PRDs, architecture docs, user stories
8442
+
8443
+ ## Getting Started
8444
+
8445
+ ### Quick Start Options
8446
+
8447
+ #### Option 1: Web UI
8448
+ **Best for**: ChatGPT, Claude, Gemini users who want to start immediately
8449
+
8450
+ 1. Navigate to `dist/teams/`
8451
+ 2. Copy `team-fullstack.txt` content
8452
+ 3. Create new Gemini Gem or CustomGPT
8453
+ 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
8454
+ 5. Type `/help` to see available commands
8455
+
8456
+ #### Option 2: IDE Integration
8457
+ **Best for**: Cursor, Claude Code, Windsurf, VS Code users
8458
+
8459
+ ```bash
8460
+ # Interactive installation (recommended)
8461
+ npx bmad-method install
8462
+ ```
8463
+
8464
+ **Installation Steps**:
8465
+ - Choose "Complete installation"
8466
+ - Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
8467
+
8468
+ **Verify Installation**:
8469
+ - `.bmad-core/` folder created with all agents
8470
+ - IDE-specific integration files created
8471
+ - All agent commands/rules/modes available
8472
+
8473
+ ### Environment Selection Guide
8474
+
8475
+ **Use Web UI for**:
8476
+ - Initial planning and documentation (PRD, architecture)
8477
+ - Cost-effective document creation (especially with Gemini)
8478
+ - Brainstorming and analysis phases
8479
+ - Multi-agent consultation and planning
8480
+
8481
+ **Use IDE for**:
8482
+ - Active development and coding
8483
+ - File operations and project integration
8484
+ - Document sharding and story management
8485
+ - Implementation workflow (SM/Dev cycles)
8486
+
8487
+ **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.
8488
+
8440
8489
  ## Core Philosophy
8441
8490
 
8442
8491
  ### Vibe CEO'ing
@@ -8458,18 +8507,345 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
8458
8507
  7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
8459
8508
  8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
8460
8509
 
8461
- ## IDE Development Workflow
8510
+ ### Key Workflow Principles
8511
+
8512
+ 1. **Agent Specialization**: Each agent has specific expertise and responsibilities
8513
+ 2. **Clean Handoffs**: Always start fresh when switching between agents
8514
+ 3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
8515
+ 4. **Iterative Development**: Complete one story before starting the next
8516
+ 5. **Documentation First**: Always start with solid PRD and architecture
8517
+
8518
+ ## Agent System
8519
+
8520
+ ### Core Development Team
8521
+
8522
+ | Agent | Role | Primary Functions | When to Use |
8523
+ | ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
8524
+ | `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
8525
+ | `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
8526
+ | `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
8527
+ | `dev` | Developer | Code implementation, debugging | All development tasks |
8528
+ | `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
8529
+ | `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
8530
+ | `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
8531
+ | `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
8532
+
8533
+ ### Meta Agents
8534
+
8535
+ | Agent | Role | Primary Functions | When to Use |
8536
+ | ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
8537
+ | `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
8538
+ | `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
8539
+
8540
+ ### Agent Interaction Commands
8541
+
8542
+ #### IDE-Specific Syntax
8543
+
8544
+ **Agent Loading by IDE**:
8545
+ - **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
8546
+ - **Cursor**: `@agent-name` (e.g., `@bmad-master`)
8547
+ - **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
8548
+ - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
8549
+
8550
+ **Chat Management Guidelines**:
8551
+ - **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
8552
+ - **Roo Code**: Switch modes within the same conversation
8553
+
8554
+ **Common Task Commands**:
8555
+ - `*help` - Show available commands
8556
+ - `*status` - Show current context/progress
8557
+ - `*exit` - Exit the agent mode
8558
+ - `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
8559
+ - `*shard-doc docs/architecture.md architecture` - Shard architecture document
8560
+ - `*create` - Run create-next-story task (SM agent)
8561
+
8562
+ **In Web UI**:
8563
+ ```text
8564
+ /pm create-doc prd
8565
+ /architect review system design
8566
+ /dev implement story 1.2
8567
+ /help - Show available commands
8568
+ /switch agent-name - Change active agent (if orchestrator available)
8569
+ ```
8570
+
8571
+ ## Team Configurations
8572
+
8573
+ ### Pre-Built Teams
8574
+
8575
+ #### Team All
8576
+ - **Includes**: All 10 agents + orchestrator
8577
+ - **Use Case**: Complete projects requiring all roles
8578
+ - **Bundle**: `team-all.txt`
8579
+
8580
+ #### Team Fullstack
8581
+ - **Includes**: PM, Architect, Developer, QA, UX Expert
8582
+ - **Use Case**: End-to-end web/mobile development
8583
+ - **Bundle**: `team-fullstack.txt`
8584
+
8585
+ #### Team No-UI
8586
+ - **Includes**: PM, Architect, Developer, QA (no UX Expert)
8587
+ - **Use Case**: Backend services, APIs, system development
8588
+ - **Bundle**: `team-no-ui.txt`
8589
+
8590
+ ## Core Architecture
8591
+
8592
+ ### System Overview
8593
+
8594
+ 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).
8595
+
8596
+ ### Key Architectural Components
8597
+
8598
+ #### 1. Agents (`bmad-core/agents/`)
8599
+ - **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
8600
+ - **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
8601
+ - **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
8602
+ - **Startup Instructions**: Can load project-specific documentation for immediate context
8603
+
8604
+ #### 2. Agent Teams (`bmad-core/agent-teams/`)
8605
+ - **Purpose**: Define collections of agents bundled together for specific purposes
8606
+ - **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
8607
+ - **Usage**: Creates pre-packaged contexts for web UI environments
8608
+
8609
+ #### 3. Workflows (`bmad-core/workflows/`)
8610
+ - **Purpose**: YAML files defining prescribed sequences of steps for specific project types
8611
+ - **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
8612
+ - **Structure**: Defines agent interactions, artifacts created, and transition conditions
8613
+
8614
+ #### 4. Reusable Resources
8615
+ - **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
8616
+ - **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
8617
+ - **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
8618
+ - **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
8619
+
8620
+ ### Dual Environment Architecture
8621
+
8622
+ #### IDE Environment
8623
+
8624
+ - Users interact directly with agent markdown files
8625
+ - Agents can access all dependencies dynamically
8626
+ - Supports real-time file operations and project integration
8627
+ - Optimized for development workflow execution
8628
+
8629
+ #### Web UI Environment
8630
+
8631
+ - Uses pre-built bundles from `dist/teams` for stand alone 1 upload files for all agents and their assest with an orchestrating agent
8632
+ - 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
8633
+ - Created by the web-builder tool for upload to web interfaces
8634
+ - Provides complete context in one package
8635
+
8636
+ ### Template Processing System
8637
+
8638
+ BMAD employs a sophisticated template system with three key components:
8639
+
8640
+ 1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
8641
+ 2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
8642
+ 3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
8643
+
8644
+ **Template Features**:
8645
+
8646
+ - **Self-contained**: Templates embed both output structure and processing instructions
8647
+ - **Variable Substitution**: `{{placeholders}}` for dynamic content
8648
+ - **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
8649
+ - **Interactive Refinement**: Built-in elicitation processes for quality improvement
8650
+
8651
+ ### Technical Preferences Integration
8652
+
8653
+ The `technical-preferences.md` file serves as a persistent technical profile that:
8654
+ - Ensures consistency across all agents and projects
8655
+ - Eliminates repetitive technology specification
8656
+ - Provides personalized recommendations aligned with user preferences
8657
+ - Evolves over time with lessons learned
8658
+
8659
+ ### Build and Delivery Process
8660
+
8661
+ The `web-builder.js` tool creates web-ready bundles by:
8662
+ 1. Reading agent or team definition files
8663
+ 2. Recursively resolving all dependencies
8664
+ 3. Concatenating content into single text files with clear separators
8665
+ 4. Outputting ready-to-upload bundles for web AI interfaces
8666
+
8667
+ This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
8668
+
8669
+ ## Complete Development Workflow
8670
+
8671
+ ### Planning Phase (Web UI Recommended)
8672
+
8673
+ **Ideal for cost efficiency, especially with Gemini:**
8674
+
8675
+ 1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
8676
+ 2. **Project Brief**: Create foundation document (Analyst or user)
8677
+ 3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
8678
+ 4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
8679
+ 5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
8680
+ 6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
8681
+
8682
+ #### Example Planning Prompts
8683
+
8684
+ **For PRD Creation**:
8685
+ ```text
8686
+ "I want to build a [type] application that [core purpose].
8687
+ Help me brainstorm features and create a comprehensive PRD."
8688
+ ```
8689
+
8690
+ **For Architecture Design**:
8691
+ ```text
8692
+ "Based on this PRD, design a scalable technical architecture
8693
+ that can handle [specific requirements]."
8694
+ ```
8695
+
8696
+ ### Critical Transition: Web UI to IDE
8697
+
8698
+ **Once planning is complete, you MUST switch to IDE for development:**
8699
+
8700
+ - **Why**: Development workflow requires file operations, real-time project integration, and document sharding
8701
+ - **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
8702
+ - **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
8703
+
8704
+ ### IDE Development Workflow
8705
+
8706
+ **Prerequisites**: Planning documents must exist in `docs/` folder
8707
+
8708
+ 1. **Document Sharding**:
8709
+ - `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
8710
+ - If architecture exists, shard to `docs/architecture/` folder
8711
+ - Results in multiple manageable documents and epic files
8712
+
8713
+ 2. **Verify Sharded Content**:
8714
+ - At least one `epic-n.md` file in `docs/prd/` with stories in development order
8715
+ - Source tree document and coding standards for dev agent reference
8716
+ - Sharded docs for SM agent story creation
8717
+
8718
+ **Resulting Folder Structure**:
8719
+ - `docs/prd/` - Broken down PRD sections
8720
+ - `docs/architecture/` - Broken down architecture sections
8721
+ - `docs/stories/` - Generated user stories
8722
+
8723
+ 3. **Development Cycle** (Sequential, one story at a time):
8724
+
8725
+ **Step 1 - Story Creation**: New chat window → `@sm` → `*create`
8726
+ - SM executes create-next-story task
8727
+ - Review generated story in `docs/stories/`
8728
+ - Update status from "Draft" to "Approved"
8729
+
8730
+ **Step 2 - Story Implementation**: New chat window → `@dev`
8731
+ - Agent asks which story to implement
8732
+ - Include story file content to save dev agent lookup time
8733
+ - Dev follows tasks/subtasks, marking completion
8734
+ - Dev leaves notes for SM about any deviations
8735
+ - Update status to "Done"
8736
+
8737
+ **Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
8738
+
8739
+ **Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
8740
+
8741
+ ### Status Tracking Workflow
8742
+
8743
+ Stories progress through defined statuses:
8744
+ - **Draft** → **Approved** → **InProgress** → **Done**
8745
+
8746
+ Each status change requires user verification and approval before proceeding.
8747
+
8748
+ ### Workflow Types
8749
+
8750
+ #### Greenfield Development
8751
+ - Business analysis and market research
8752
+ - Product requirements and feature definition
8753
+ - System architecture and design
8754
+ - Development execution
8755
+ - Testing and deployment
8756
+
8757
+ #### Brownfield Enhancement
8758
+ - Current system analysis
8759
+ - Enhancement planning
8760
+ - Impact assessment
8761
+ - Incremental development
8762
+ - Integration testing
8763
+
8764
+ ## Document Creation Best Practices
8765
+
8766
+ ### Required File Naming for Framework Integration
8767
+
8768
+ - `docs/prd.md` - Product Requirements Document
8769
+ - `docs/architecture.md` - System Architecture Document
8770
+
8771
+ **Why These Names Matter**:
8772
+ - Agents automatically reference these files during development
8773
+ - Sharding tasks expect these specific filenames
8774
+ - Workflow automation depends on standard naming
8775
+
8776
+ ### Cost-Effective Document Creation Workflow
8777
+
8778
+ **Recommended for Large Documents (PRD, Architecture):**
8779
+
8780
+ 1. **Use Web UI**: Create documents in web interface for cost efficiency
8781
+ 2. **Copy Final Output**: Save complete markdown to your project
8782
+ 3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
8783
+ 4. **Switch to IDE**: Use IDE agents for development and smaller documents
8784
+
8785
+ ### Document Sharding
8786
+
8787
+ Templates with Level 2 headings (`##`) can be automatically sharded:
8788
+
8789
+ **Original PRD**:
8790
+ ```markdown
8791
+ ## Goals and Background Context
8792
+ ## Requirements
8793
+ ## User Interface Design Goals
8794
+ ## Success Metrics
8795
+ ```
8796
+
8797
+ **After Sharding**:
8798
+ - `docs/prd/goals-and-background-context.md`
8799
+ - `docs/prd/requirements.md`
8800
+ - `docs/prd/user-interface-design-goals.md`
8801
+ - `docs/prd/success-metrics.md`
8802
+
8803
+ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
8804
+
8805
+ ## Usage Patterns and Best Practices
8806
+
8807
+ ### Environment-Specific Usage
8808
+
8809
+ **Web UI Best For**:
8810
+ - Initial planning and documentation phases
8811
+ - Cost-effective large document creation
8812
+ - Agent consultation and brainstorming
8813
+ - Multi-agent workflows with orchestrator
8814
+
8815
+ **IDE Best For**:
8816
+ - Active development and implementation
8817
+ - File operations and project integration
8818
+ - Story management and development cycles
8819
+ - Code review and debugging
8820
+
8821
+ ### Quality Assurance
8822
+
8823
+ - Use appropriate agents for specialized tasks
8824
+ - Follow Agile ceremonies and review processes
8825
+ - Maintain document consistency with PO agent
8826
+ - Regular validation with checklists and templates
8827
+
8828
+ ### Performance Optimization
8829
+
8830
+ - Use specific agents vs. `bmad-master` for focused tasks
8831
+ - Choose appropriate team size for project needs
8832
+ - Leverage technical preferences for consistency
8833
+ - Regular context management and cache clearing
8834
+
8835
+ ## Success Tips
8836
+
8837
+ - **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
8838
+ - **Use bmad-master for document organization** - Sharding creates manageable chunks
8839
+ - **Follow the SM → Dev cycle religiously** - This ensures systematic progress
8840
+ - **Keep conversations focused** - One agent, one task per conversation
8841
+ - **Review everything** - Always review and approve before marking complete
8462
8842
 
8463
- 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.
8464
- 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.
8465
- 3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
8466
- 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.
8467
- 5. Use a new chat window to allow the SM agent to `draft the next story`.
8468
- 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.
8469
- 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.
8470
- 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.
8843
+ ## Getting Help
8471
8844
 
8472
- With this work flow, there is only 1 story in progress at a time, worked sequentially.
8845
+ - **Commands**: Use `/help` in any environment to see available commands
8846
+ - **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
8847
+ - **Documentation**: Check `docs/` folder for project-specific context
8848
+ - **Community**: Discord and GitHub resources available for support
8473
8849
  ==================== END: data#bmad-kb ====================
8474
8850
 
8475
8851
  ==================== START: data#technical-preferences ====================