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.
- package/.prettierignore +0 -1
- package/CHANGELOG.md +24 -0
- package/README.md +18 -1
- package/bmad-core/agents/analyst.md +11 -8
- package/bmad-core/agents/architect.md +10 -7
- package/bmad-core/agents/bmad-master.md +13 -11
- package/bmad-core/agents/bmad-orchestrator.md +3 -0
- package/bmad-core/agents/dev.md +19 -14
- package/bmad-core/agents/pm.md +8 -5
- package/bmad-core/agents/po.md +13 -10
- package/bmad-core/agents/qa.md +8 -5
- package/bmad-core/agents/sm.md +15 -25
- package/bmad-core/agents/ux-expert.md +11 -8
- package/bmad-core/core-config.yml +24 -0
- package/bmad-core/data/bmad-kb.md +391 -10
- package/bmad-core/tasks/create-next-story.md +63 -45
- package/bmad-core/utils/file-resolution-context.md +10 -0
- package/dist/agents/analyst.txt +404 -17
- package/dist/agents/architect.txt +14 -6
- package/dist/agents/bmad-master.txt +485 -109
- package/dist/agents/bmad-orchestrator.txt +402 -22
- package/dist/agents/dev.txt +26 -34
- package/dist/agents/pm.txt +9 -5
- package/dist/agents/po.txt +10 -10
- package/dist/agents/qa.txt +4 -4
- package/dist/agents/sm.txt +74 -63
- package/dist/agents/ux-expert.txt +9 -7
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +49 -20
- package/dist/expansion-packs/expansion-creator/agents/bmad-the-creator.txt +6 -3
- package/dist/teams/team-all.txt +561 -158
- package/dist/teams/team-fullstack.txt +457 -57
- package/dist/teams/team-ide-minimal.txt +516 -133
- package/dist/teams/team-no-ui.txt +448 -50
- package/docs/bmad-workflow-guide.md +10 -8
- package/docs/claude-code-guide.md +1 -1
- package/docs/core-architecture.md +4 -4
- package/docs/cursor-guide.md +1 -1
- package/docs/roo-code-guide.md +1 -1
- package/docs/user-guide.md +30 -21
- package/docs/windsurf-guide.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +3 -0
- package/expansion-packs/expansion-creator/templates/agent-tmpl.md +4 -1
- package/package.json +1 -1
- package/tools/builders/web-builder.js +158 -94
- package/tools/installer/bin/bmad.js +34 -2
- package/tools/installer/lib/file-manager.js +3 -2
- package/tools/installer/lib/ide-setup.js +39 -123
- package/tools/installer/lib/installer.js +13 -1
- package/tools/installer/package.json +1 -1
- /package/bmad-core/{templates/web-agent-startup-instructions-template.md → utils/web-agent-startup-instructions.md} +0 -0
|
@@ -33,11 +33,13 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
|
|
|
33
33
|
|
|
34
34
|
Use Google's Gemini for collaborative planning with the full team:
|
|
35
35
|
|
|
36
|
-
1. **Open [Google
|
|
37
|
-
2. **
|
|
38
|
-
-
|
|
39
|
-
|
|
40
|
-
|
|
36
|
+
1. **Open [Google Gems](https://gemini.google.com/gems/view)**
|
|
37
|
+
2. **Create a new Gem**:
|
|
38
|
+
- Give it a title and description (e.g., "BMAD Team Fullstack")
|
|
39
|
+
3. **Load team-fullstack**:
|
|
40
|
+
- Copy contents of: `dist/teams/team-fullstack.txt` from your project
|
|
41
|
+
- Paste this content into the Gem setup to configure the team
|
|
42
|
+
4. **Collaborate with the team**:
|
|
41
43
|
- Business Analyst: Requirements gathering
|
|
42
44
|
- Product Manager: Feature prioritization
|
|
43
45
|
- Solution Architect: Technical design
|
|
@@ -53,9 +55,9 @@ Help me brainstorm features and create a comprehensive PRD."
|
|
|
53
55
|
that can handle [specific requirements]."
|
|
54
56
|
```
|
|
55
57
|
|
|
56
|
-
|
|
57
|
-
-
|
|
58
|
-
-
|
|
58
|
+
5. **Export planning documents**:
|
|
59
|
+
- Copy the PRD output and save as `docs/prd.md` in your project
|
|
60
|
+
- Copy the architecture output and save as `docs/architecture.md` in your project
|
|
59
61
|
|
|
60
62
|
### Phase 3: Document Organization (IDE)
|
|
61
63
|
|
|
@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
|
|
|
23
23
|
|
|
24
24
|
1. Open [Google gems](https://gemini.google.com/gems/view)
|
|
25
25
|
2. Create a new Gem - give it a title and description
|
|
26
|
-
3. Copy the contents of `.<install location
|
|
26
|
+
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.
|
|
27
27
|
4. Paste this content into Gemini to set up the team
|
|
28
28
|
|
|
29
29
|
### Gemini Planning Phase
|
|
@@ -35,7 +35,7 @@ graph TD
|
|
|
35
35
|
end
|
|
36
36
|
|
|
37
37
|
subgraph Outputs
|
|
38
|
-
J["
|
|
38
|
+
J["dist"]
|
|
39
39
|
end
|
|
40
40
|
|
|
41
41
|
B -- defines dependencies for --> E
|
|
@@ -133,17 +133,17 @@ The framework is designed for two primary environments: local IDEs and web-based
|
|
|
133
133
|
|
|
134
134
|
### 4.1. Web Builder (`tools/builders/web-builder.js`)
|
|
135
135
|
|
|
136
|
-
- **Purpose**: This Node.js script is responsible for creating the `.txt` bundles found in `.
|
|
136
|
+
- **Purpose**: This Node.js script is responsible for creating the `.txt` bundles found in `dist`.
|
|
137
137
|
- **Process**:
|
|
138
138
|
1. **Resolves Dependencies**: For a given agent or team, the script reads its definition file.
|
|
139
139
|
2. It recursively finds all dependent resources (tasks, templates, etc.) that the agent/team needs.
|
|
140
140
|
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.
|
|
141
|
-
4. **Outputs Bundle**: The final `.txt` file is saved in the `
|
|
141
|
+
4. **Outputs Bundle**: The final `.txt` file is saved in the `dist` directory, ready to be uploaded to a web UI.
|
|
142
142
|
|
|
143
143
|
### 4.2. Environment-Specific Usage
|
|
144
144
|
|
|
145
145
|
- **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.
|
|
146
|
-
- **For Web UIs**: Users upload a pre-built bundle from `.
|
|
146
|
+
- **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.
|
|
147
147
|
|
|
148
148
|
## 5. BMAD Workflows
|
|
149
149
|
|
package/docs/cursor-guide.md
CHANGED
|
@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
|
|
|
23
23
|
|
|
24
24
|
1. Open [Google gems](https://gemini.google.com/gems/view)
|
|
25
25
|
2. Create a new Gem - give it a title and description
|
|
26
|
-
3. Copy the contents of `.<install location
|
|
26
|
+
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.
|
|
27
27
|
4. Paste this content into Gemini to set up the team
|
|
28
28
|
|
|
29
29
|
### Gemini Planning Phase
|
package/docs/roo-code-guide.md
CHANGED
|
@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
|
|
|
23
23
|
|
|
24
24
|
1. Open [Google gems](https://gemini.google.com/gems/view)
|
|
25
25
|
2. Create a new Gem - give it a title and description
|
|
26
|
-
3. Copy the contents of `.<install location
|
|
26
|
+
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.
|
|
27
27
|
4. Paste this content into Gemini to set up the team
|
|
28
28
|
|
|
29
29
|
### Gemini Planning Phase
|
package/docs/user-guide.md
CHANGED
|
@@ -46,7 +46,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent
|
|
|
46
46
|
|
|
47
47
|
Best for: ChatGPT, Claude, Gemini users
|
|
48
48
|
|
|
49
|
-
1. Navigate to
|
|
49
|
+
1. Navigate to `dist/teams/`
|
|
50
50
|
2. Copy `team-fullstack.txt` content
|
|
51
51
|
3. Create new Gemini Gem or CustomGPT
|
|
52
52
|
4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
@@ -59,9 +59,6 @@ Best for: Cursor, Claude Code, Windsurf, VS Code users
|
|
|
59
59
|
````bash
|
|
60
60
|
# Interactive installation (recommended)
|
|
61
61
|
npx bmad-method install
|
|
62
|
-
|
|
63
|
-
# Command line installation
|
|
64
|
-
npx bmad-method install --full --directory ./my-project --ide cursor
|
|
65
62
|
```text
|
|
66
63
|
|
|
67
64
|
### First Steps
|
|
@@ -227,7 +224,7 @@ When working directly in IDEs:
|
|
|
227
224
|
|
|
228
225
|
Templates can include `advanced-elicitation.md` for enhanced interaction:
|
|
229
226
|
|
|
230
|
-
|
|
227
|
+
`````markdown
|
|
231
228
|
[[LLM: Use advanced-elicitation actions 0-3 to refine requirements]]
|
|
232
229
|
|
|
233
230
|
````text
|
|
@@ -272,7 +269,9 @@ graph TD
|
|
|
272
269
|
style L fill:#1a73e8,color:#fff
|
|
273
270
|
style N fill:#34a853,color:#fff
|
|
274
271
|
````
|
|
275
|
-
|
|
272
|
+
`````
|
|
273
|
+
|
|
274
|
+
`````
|
|
276
275
|
|
|
277
276
|
#### Web UI to IDE Transition
|
|
278
277
|
|
|
@@ -392,7 +391,7 @@ agents:
|
|
|
392
391
|
- qa
|
|
393
392
|
workflows:
|
|
394
393
|
- greenfield-fullstack
|
|
395
|
-
|
|
394
|
+
`````
|
|
396
395
|
|
|
397
396
|
## IDE Integration
|
|
398
397
|
|
|
@@ -544,7 +543,7 @@ BMAD's dependency system ensures agents only load necessary resources:
|
|
|
544
543
|
|
|
545
544
|
Create custom templates following `template-format.md`:
|
|
546
545
|
|
|
547
|
-
|
|
546
|
+
`````markdown
|
|
548
547
|
---
|
|
549
548
|
title: Custom Template
|
|
550
549
|
description: Your custom document type
|
|
@@ -596,7 +595,9 @@ phases:
|
|
|
596
595
|
- implementation
|
|
597
596
|
- tests
|
|
598
597
|
````
|
|
599
|
-
|
|
598
|
+
`````
|
|
599
|
+
|
|
600
|
+
`````
|
|
600
601
|
|
|
601
602
|
### Creating Custom Templates
|
|
602
603
|
|
|
@@ -647,8 +648,9 @@ Templates are self-contained documents that embed both output structure and proc
|
|
|
647
648
|
## User Interface Section
|
|
648
649
|
[[LLM: Only include for UI projects]]
|
|
649
650
|
^^/CONDITION^^
|
|
650
|
-
|
|
651
|
-
|
|
651
|
+
`````
|
|
652
|
+
|
|
653
|
+
`````
|
|
652
654
|
|
|
653
655
|
#### Document Sharding
|
|
654
656
|
|
|
@@ -702,8 +704,9 @@ Tasks are reusable automation instructions that agents can execute. They follow
|
|
|
702
704
|
## Examples
|
|
703
705
|
|
|
704
706
|
@{example: Concrete usage examples}
|
|
705
|
-
|
|
706
|
-
|
|
707
|
+
`````
|
|
708
|
+
|
|
709
|
+
`````
|
|
707
710
|
|
|
708
711
|
#### Task Patterns
|
|
709
712
|
|
|
@@ -718,8 +721,9 @@ Tasks are reusable automation instructions that agents can execute. They follow
|
|
|
718
721
|
**Advanced Elicitation:**
|
|
719
722
|
```markdown
|
|
720
723
|
[[LLM: Apply tasks#advanced-elicitation protocol after completion]]
|
|
721
|
-
|
|
722
|
-
|
|
724
|
+
`````
|
|
725
|
+
|
|
726
|
+
`````
|
|
723
727
|
|
|
724
728
|
**Conditional Logic:**
|
|
725
729
|
|
|
@@ -760,8 +764,9 @@ dependencies:
|
|
|
760
764
|
- custom-task.md
|
|
761
765
|
data:
|
|
762
766
|
- domain-knowledge.md
|
|
763
|
-
|
|
764
|
-
|
|
767
|
+
`````
|
|
768
|
+
|
|
769
|
+
`````
|
|
765
770
|
|
|
766
771
|
#### Agent Startup Instructions
|
|
767
772
|
|
|
@@ -793,7 +798,7 @@ Agents can reference and load documents from the `docs/` folder:
|
|
|
793
798
|
- docs/brand-guidelines.md for design consistency
|
|
794
799
|
- docs/third-party-apis/ for integration requirements
|
|
795
800
|
- Any project-specific documentation in docs/ folder]]
|
|
796
|
-
|
|
801
|
+
`````
|
|
797
802
|
|
|
798
803
|
### Technical Preferences System
|
|
799
804
|
|
|
@@ -807,7 +812,7 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|
|
807
812
|
|
|
808
813
|
**Technology Stack Preferences:**
|
|
809
814
|
|
|
810
|
-
|
|
815
|
+
`````markdown
|
|
811
816
|
## Preferred Technologies
|
|
812
817
|
|
|
813
818
|
### Frontend
|
|
@@ -842,7 +847,9 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|
|
842
847
|
- RESTful APIs with OpenAPI documentation
|
|
843
848
|
- Event-driven architecture for real-time features
|
|
844
849
|
````
|
|
845
|
-
|
|
850
|
+
`````
|
|
851
|
+
|
|
852
|
+
`````
|
|
846
853
|
|
|
847
854
|
**External Services & APIs:**
|
|
848
855
|
|
|
@@ -883,7 +890,8 @@ This file allows you to define your preferred technologies, patterns, and standa
|
|
|
883
890
|
- Want to try Framework A on next appropriate project
|
|
884
891
|
- Interested in Pattern B for microservices
|
|
885
892
|
- Consider Service C for better performance
|
|
886
|
-
|
|
893
|
+
`````
|
|
894
|
+
|
|
887
895
|
````
|
|
888
896
|
|
|
889
897
|
#### Using with Web Bundles
|
|
@@ -1042,3 +1050,4 @@ Remember: BMAD is designed to enhance your development process, not replace your
|
|
|
1042
1050
|
---
|
|
1043
1051
|
|
|
1044
1052
|
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.
|
|
1053
|
+
````
|
package/docs/windsurf-guide.md
CHANGED
|
@@ -23,7 +23,7 @@ For ideation and planning, use Google's Gemini Custom Gem with the team-fullstac
|
|
|
23
23
|
|
|
24
24
|
1. Open [Google gems](https://gemini.google.com/gems/view)
|
|
25
25
|
2. Create a new Gem - give it a title and description
|
|
26
|
-
3. Copy the contents of `.<install location
|
|
26
|
+
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.
|
|
27
27
|
4. Paste this content into Gemini to set up the team
|
|
28
28
|
|
|
29
29
|
### Gemini Planning Phase
|
|
@@ -16,6 +16,7 @@ activation-instructions:
|
|
|
16
16
|
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
|
|
17
17
|
- The customization field ALWAYS takes precedence over any conflicting instructions
|
|
18
18
|
- 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
|
|
19
|
+
- Command
|
|
19
20
|
|
|
20
21
|
agent:
|
|
21
22
|
name: [AGENT_NAME]
|
|
@@ -36,7 +37,9 @@ persona:
|
|
|
36
37
|
# Add more principles as needed
|
|
37
38
|
|
|
38
39
|
startup:
|
|
39
|
-
-
|
|
40
|
+
- Greet the user with your name and role, and inform of the *help command.
|
|
41
|
+
- [STARTUP_INSTRUCTION]
|
|
42
|
+
- [STARTUP_INSTRUCTION]...
|
|
40
43
|
|
|
41
44
|
commands:
|
|
42
45
|
- "*help" - Show: numbered list of the following commands to allow selection
|