bmad-method 4.6.2 → 4.7.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/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ # [4.7.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.3...v4.7.0) (2025-06-19)
2
+
3
+
4
+ ### Features
5
+
6
+ * extensive bmad-kb for web orchestrator to be much more helpful ([e663a11](https://github.com/bmadcode/BMAD-METHOD/commit/e663a1146b89e7b5078d9726649a51ae5624da46))
7
+
8
+ ## [4.6.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.2...v4.6.3) (2025-06-19)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * SM fixed file resolution issue in v4 ([61ab116](https://github.com/bmadcode/BMAD-METHOD/commit/61ab1161e59a92d657ab663082abcaf26729fa6b))
14
+
1
15
  ## [4.6.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.6.1...v4.6.2) (2025-06-19)
2
16
 
3
17
 
@@ -2,6 +2,12 @@
2
2
 
3
3
  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:
4
4
 
5
+ ## Task and File Resolution
6
+
7
+ `Create Next Story`: `.bmad-core/tasks/create-next-story.md`
8
+ `story-tmpl`: `.bmad-core/templates/story-tmpl.md`
9
+ `story-draft-checklist`: `.bmad-core/checklists/story-draft-checklist.md`
10
+
5
11
  ```yaml
6
12
  activation-instructions:
7
13
  - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
@@ -21,14 +27,14 @@ persona:
21
27
  identity: Story creation expert who prepares detailed, actionable stories for AI developers
22
28
  focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
23
29
  core_principles:
24
- - Task Adherence - Rigorously follow create-next-story procedures
30
+ - Task Adherence - Rigorously follow `Create Next Story` procedures
25
31
  - Checklist-Driven Validation - Apply story-draft-checklist meticulously
26
32
  - Clarity for Developer Handoff - Stories must be immediately actionable
27
33
  - Focus on One Story at a Time - Complete one before starting next
28
34
  - Numbered Options Protocol - Always use numbered lists for selections
29
35
  startup:
30
36
  - Greet the user with your name and role, and inform of the *help command.
31
- - CRITICAL: Do NOT automatically execute create-next-story tasks during startup
37
+ - CRITICAL: Do NOT automatically execute `Create Next Story` tasks during startup
32
38
  - CRITICAL: Do NOT create or modify any files during startup
33
39
  - Offer to help with story preparation but wait for explicit user confirmation
34
40
  - Only execute tasks when user explicitly requests them
@@ -36,7 +42,7 @@ startup:
36
42
  commands:
37
43
  - '*help" - Show: numbered list of the following commands to allow selection'
38
44
  - '*chat-mode" - Conversational mode with advanced-elicitation for advice'
39
- - '*create" - Execute all steps in Create Next Story Task document'
45
+ - '*create" - Execute all steps in `Create Next Story`'
40
46
  - '*pivot" - Run correct-course task (ensure no story already created first)'
41
47
  - '*checklist {checklist}" - Show numbered list of checklists, execute selection'
42
48
  - '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
@@ -12,6 +12,60 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
12
12
  - **Reusable Resources**: Portable templates, tasks, and checklists
13
13
  - **Slash Command Integration**: Quick agent switching and control
14
14
 
15
+ ### When to Use BMAD
16
+
17
+ - **New Projects (Greenfield)**: Complete end-to-end development
18
+ - **Existing Projects (Brownfield)**: Feature additions and enhancements
19
+ - **Team Collaboration**: Multiple roles working together
20
+ - **Quality Assurance**: Structured testing and validation
21
+ - **Documentation**: Professional PRDs, architecture docs, user stories
22
+
23
+ ## Getting Started
24
+
25
+ ### Quick Start Options
26
+
27
+ #### Option 1: Web UI
28
+ **Best for**: ChatGPT, Claude, Gemini users who want to start immediately
29
+
30
+ 1. Navigate to `.bmad-core/web-bundles/teams/`
31
+ 2. Copy `team-fullstack.txt` content
32
+ 3. Create new Gemini Gem or CustomGPT
33
+ 4. Upload file with instructions: "Your critical operating instructions are attached, do not break character as directed"
34
+ 5. Type `/help` to see available commands
35
+
36
+ #### Option 2: IDE Integration
37
+ **Best for**: Cursor, Claude Code, Windsurf, VS Code users
38
+
39
+ ```bash
40
+ # Interactive installation (recommended)
41
+ npx bmad-method install
42
+ ```
43
+
44
+ **Installation Steps**:
45
+ - Choose "Complete installation"
46
+ - Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
47
+
48
+ **Verify Installation**:
49
+ - `.bmad-core/` folder created with all agents
50
+ - IDE-specific integration files created
51
+ - All agent commands/rules/modes available
52
+
53
+ ### Environment Selection Guide
54
+
55
+ **Use Web UI for**:
56
+ - Initial planning and documentation (PRD, architecture)
57
+ - Cost-effective document creation (especially with Gemini)
58
+ - Brainstorming and analysis phases
59
+ - Multi-agent consultation and planning
60
+
61
+ **Use IDE for**:
62
+ - Active development and coding
63
+ - File operations and project integration
64
+ - Document sharding and story management
65
+ - Implementation workflow (SM/Dev cycles)
66
+
67
+ **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.
68
+
15
69
  ## Core Philosophy
16
70
 
17
71
  ### Vibe CEO'ing
@@ -33,15 +87,339 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
33
87
  7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
34
88
  8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
35
89
 
36
- ## IDE Development Workflow
90
+ ### Key Workflow Principles
91
+
92
+ 1. **Agent Specialization**: Each agent has specific expertise and responsibilities
93
+ 2. **Clean Handoffs**: Always start fresh when switching between agents
94
+ 3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
95
+ 4. **Iterative Development**: Complete one story before starting the next
96
+ 5. **Documentation First**: Always start with solid PRD and architecture
97
+
98
+ ## Agent System
99
+
100
+ ### Core Development Team
101
+
102
+ | Agent | Role | Primary Functions | When to Use |
103
+ | ----------- | ------------------ | --------------------------------------- | -------------------------------------- |
104
+ | `analyst` | Business Analyst | Market research, requirements gathering | Project planning, competitive analysis |
105
+ | `pm` | Product Manager | PRD creation, feature prioritization | Strategic planning, roadmaps |
106
+ | `architect` | Solution Architect | System design, technical architecture | Complex systems, scalability planning |
107
+ | `dev` | Developer | Code implementation, debugging | All development tasks |
108
+ | `qa` | QA Specialist | Test planning, quality assurance | Testing strategies, bug validation |
109
+ | `ux-expert` | UX Designer | UI/UX design, prototypes | User experience, interface design |
110
+ | `po` | Product Owner | Backlog management, story validation | Story refinement, acceptance criteria |
111
+ | `sm` | Scrum Master | Sprint planning, story creation | Project management, workflow |
112
+
113
+ ### Meta Agents
114
+
115
+ | Agent | Role | Primary Functions | When to Use |
116
+ | ------------------- | ---------------- | ------------------------------------- | --------------------------------- |
117
+ | `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching | Complex multi-role tasks |
118
+ | `bmad-master` | Universal Expert | All capabilities without switching | Single-session comprehensive work |
119
+
120
+ ### Agent Interaction Commands
121
+
122
+ #### IDE-Specific Syntax
123
+
124
+ **Agent Loading by IDE**:
125
+ - **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
126
+ - **Cursor**: `@agent-name` (e.g., `@bmad-master`)
127
+ - **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
128
+ - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
129
+
130
+ **Chat Management Guidelines**:
131
+ - **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
132
+ - **Roo Code**: Switch modes within the same conversation
133
+
134
+ **Common Task Commands**:
135
+ - `*help` - Show available commands
136
+ - `*status` - Show current context/progress
137
+ - `*exit` - Exit the agent mode
138
+ - `*shard-doc docs/prd.md prd` - Shard PRD into manageable pieces
139
+ - `*shard-doc docs/architecture.md architecture` - Shard architecture document
140
+ - `*create` - Run create-next-story task (SM agent)
141
+
142
+ **In Web UI**:
143
+ ```text
144
+ /pm create-doc prd
145
+ /architect review system design
146
+ /dev implement story 1.2
147
+ /help - Show available commands
148
+ /switch agent-name - Change active agent (if orchestrator available)
149
+ ```
150
+
151
+ ## Team Configurations
152
+
153
+ ### Pre-Built Teams
154
+
155
+ #### Team All
156
+ - **Includes**: All 10 agents + orchestrator
157
+ - **Use Case**: Complete projects requiring all roles
158
+ - **Bundle**: `team-all.txt`
159
+
160
+ #### Team Fullstack
161
+ - **Includes**: PM, Architect, Developer, QA, UX Expert
162
+ - **Use Case**: End-to-end web/mobile development
163
+ - **Bundle**: `team-fullstack.txt`
164
+
165
+ #### Team No-UI
166
+ - **Includes**: PM, Architect, Developer, QA (no UX Expert)
167
+ - **Use Case**: Backend services, APIs, system development
168
+ - **Bundle**: `team-no-ui.txt`
169
+
170
+ ## Core Architecture
171
+
172
+ ### System Overview
173
+
174
+ 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).
175
+
176
+ ### Key Architectural Components
177
+
178
+ #### 1. Agents (`bmad-core/agents/`)
179
+ - **Purpose**: Each markdown file defines a specialized AI agent for a specific Agile role (PM, Dev, Architect, etc.)
180
+ - **Structure**: Contains YAML headers specifying the agent's persona, capabilities, and dependencies
181
+ - **Dependencies**: Lists of tasks, templates, checklists, and data files the agent can use
182
+ - **Startup Instructions**: Can load project-specific documentation for immediate context
183
+
184
+ #### 2. Agent Teams (`bmad-core/agent-teams/`)
185
+ - **Purpose**: Define collections of agents bundled together for specific purposes
186
+ - **Examples**: `team-all.yml` (comprehensive bundle), `team-fullstack.yml` (full-stack development)
187
+ - **Usage**: Creates pre-packaged contexts for web UI environments
188
+
189
+ #### 3. Workflows (`bmad-core/workflows/`)
190
+ - **Purpose**: YAML files defining prescribed sequences of steps for specific project types
191
+ - **Types**: Greenfield (new projects) and Brownfield (existing projects) for UI, service, and fullstack development
192
+ - **Structure**: Defines agent interactions, artifacts created, and transition conditions
193
+
194
+ #### 4. Reusable Resources
195
+ - **Templates** (`bmad-core/templates/`): Markdown templates for PRDs, architecture specs, user stories
196
+ - **Tasks** (`bmad-core/tasks/`): Instructions for specific repeatable actions like "shard-doc" or "create-next-story"
197
+ - **Checklists** (`bmad-core/checklists/`): Quality assurance checklists for validation and review
198
+ - **Data** (`bmad-core/data/`): Core knowledge base and technical preferences
199
+
200
+ ### Dual Environment Architecture
201
+
202
+ #### IDE Environment
203
+ - Users interact directly with agent markdown files
204
+ - Agents can access all dependencies dynamically
205
+ - Supports real-time file operations and project integration
206
+ - Optimized for development workflow execution
207
+
208
+ #### Web UI Environment
209
+ - Uses pre-built bundles from `bmad-core/web-bundles/`
210
+ - Single text files containing all agent dependencies
211
+ - Created by the web-builder tool for upload to web interfaces
212
+ - Provides complete context in one package
213
+
214
+ ### Template Processing System
215
+
216
+ BMAD employs a sophisticated template system with three key components:
217
+
218
+ 1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
219
+ 2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
220
+ 3. **Advanced Elicitation** (`tasks/advanced-elicitation.md`): Provides interactive refinement through structured brainstorming
221
+
222
+ **Template Features**:
223
+ - **Self-contained**: Templates embed both output structure and processing instructions
224
+ - **Variable Substitution**: `{{placeholders}}` for dynamic content
225
+ - **AI Processing Directives**: `[[LLM: instructions]]` for AI-only processing
226
+ - **Interactive Refinement**: Built-in elicitation processes for quality improvement
227
+
228
+ ### Technical Preferences Integration
229
+
230
+ The `technical-preferences.md` file serves as a persistent technical profile that:
231
+ - Ensures consistency across all agents and projects
232
+ - Eliminates repetitive technology specification
233
+ - Provides personalized recommendations aligned with user preferences
234
+ - Evolves over time with lessons learned
235
+
236
+ ### Build and Delivery Process
237
+
238
+ The `web-builder.js` tool creates web-ready bundles by:
239
+ 1. Reading agent or team definition files
240
+ 2. Recursively resolving all dependencies
241
+ 3. Concatenating content into single text files with clear separators
242
+ 4. Outputting ready-to-upload bundles for web AI interfaces
243
+
244
+ This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
245
+
246
+ ## Complete Development Workflow
247
+
248
+ ### Planning Phase (Web UI Recommended)
249
+
250
+ **Ideal for cost efficiency, especially with Gemini:**
251
+
252
+ 1. **Optional Analysis**: `/analyst` - Market research, competitive analysis
253
+ 2. **Project Brief**: Create foundation document (Analyst or user)
254
+ 3. **PRD Creation**: `/pm create-doc prd` - Comprehensive product requirements
255
+ 4. **Architecture Design**: `/architect create-doc architecture` - Technical foundation
256
+ 5. **Validation & Alignment**: `/po` run master checklist to ensure document consistency
257
+ 6. **Document Preparation**: Copy final documents to project as `docs/prd.md` and `docs/architecture.md`
258
+
259
+ #### Example Planning Prompts
260
+
261
+ **For PRD Creation**:
262
+ ```text
263
+ "I want to build a [type] application that [core purpose].
264
+ Help me brainstorm features and create a comprehensive PRD."
265
+ ```
266
+
267
+ **For Architecture Design**:
268
+ ```text
269
+ "Based on this PRD, design a scalable technical architecture
270
+ that can handle [specific requirements]."
271
+ ```
272
+
273
+ ### Critical Transition: Web UI to IDE
274
+
275
+ **Once planning is complete, you MUST switch to IDE for development:**
276
+
277
+ - **Why**: Development workflow requires file operations, real-time project integration, and document sharding
278
+ - **Cost Benefit**: Web UI is more cost-effective for large document creation; IDE is optimized for development tasks
279
+ - **Required Files**: Ensure `docs/prd.md` and `docs/architecture.md` exist in your project
280
+
281
+ ### IDE Development Workflow
282
+
283
+ **Prerequisites**: Planning documents must exist in `docs/` folder
284
+
285
+ 1. **Document Sharding**:
286
+ - `@bmad-master` or `@po` shard `docs/prd.md` to `docs/prd/` folder
287
+ - If architecture exists, shard to `docs/architecture/` folder
288
+ - Results in multiple manageable documents and epic files
289
+
290
+ 2. **Verify Sharded Content**:
291
+ - At least one `epic-n.md` file in `docs/prd/` with stories in development order
292
+ - Source tree document and coding standards for dev agent reference
293
+ - Sharded docs for SM agent story creation
294
+
295
+ **Resulting Folder Structure**:
296
+ - `docs/prd/` - Broken down PRD sections
297
+ - `docs/architecture/` - Broken down architecture sections
298
+ - `docs/stories/` - Generated user stories
299
+
300
+ 3. **Development Cycle** (Sequential, one story at a time):
301
+
302
+ **Step 1 - Story Creation**: New chat window → `@sm` → `*create`
303
+ - SM executes create-next-story task
304
+ - Review generated story in `docs/stories/`
305
+ - Update status from "Draft" to "Approved"
306
+
307
+ **Step 2 - Story Implementation**: New chat window → `@dev`
308
+ - Agent asks which story to implement
309
+ - Include story file content to save dev agent lookup time
310
+ - Dev follows tasks/subtasks, marking completion
311
+ - Dev leaves notes for SM about any deviations
312
+ - Update status to "Done"
313
+
314
+ **Step 3 - Repeat**: Continue SM → Dev cycle until all epic stories complete
315
+
316
+ **Important**: Only 1 story in progress at a time, worked sequentially until all epic stories complete.
317
+
318
+ ### Status Tracking Workflow
319
+
320
+ Stories progress through defined statuses:
321
+ - **Draft** → **Approved** → **InProgress** → **Done**
322
+
323
+ Each status change requires user verification and approval before proceeding.
324
+
325
+ ### Workflow Types
326
+
327
+ #### Greenfield Development
328
+ - Business analysis and market research
329
+ - Product requirements and feature definition
330
+ - System architecture and design
331
+ - Development execution
332
+ - Testing and deployment
333
+
334
+ #### Brownfield Enhancement
335
+ - Current system analysis
336
+ - Enhancement planning
337
+ - Impact assessment
338
+ - Incremental development
339
+ - Integration testing
340
+
341
+ ## Document Creation Best Practices
342
+
343
+ ### Required File Naming for Framework Integration
344
+
345
+ - `docs/prd.md` - Product Requirements Document
346
+ - `docs/architecture.md` - System Architecture Document
347
+
348
+ **Why These Names Matter**:
349
+ - Agents automatically reference these files during development
350
+ - Sharding tasks expect these specific filenames
351
+ - Workflow automation depends on standard naming
352
+
353
+ ### Cost-Effective Document Creation Workflow
354
+
355
+ **Recommended for Large Documents (PRD, Architecture):**
356
+
357
+ 1. **Use Web UI**: Create documents in web interface for cost efficiency
358
+ 2. **Copy Final Output**: Save complete markdown to your project
359
+ 3. **Standard Names**: Save as `docs/prd.md` and `docs/architecture.md`
360
+ 4. **Switch to IDE**: Use IDE agents for development and smaller documents
361
+
362
+ ### Document Sharding
363
+
364
+ Templates with Level 2 headings (`##`) can be automatically sharded:
365
+
366
+ **Original PRD**:
367
+ ```markdown
368
+ ## Goals and Background Context
369
+ ## Requirements
370
+ ## User Interface Design Goals
371
+ ## Success Metrics
372
+ ```
373
+
374
+ **After Sharding**:
375
+ - `docs/prd/goals-and-background-context.md`
376
+ - `docs/prd/requirements.md`
377
+ - `docs/prd/user-interface-design-goals.md`
378
+ - `docs/prd/success-metrics.md`
379
+
380
+ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sharding.
381
+
382
+ ## Usage Patterns and Best Practices
383
+
384
+ ### Environment-Specific Usage
385
+
386
+ **Web UI Best For**:
387
+ - Initial planning and documentation phases
388
+ - Cost-effective large document creation
389
+ - Agent consultation and brainstorming
390
+ - Multi-agent workflows with orchestrator
391
+
392
+ **IDE Best For**:
393
+ - Active development and implementation
394
+ - File operations and project integration
395
+ - Story management and development cycles
396
+ - Code review and debugging
397
+
398
+ ### Quality Assurance
399
+
400
+ - Use appropriate agents for specialized tasks
401
+ - Follow Agile ceremonies and review processes
402
+ - Maintain document consistency with PO agent
403
+ - Regular validation with checklists and templates
404
+
405
+ ### Performance Optimization
406
+
407
+ - Use specific agents vs. `bmad-master` for focused tasks
408
+ - Choose appropriate team size for project needs
409
+ - Leverage technical preferences for consistency
410
+ - Regular context management and cache clearing
411
+
412
+ ## Success Tips
413
+
414
+ - **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
415
+ - **Use bmad-master for document organization** - Sharding creates manageable chunks
416
+ - **Follow the SM → Dev cycle religiously** - This ensures systematic progress
417
+ - **Keep conversations focused** - One agent, one task per conversation
418
+ - **Review everything** - Always review and approve before marking complete
37
419
 
38
- 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.
39
- 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.
40
- 3. Ensure that you have at least one epic-n.md file in your prd folder, with the stories in order to develop.
41
- 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.
42
- 5. Use a new chat window to allow the SM agent to `draft the next story`.
43
- 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.
44
- 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.
45
- 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.
420
+ ## Getting Help
46
421
 
47
- With this work flow, there is only 1 story in progress at a time, worked sequentially.
422
+ - **Commands**: Use `/help` in any environment to see available commands
423
+ - **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
424
+ - **Documentation**: Check `docs/` folder for project-specific context
425
+ - **Community**: Discord and GitHub resources available for support
@@ -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 AI Studio](https://aistudio.google.com/)**
37
- 2. **Load team-fullstack**:
38
- - Copy contents of: `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
39
- - Paste into new Gemini chat
40
- 3. **Collaborate with the team**:
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: `.bmad-core/web-bundles/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
- 4. **Export planning documents**:
57
- - Save PRD as `docs/prd.md`
58
- - Save architecture as `docs/architecture.md`
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
 
@@ -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
- ````markdown
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
- ````markdown
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
- ````markdown
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
+ ````
@@ -0,0 +1,3 @@
1
+ # Usage Information
2
+
3
+ TODO
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bmad-method",
3
- "version": "4.6.2",
3
+ "version": "4.7.0",
4
4
  "description": "Breakthrough Method of Agile AI-driven Development",
5
5
  "main": "tools/cli.js",
6
6
  "bin": {
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bmad-method",
3
- "version": "4.6.2",
3
+ "version": "4.7.0",
4
4
  "description": "BMAD Method installer - AI-powered Agile development framework",
5
5
  "main": "lib/installer.js",
6
6
  "bin": {