bmad-method 4.21.0 → 4.21.2
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/CHANGELOG.md +14 -0
- package/README.md +42 -18
- package/common/tasks/create-doc.md +45 -48
- package/package.json +1 -1
- package/tools/installer/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
|
1
|
+
## [4.21.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.1...v4.21.2) (2025-06-30)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* improve create-doc task clarity for template execution ([86d5139](https://github.com/bmadcode/BMAD-METHOD/commit/86d5139aea7097cc5d4ee9da0f7d3e395ce0835e))
|
|
7
|
+
|
|
8
|
+
## [4.21.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.0...v4.21.1) (2025-06-30)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* readme clarifies that the installer handles installs upgrades and expansion installation ([9371a57](https://github.com/bmadcode/BMAD-METHOD/commit/9371a5784f6a6f2ad358a72ea0cde9c980357167))
|
|
14
|
+
|
|
1
15
|
# [4.21.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.20.0...v4.21.0) (2025-06-30)
|
|
2
16
|
|
|
3
17
|
|
package/README.md
CHANGED
|
@@ -71,30 +71,42 @@ This makes it easy to benefit from the latest improvements, bug fixes, and new a
|
|
|
71
71
|
|
|
72
72
|
## 🚀 Quick Start
|
|
73
73
|
|
|
74
|
-
###
|
|
74
|
+
### One Command for Everything (IDE Installation)
|
|
75
|
+
|
|
76
|
+
**Just run one of these commands:**
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npx bmad-method install
|
|
80
|
+
# OR if you already have BMad installed:
|
|
81
|
+
npm run install:bmad
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
This single command handles:
|
|
85
|
+
|
|
86
|
+
- **New installations** - Sets up BMad in your project
|
|
87
|
+
- **Upgrades** - Updates existing installations automatically
|
|
88
|
+
- **Expansion packs** - Installs any expansion packs you've added to package.json
|
|
89
|
+
|
|
90
|
+
> **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.
|
|
91
|
+
|
|
92
|
+
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
|
|
93
|
+
|
|
94
|
+
### Fastest Start: Web UI (2 minutes)
|
|
75
95
|
|
|
76
96
|
1. **Get the bundle**: Copy `dist/teams/team-fullstack.txt` (from this repository)
|
|
77
97
|
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
|
78
98
|
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
79
99
|
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
|
|
80
100
|
|
|
81
|
-
>
|
|
82
|
-
|
|
83
|
-
### IDE Quick Start (5 minutes) 💻
|
|
101
|
+
> **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
|
|
84
102
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
Run `npx bmad-method install`
|
|
88
|
-
|
|
89
|
-
OR
|
|
103
|
+
### Alternative: Clone and Build
|
|
90
104
|
|
|
91
105
|
```bash
|
|
92
106
|
git clone https://github.com/bmadcode/bmad-method.git
|
|
93
107
|
npm run install:bmad # build and install all to a destination folder
|
|
94
108
|
```
|
|
95
109
|
|
|
96
|
-
This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
|
|
97
|
-
|
|
98
110
|
## Overview
|
|
99
111
|
|
|
100
112
|
The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain helping you really plan and execute on your vision while keeping the agents on the rails even through complex application plans.
|
|
@@ -103,7 +115,25 @@ Unlike systems like Task Master, or inbuilt Task tool, the BMad Methods agile fl
|
|
|
103
115
|
|
|
104
116
|
## Installation
|
|
105
117
|
|
|
106
|
-
### Method 1:
|
|
118
|
+
### Method 1: CLI Installer (For IDEs)
|
|
119
|
+
|
|
120
|
+
**Just run one command:**
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
npx bmad-method install
|
|
124
|
+
# OR if you already have BMad installed:
|
|
125
|
+
npm run install:bmad
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**This single command does everything:**
|
|
129
|
+
|
|
130
|
+
- Installs BMad for the first time
|
|
131
|
+
- Updates existing installations
|
|
132
|
+
- Adds any expansion packs from your package.json
|
|
133
|
+
|
|
134
|
+
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
|
135
|
+
|
|
136
|
+
### Method 2: Pre-Built Web Bundles (For Web UI)
|
|
107
137
|
|
|
108
138
|
For ChatGPT, Claude, or Gemini web interfaces:
|
|
109
139
|
|
|
@@ -114,12 +144,6 @@ For ChatGPT, Claude, or Gemini web interfaces:
|
|
|
114
144
|
3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
115
145
|
4. Type `/help` to see available commands
|
|
116
146
|
|
|
117
|
-
### Method 2: CLI Installer (For IDEs) 🎯
|
|
118
|
-
|
|
119
|
-
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
|
120
|
-
|
|
121
|
-
Install directly into your project: `npx bmad-method install`
|
|
122
|
-
|
|
123
147
|
**Supported IDEs:**
|
|
124
148
|
|
|
125
149
|
The BMad Method works with any IDE, but has built-in integration for:
|
|
@@ -2,73 +2,70 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## CRITICAL RULES
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
|
10
|
+
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
|
11
|
+
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
|
12
|
+
4. **WAIT for user input** - At review points and after elicitation tasks
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
## Execution Flow
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
### 1. Identify Template
|
|
14
17
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
@{/example}
|
|
18
|
+
- Load from `templates#*` or `{root}/templates directory`
|
|
19
|
+
- Agent-specific templates are listed in agent's dependencies
|
|
20
|
+
- If agent has `templates: [prd-tmpl, architecture-tmpl]`, offer to create "PRD" and "Architecture" documents
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
### 2. Ask Interaction Mode
|
|
21
23
|
|
|
22
|
-
|
|
23
|
-
-
|
|
24
|
-
|
|
25
|
-
### 2. Determine Interaction Mode
|
|
26
|
-
|
|
27
|
-
Confirm with the user their preferred interaction style:
|
|
28
|
-
|
|
29
|
-
- **Incremental:** Work through chunks of the document.
|
|
30
|
-
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
|
24
|
+
> 1. **Incremental** - Section by section with reviews
|
|
25
|
+
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
|
31
26
|
|
|
32
27
|
### 3. Execute Template
|
|
33
28
|
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
- Process
|
|
29
|
+
- Replace {{placeholders}} with real content
|
|
30
|
+
- Execute [[LLM:]] instructions as you encounter them
|
|
31
|
+
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
|
32
|
+
- Use @{examples} for guidance but never output them
|
|
37
33
|
|
|
38
|
-
### 4.
|
|
34
|
+
### 4. Key Execution Patterns
|
|
39
35
|
|
|
40
|
-
|
|
36
|
+
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
|
41
37
|
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
- Use @{examples} for guidance but never output them
|
|
38
|
+
- Draft the content
|
|
39
|
+
- Present it to user
|
|
40
|
+
- IMMEDIATELY execute the task
|
|
41
|
+
- Wait for completion before continuing
|
|
47
42
|
|
|
48
|
-
|
|
43
|
+
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
|
49
44
|
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
- Incorporate user feedback and iterate as needed
|
|
45
|
+
- Finish the section
|
|
46
|
+
- STOP and execute the task
|
|
47
|
+
- Wait for user input
|
|
54
48
|
|
|
55
|
-
###
|
|
49
|
+
### 5. Validation & Final Presentation
|
|
56
50
|
|
|
57
|
-
|
|
51
|
+
- Run any specified checklists
|
|
52
|
+
- Present clean, formatted content only
|
|
53
|
+
- No truncation or summarization
|
|
54
|
+
- Begin directly with content (no preamble)
|
|
55
|
+
- Include any handoff prompts from template
|
|
58
56
|
|
|
59
|
-
|
|
60
|
-
- Document completion status for each item
|
|
61
|
-
- Address any deficiencies found
|
|
62
|
-
- Present validation summary to user
|
|
57
|
+
## Common Mistakes to Avoid
|
|
63
58
|
|
|
64
|
-
|
|
59
|
+
❌ Skipping elicitation tasks
|
|
60
|
+
❌ Showing template markup to users
|
|
61
|
+
❌ Continuing past STOP signals
|
|
62
|
+
❌ Combining multiple review points
|
|
65
63
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
- Include any handoff prompts specified in template
|
|
64
|
+
✅ Execute ALL instructions in sequence
|
|
65
|
+
✅ Present only clean, formatted content
|
|
66
|
+
✅ Stop at every elicitation point
|
|
67
|
+
✅ Wait for user confirmation when instructed
|
|
71
68
|
|
|
72
|
-
##
|
|
69
|
+
## Remember
|
|
73
70
|
|
|
74
|
-
|
|
71
|
+
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
package/package.json
CHANGED