Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
95ab8bbd9c | ||
|
|
a1b30d9341 | ||
|
|
6e094c8359 | ||
|
|
86d5139aea | ||
|
|
62ccb640e6 | ||
|
|
9371a5784f |
21
CHANGELOG.md
21
CHANGELOG.md
@@ -1,3 +1,24 @@
|
||||
# [4.22.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.2...v4.22.0) (2025-06-30)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* create doc more explicit and readme improvement ([a1b30d9](https://github.com/bmadcode/BMAD-METHOD/commit/a1b30d9341d2ceff79db2c7e178860c5ef0d99e5))
|
||||
|
||||
## [4.21.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.1...v4.21.2) (2025-06-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* improve create-doc task clarity for template execution ([86d5139](https://github.com/bmadcode/BMAD-METHOD/commit/86d5139aea7097cc5d4ee9da0f7d3e395ce0835e))
|
||||
|
||||
## [4.21.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.21.0...v4.21.1) (2025-06-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* readme clarifies that the installer handles installs upgrades and expansion installation ([9371a57](https://github.com/bmadcode/BMAD-METHOD/commit/9371a5784f6a6f2ad358a72ea0cde9c980357167))
|
||||
|
||||
# [4.21.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.20.0...v4.21.0) (2025-06-30)
|
||||
|
||||
|
||||
|
||||
68
README.md
68
README.md
@@ -13,7 +13,7 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
|
||||
⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-METHOD and you will be notified of updates!
|
||||
|
||||
## 🧭 Quick Navigation - Find Your Path
|
||||
## Quick Navigation
|
||||
|
||||
### 🚨 MUST READ: Understanding the BMAD Workflow
|
||||
|
||||
@@ -50,13 +50,14 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
- **[Contributing](#contributing)** → Help improve BMAD
|
||||
- **[Support](#support)** → Get help and connect
|
||||
|
||||
## 🔄 Important: Keeping Your BMad Installation Updated
|
||||
## Important: Keep Your BMad Installation Updated
|
||||
|
||||
**Stay up-to-date effortlessly!** If you already have BMad-METHOD installed in your project, simply run:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR
|
||||
git pull
|
||||
npm run install:bmad
|
||||
```
|
||||
|
||||
@@ -69,32 +70,45 @@ This will:
|
||||
|
||||
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations! If for some reason this fails, you can rename or remove your .bmad-code folder and run the install again. The main thing to look out for is if you have set up custom modes that are not file driven (Cursor is the only one at this time that is not done through project files lagging behind) - you will want to ensure your sm and dev custom modes especially are kept up to date.
|
||||
|
||||
## 🚀 Quick Start
|
||||
## Quick Start
|
||||
|
||||
### Fastest Start: Web UI (2 minutes) 🏃♂️
|
||||
### One Command for Everything (IDE Installation)
|
||||
|
||||
**Just run one of these commands:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR if you already have BMad installed:
|
||||
git pull
|
||||
npm run install:bmad
|
||||
```
|
||||
|
||||
This single command handles:
|
||||
|
||||
- **New installations** - Sets up BMad in your project
|
||||
- **Upgrades** - Updates existing installations automatically
|
||||
- **Expansion packs** - Installs any expansion packs you've added to package.json
|
||||
|
||||
> **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.
|
||||
|
||||
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
|
||||
|
||||
### Fastest Start: Web UI (2 minutes)
|
||||
|
||||
1. **Get the bundle**: Copy `dist/teams/team-fullstack.txt` (from this repository)
|
||||
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
||||
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
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.
|
||||
|
||||
> 💡 **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
|
||||
> **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
|
||||
|
||||
### IDE Quick Start (5 minutes) 💻
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) (v20 or higher)
|
||||
|
||||
Run `npx bmad-method install`
|
||||
|
||||
OR
|
||||
### Alternative: Clone and Build
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmadcode/bmad-method.git
|
||||
npm run install:bmad # build and install all to a destination folder
|
||||
```
|
||||
|
||||
This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
|
||||
|
||||
## Overview
|
||||
|
||||
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 +117,25 @@ Unlike systems like Task Master, or inbuilt Task tool, the BMad Methods agile fl
|
||||
|
||||
## Installation
|
||||
|
||||
### Method 1: Pre-Built Web Bundles (Fastest) 📦
|
||||
### Method 1: CLI Installer (For IDEs)
|
||||
|
||||
**Just run one command:**
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# OR if you already have BMad installed:
|
||||
npm run install:bmad
|
||||
```
|
||||
|
||||
**This single command does everything:**
|
||||
|
||||
- Installs BMad for the first time
|
||||
- Updates existing installations
|
||||
- Adds any expansion packs from your package.json
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
||||
|
||||
### Method 2: Pre-Built Web Bundles (For Web UI)
|
||||
|
||||
For ChatGPT, Claude, or Gemini web interfaces:
|
||||
|
||||
@@ -114,12 +146,6 @@ For ChatGPT, Claude, or Gemini web interfaces:
|
||||
3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
4. Type `/help` to see available commands
|
||||
|
||||
### Method 2: CLI Installer (For IDEs) 🎯
|
||||
|
||||
**Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
|
||||
|
||||
Install directly into your project: `npx bmad-method install`
|
||||
|
||||
**Supported IDEs:**
|
||||
|
||||
The BMad Method works with any IDE, but has built-in integration for:
|
||||
|
||||
@@ -2,73 +2,70 @@
|
||||
|
||||
## Purpose
|
||||
|
||||
- Generate documents from any specified template following embedded instructions from the perspective of the selected agent persona
|
||||
Generate documents from templates by EXECUTING (not just reading) embedded instructions from the perspective of the selected agent persona.
|
||||
|
||||
## Instructions
|
||||
## CRITICAL RULES
|
||||
|
||||
### 1. Identify Template and Context
|
||||
1. **Templates are PROGRAMS** - Execute every [[LLM:]] instruction exactly as written
|
||||
2. **NEVER show markup** - Hide all [[LLM:]], {{placeholders}}, @{examples}, and template syntax
|
||||
3. **STOP and EXECUTE** - When you see "apply tasks#" or "execute tasks#", STOP and run that task immediately
|
||||
4. **WAIT for user input** - At review points and after elicitation tasks
|
||||
|
||||
- Determine which template to use (user-provided or list available for selection to user)
|
||||
## Execution Flow
|
||||
|
||||
- Agent-specific templates are listed in the agent's dependencies under `templates`. For each template listed, consider it a document the agent can create. So if an agent has:
|
||||
### 1. Identify Template
|
||||
|
||||
@{example}
|
||||
dependencies:
|
||||
templates: - prd-tmpl - architecture-tmpl
|
||||
@{/example}
|
||||
- Load from `templates#*` or `{root}/templates directory`
|
||||
- Agent-specific templates are listed in agent's dependencies
|
||||
- If agent has `templates: [prd-tmpl, architecture-tmpl]`, offer to create "PRD" and "Architecture" documents
|
||||
|
||||
You would offer to create "PRD" and "Architecture" documents when the user asks what you can help with.
|
||||
### 2. Ask Interaction Mode
|
||||
|
||||
- Gather all relevant inputs, or ask for them, or else rely on user providing necessary details to complete the document
|
||||
- Understand the document purpose and target audience
|
||||
|
||||
### 2. Determine Interaction Mode
|
||||
|
||||
Confirm with the user their preferred interaction style:
|
||||
|
||||
- **Incremental:** Work through chunks of the document.
|
||||
- **YOLO Mode:** Draft complete document making reasonable assumptions in one shot. (Can be entered also after starting incremental by just typing /yolo)
|
||||
> 1. **Incremental** - Section by section with reviews
|
||||
> 2. **YOLO Mode** - Complete draft then review (user can type `/yolo` anytime to switch)
|
||||
|
||||
### 3. Execute Template
|
||||
|
||||
- Load specified template from `templates#*` or the `{root}/templates directory`
|
||||
- Follow ALL embedded LLM instructions within the template
|
||||
- Process template markup according to `utils#template-format` or `{root}/utils/template-format` conventions
|
||||
|
||||
### 4. Template Processing Rules
|
||||
|
||||
#### CRITICAL: Never display template markup, LLM instructions, or examples to users
|
||||
|
||||
- Replace all {{placeholders}} with actual content
|
||||
- Execute all [[LLM: instructions]] internally
|
||||
- Process `<<REPEAT>>` sections as needed
|
||||
- Evaluate ^^CONDITION^^ blocks and include only if applicable
|
||||
- Replace {{placeholders}} with real content
|
||||
- Execute [[LLM:]] instructions as you encounter them
|
||||
- Process <<REPEAT>> loops and ^^CONDITIONS^^
|
||||
- Use @{examples} for guidance but never output them
|
||||
|
||||
### 5. Content Generation
|
||||
### 4. Key Execution Patterns
|
||||
|
||||
- **Incremental Mode**: Present each major section for review before proceeding
|
||||
- **YOLO Mode**: Generate all sections, then review complete document with user
|
||||
- Apply any elicitation protocols specified in template
|
||||
- Incorporate user feedback and iterate as needed
|
||||
**When you see:** `[[LLM: Draft X and immediately execute tasks#advanced-elicitation]]`
|
||||
|
||||
### 6. Validation
|
||||
- Draft the content
|
||||
- Present it to user
|
||||
- IMMEDIATELY execute the task
|
||||
- Wait for completion before continuing
|
||||
|
||||
If template specifies a checklist:
|
||||
**When you see:** `[[LLM: After section completion, apply tasks#Y]]`
|
||||
|
||||
- Run the appropriate checklist against completed document
|
||||
- Document completion status for each item
|
||||
- Address any deficiencies found
|
||||
- Present validation summary to user
|
||||
- Finish the section
|
||||
- STOP and execute the task
|
||||
- Wait for user input
|
||||
|
||||
### 7. Final Presentation
|
||||
### 5. Validation & Final Presentation
|
||||
|
||||
- Run any specified checklists
|
||||
- Present clean, formatted content only
|
||||
- Ensure all sections are complete
|
||||
- DO NOT truncate or summarize content
|
||||
- Begin directly with document content (no preamble)
|
||||
- Include any handoff prompts specified in template
|
||||
- No truncation or summarization
|
||||
- Begin directly with content (no preamble)
|
||||
- Include any handoff prompts from template
|
||||
|
||||
## Important Notes
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
- Template markup is for AI processing only - never expose to users
|
||||
❌ Skipping elicitation tasks
|
||||
❌ Showing template markup to users
|
||||
❌ Continuing past STOP signals
|
||||
❌ Combining multiple review points
|
||||
|
||||
✅ Execute ALL instructions in sequence
|
||||
✅ Present only clean, formatted content
|
||||
✅ Stop at every elicitation point
|
||||
✅ Wait for user confirmation when instructed
|
||||
|
||||
## Remember
|
||||
|
||||
Templates contain precise instructions for a reason. Follow them exactly to ensure document quality and completeness.
|
||||
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.21.0",
|
||||
"version": "4.22.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bmad-method",
|
||||
"version": "4.21.0",
|
||||
"version": "4.22.0",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@kayvan/markdown-tree-parser": "^1.5.0",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.21.0",
|
||||
"version": "4.22.0",
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"main": "tools/cli.js",
|
||||
"bin": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.21.0",
|
||||
"version": "4.22.0",
|
||||
"description": "BMAD Method installer - AI-powered Agile development framework",
|
||||
"main": "lib/installer.js",
|
||||
"bin": {
|
||||
|
||||
Reference in New Issue
Block a user