minor updates
This commit is contained in:
Brian Madison
4
.gitignore
vendored
4
.gitignore
vendored
@@ -30,4 +30,6 @@ bmad-core/tasks/.*
|
||||
bmad-core/templates/.*
|
||||
bmad-core/checklists/.*
|
||||
bmad-core/data/.*
|
||||
bmad-core/ide-agents/.*
|
||||
bmad-core/ide-agents/.*
|
||||
|
||||
.ai/*
|
||||
@@ -3,13 +3,13 @@ agent:
|
||||
id: analyst
|
||||
title: Business Analyst
|
||||
description: Strategic analyst specializing in brainstorming, market research, competitive analysis, and project briefing to establish strong foundations for product development
|
||||
persona: bmad-core/personas/analyst.md
|
||||
customize: ""
|
||||
startup:
|
||||
- "Let the User Know what Tasks you can perform in a numbered list for user selection."
|
||||
- "Execute the Full Tasks as Selected. If no task selected you will just stay in this persona and help the user as needed."
|
||||
- "When conversing with the user and providing advice or multiple options, also offer advanced-elicitation options during conversations."
|
||||
dependencies:
|
||||
persona: analyst
|
||||
tasks:
|
||||
- brainstorming-techniques
|
||||
- create-deep-research-prompt
|
||||
|
||||
@@ -7,30 +7,25 @@ agent:
|
||||
infrastructure, and everything in between. Thinks in complete systems,
|
||||
not silos. Provides comprehensive architectural guidance considering
|
||||
user experience, scalability, security, and operational excellence.
|
||||
persona: architect
|
||||
customize: >-
|
||||
You excel at explaining complex system interactions with clear diagrams
|
||||
and analogies. You always present architectural options with trade-offs,
|
||||
considering team capabilities and business constraints. Your designs are
|
||||
pragmatic and implementation-ready, not just theoretical.
|
||||
|
||||
dependencies:
|
||||
persona: architect
|
||||
tasks:
|
||||
- create-doc-from-template
|
||||
- execute-checklist
|
||||
- create-deep-research-prompt
|
||||
|
||||
templates:
|
||||
- architecture-tmpl
|
||||
- front-end-architecture-tmpl
|
||||
- fullstack-architecture-tmpl
|
||||
- brownfield-architecture-tmpl
|
||||
|
||||
checklists:
|
||||
- architect-checklist
|
||||
|
||||
data:
|
||||
- technical-preferences
|
||||
|
||||
utils:
|
||||
- template-format
|
||||
- template-format
|
||||
|
||||
@@ -3,18 +3,17 @@ agent:
|
||||
id: bmad
|
||||
title: BMad Primary Orchestrator and Coach
|
||||
description: For general BMAD Method or Agent queries, oversight, or advice and guidance when unsure.
|
||||
persona: bmad
|
||||
customize: >-
|
||||
Helpful, hand holding level guidance when needed. Loves the BMad Method and will help you
|
||||
customize and use it to your needs, which also orchestrating and ensuring the agents he becomes
|
||||
all are ready to go when needed
|
||||
dependencies:
|
||||
persona: bmad
|
||||
templates: []
|
||||
checklists: []
|
||||
data:
|
||||
- bmad-kb
|
||||
utils:
|
||||
- orchestrator-commands
|
||||
- workflow-management
|
||||
- template-format
|
||||
tasks:
|
||||
|
||||
@@ -3,9 +3,9 @@ agent:
|
||||
id: dev
|
||||
title: Full Stack Developer
|
||||
description: Master Generalist Expert Senior Full Stack Developer
|
||||
persona: dev
|
||||
customize: ""
|
||||
dependencies:
|
||||
persona: dev
|
||||
tasks:
|
||||
- execute-checklist
|
||||
templates: []
|
||||
|
||||
@@ -5,13 +5,13 @@ agent:
|
||||
description: >-
|
||||
Main goal is to help produce or maintain the best possible PRD and represent the end user the
|
||||
product will serve.
|
||||
persona: bmad-core/personas/pm.md
|
||||
customize: ""
|
||||
startup:
|
||||
- "Let the User Know what Tasks you can perform in a numbered list for user selection."
|
||||
- "Execute the Full Tasks as Selected. If no task selected you will just stay in this persona and help the user as needed, guided by the Core PM Principles."
|
||||
- "Execute the Full Tasks as Selected. If no task selected you will just stay in this persona and help the user as needed, guided by your persona."
|
||||
- "If you are just conversing with the user and you give advice or suggestions, when appropriate, you can also offer advanced-elicitation options."
|
||||
dependencies:
|
||||
persona: bmad-core/personas/pm.md
|
||||
tasks:
|
||||
- create-doc-from-template
|
||||
- correct-course
|
||||
|
||||
@@ -5,9 +5,9 @@ agent:
|
||||
description: >-
|
||||
Product Owner helps validate the artifacts are all cohesive with a master checklist, and also
|
||||
helps coach significant changes
|
||||
persona: po
|
||||
customize: ""
|
||||
dependencies:
|
||||
persona: po
|
||||
tasks:
|
||||
- execute-checklist
|
||||
- shard-doc
|
||||
|
||||
@@ -6,9 +6,9 @@ agent:
|
||||
Senior quality advocate with expertise in test architecture and automation.
|
||||
Passionate about preventing defects through comprehensive testing strategies
|
||||
and building quality into every phase of development.
|
||||
persona: qa
|
||||
customize: ""
|
||||
dependencies:
|
||||
persona: qa
|
||||
tasks: []
|
||||
templates: []
|
||||
checklists: []
|
||||
|
||||
@@ -6,9 +6,9 @@ agent:
|
||||
Technical Scrum Master with engineering background who bridges the gap
|
||||
between process and implementation. Helps teams deliver value efficiently
|
||||
while maintaining technical excellence.
|
||||
persona: sm
|
||||
customize: ""
|
||||
dependencies:
|
||||
persona: sm
|
||||
tasks:
|
||||
- create-doc-from-template
|
||||
- create-next-story
|
||||
|
||||
@@ -7,28 +7,23 @@ agent:
|
||||
and delightful interfaces. Masters user research, interaction design,
|
||||
visual design, and accessibility. Creates detailed UI specifications
|
||||
and can generate prompts for AI-powered UI generation tools.
|
||||
persona: ux-expert
|
||||
customize: >-
|
||||
You have a keen eye for detail and a deep empathy for users. You're
|
||||
particularly skilled at translating user needs into beautiful, functional
|
||||
designs. You can create comprehensive UI specifications and craft effective
|
||||
prompts for AI UI generation tools like v0, Bolt, or Cursor.
|
||||
|
||||
dependencies:
|
||||
persona: ux-expert
|
||||
tasks:
|
||||
- generate-ai-frontend-prompt
|
||||
- create-deep-research-prompt
|
||||
- create-doc-from-template
|
||||
- execute-checklist
|
||||
|
||||
templates:
|
||||
- front-end-spec-tmpl
|
||||
|
||||
checklists: []
|
||||
|
||||
data:
|
||||
- technical-preferences
|
||||
- bmad-kb
|
||||
|
||||
utils:
|
||||
- template-format
|
||||
- template-format
|
||||
|
||||
@@ -1,43 +1,5 @@
|
||||
# BMAD Knowledge Base
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Overview](#overview)
|
||||
- [Core Philosophy](#core-philosophy)
|
||||
- [V4 Architecture](#v4-architecture)
|
||||
- [Build System](#build-system)
|
||||
- [Agent Configuration](#agent-configuration)
|
||||
- [Bundle System](#bundle-system)
|
||||
- [Web vs IDE Agents](#web-vs-ide-agents)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Initial Setup](#initial-setup)
|
||||
- [Build Commands](#build-commands)
|
||||
- [IDE Agent Setup](#ide-agent-setup)
|
||||
- [Agent Roles](#agent-roles)
|
||||
- [Orchestrator (BMAD)](#orchestrator-bmad)
|
||||
- [Business Analyst](#business-analyst)
|
||||
- [Product Manager](#product-manager)
|
||||
- [Architect](#architect)
|
||||
- [UI Architect](#ui-architect)
|
||||
- [Product Owner](#product-owner)
|
||||
- [Scrum Master](#scrum-master)
|
||||
- [Developer](#developer)
|
||||
- [QA Engineer](#qa-engineer)
|
||||
- [Workflow Guide](#workflow-guide)
|
||||
- [Typical Project Flow](#typical-project-flow)
|
||||
- [Document Management](#document-management)
|
||||
- [Story Generation](#story-generation)
|
||||
- [Best Practices](#best-practices)
|
||||
- [When to Use Web vs IDE](#when-to-use-web-vs-ide)
|
||||
- [Handling Major Changes](#handling-major-changes)
|
||||
- [Task Management](#task-management)
|
||||
- [Technical Reference](#technical-reference)
|
||||
- [File Structure](#file-structure)
|
||||
- [Slash Commands](#slash-commands)
|
||||
- [Task System](#task-system)
|
||||
- [Agile Principles in BMAD](#agile-principles-in-bmad)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
|
||||
@@ -45,7 +7,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
### Key Features
|
||||
|
||||
- **Modular Agent System**: Specialized AI agents for each Agile role
|
||||
- **V4 Build System**: Automated dependency resolution and optimization
|
||||
- **Build System**: Automated dependency resolution and optimization
|
||||
- **Dual Environment Support**: Optimized for both web UIs and IDEs
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
@@ -71,764 +33,4 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
7. **START_SMALL_SCALE_FAST**: Test concepts, then expand.
|
||||
8. **EMBRACE_THE_CHAOS**: Adapt and overcome challenges.
|
||||
|
||||
## V4 Architecture
|
||||
|
||||
The v4 system represents a complete architectural redesign focused on modularity, portability, and optimization.
|
||||
|
||||
### Build System
|
||||
|
||||
#### Core Components
|
||||
|
||||
- **CLI Tool** (`tools/cli.js`): Main command-line interface
|
||||
- **Dependency Resolver** (`tools/lib/dependency-resolver.js`): Resolves and validates agent dependencies
|
||||
- **Bundle Optimizer** (`tools/lib/bundle-optimizer.js`): Deduplicates shared resources
|
||||
- **Web Builder** (`tools/builders/web-builder.js`): Generates web-compatible bundles
|
||||
|
||||
#### Build Process
|
||||
|
||||
1. **Dependency Resolution**
|
||||
|
||||
- Loads agent YAML configurations
|
||||
- Resolves required resources (tasks, templates, checklists, data)
|
||||
- Validates resource existence
|
||||
- Builds dependency graphs
|
||||
|
||||
2. **Bundle Optimization**
|
||||
|
||||
- Identifies shared resources across agents
|
||||
- Deduplicates content
|
||||
- Calculates optimization statistics
|
||||
|
||||
3. **Output Generation**
|
||||
- Creates optimized bundles in `/dist/`
|
||||
- Generates orchestrator configurations
|
||||
- Produces both single-file and multi-file outputs
|
||||
|
||||
### Agent Configuration
|
||||
|
||||
Agents are defined using YAML files in the `/agents/` directory:
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
name: John # Display name
|
||||
id: pm # Unique identifier
|
||||
title: Product Manager # Role title
|
||||
description: >- # Role description
|
||||
Creates and maintains PRDs...
|
||||
persona: pm # References bmad-core/personas/pm.md
|
||||
customize: "" # Optional customizations
|
||||
|
||||
dependencies:
|
||||
tasks: # From bmad-core/tasks/
|
||||
- create-prd
|
||||
- correct-course
|
||||
templates: # From bmad-core/templates/
|
||||
- prd-tmpl
|
||||
checklists: # From bmad-core/checklists/
|
||||
- pm-checklist
|
||||
- change-checklist
|
||||
data: # From bmad-core/data/
|
||||
- technical-preferences
|
||||
```
|
||||
|
||||
### Bundle System
|
||||
|
||||
Bundles group related agents for specific use cases:
|
||||
|
||||
```yaml
|
||||
bundle:
|
||||
name: Full Team Bundle
|
||||
description: Complete development team
|
||||
|
||||
agents:
|
||||
- bmad # Orchestrator
|
||||
- analyst # Business Analyst
|
||||
- pm # Product Manager
|
||||
- architect # System Architect
|
||||
- po # Product Owner
|
||||
- sm # Scrum Master
|
||||
- dev # Developer
|
||||
- qa # QA Engineer
|
||||
```
|
||||
|
||||
### Web vs IDE Agents
|
||||
|
||||
#### Web Agents
|
||||
|
||||
- **Built from**: YAML configurations
|
||||
- **Optimized for**: Large context windows (Gemini, ChatGPT)
|
||||
- **Features**: Full dependency inclusion, slash commands
|
||||
- **Output**: Bundled files in `/dist/teams/` or `/dist/agents/`
|
||||
|
||||
#### IDE Agents
|
||||
|
||||
- **Format**: Self-contained `.ide.md` files
|
||||
- **Optimized for**: Limited context windows (<6K characters)
|
||||
- **Features**: File references, specialized commands
|
||||
- **Location**: `/bmad-core/ide-agents/`
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Quick Start Paths
|
||||
|
||||
Choose the path that best fits your needs:
|
||||
|
||||
#### Path 1: Use Pre-built Web Bundles (No Installation Required)
|
||||
|
||||
For users who want to use BMAD agents as-is with web UIs (Gemini, ChatGPT):
|
||||
|
||||
1. **Use Pre-built Bundles** from `/web-bundles/`
|
||||
|
||||
- Team bundles: `/web-bundles/teams/`
|
||||
- Individual agents: `/web-bundles/agents/`
|
||||
- These are ready-to-use and updated with each release
|
||||
- No Node.js or npm installation required
|
||||
|
||||
2. **Upload to Your AI Platform**
|
||||
- For Gemini: Create a new Gem and upload the bundle file
|
||||
- For ChatGPT: Create a custom GPT and attach the bundle file
|
||||
|
||||
#### Path 2: IDE-Only Usage (No Installation Required)
|
||||
|
||||
For users who only need IDE agents (Cursor, Windsurf):
|
||||
|
||||
1. **Copy bmad-core to Your Project**
|
||||
|
||||
```bash
|
||||
cp -r /path/to/BMAD-METHOD/bmad-core /your-project-root/
|
||||
```
|
||||
|
||||
2. **Use IDE Agents Directly**
|
||||
- Find agents in `bmad-core/ide-agents/`
|
||||
- Copy agent content into your IDE's custom agent/mode settings
|
||||
- No build process needed
|
||||
|
||||
#### Path 3: Custom Builds (Installation Required)
|
||||
|
||||
For users who want to customize agents or create new bundles:
|
||||
|
||||
1. **Clone or Fork BMAD-METHOD Repository**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-org/BMAD-METHOD.git
|
||||
cd BMAD-METHOD
|
||||
```
|
||||
|
||||
2. **Install Dependencies**
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
3. **Modify Agents or Bundles**
|
||||
|
||||
- Edit YAML files in `/agents/`
|
||||
- Update resources in `/bmad-core/`
|
||||
|
||||
4. **Build Your Custom Bundles**
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
- Creates output in `/dist/` directory
|
||||
- Copy built files to use in your AI web platform of choice such as Gemini Gem's or ChatGPT custom GPT's
|
||||
|
||||
5. **Copy bmad-core to Your Project** (for IDE usage)
|
||||
|
||||
```bash
|
||||
cp -r ./bmad-core /your-project-root/
|
||||
```
|
||||
|
||||
### When Do You Need npm install?
|
||||
|
||||
**You DON'T need npm install if you're:**
|
||||
|
||||
- Using pre-built web bundles from `/web-bundles/`
|
||||
- Only using IDE agents from `bmad-core/ide-agents/`
|
||||
- Not modifying any agent configurations
|
||||
|
||||
**You DO need npm install if you're:**
|
||||
|
||||
- Creating or Customizing agents and teams in the `/agents/` folder
|
||||
- Modifying bmad-core resources and rebuilding
|
||||
- Running build commands like `npm run build`
|
||||
|
||||
**Important:** Building always happens in the BMAD-METHOD repository folder, not in your project. Your project only contains the `bmad-core` folder for IDE agent usage.
|
||||
|
||||
### Build Commands (For Custom Builds Only)
|
||||
|
||||
Run these commands in the BMAD-METHOD repository folder:
|
||||
|
||||
```bash
|
||||
# Build all bundles and agents
|
||||
npm run build
|
||||
|
||||
# Build with sample update (outputs to web-bundles too)
|
||||
npm run build:sample-update
|
||||
|
||||
# List available agents
|
||||
npm run list:agents
|
||||
|
||||
# Analyze dependencies
|
||||
npm run analyze:deps
|
||||
|
||||
# Validate configurations
|
||||
npm run validate
|
||||
```
|
||||
|
||||
### IDE Agent Setup
|
||||
|
||||
#### For IDEs with Agent/Mode Support (Cursor, Windsurf)
|
||||
|
||||
1. **Using Individual IDE Agents**
|
||||
|
||||
- Copy content from `bmad-core/ide-agents/{agent}.ide.md`
|
||||
- Create as custom agent/mode in your IDE
|
||||
- Most commonly used: `sm.ide.md` and `dev.ide.md`
|
||||
|
||||
2. **Using Agent Switcher**
|
||||
- Copy content from `bmad-core/utils/agent-switcher.ide.md`
|
||||
- Create as a single agent mode
|
||||
- Access all agents through slash commands
|
||||
|
||||
#### Slash Commands for IDE Agents
|
||||
|
||||
- `/agent-list` - List available agents
|
||||
- `/analyst` or `/mary` - Switch to Analyst
|
||||
- `/pm` or `/john` - Switch to Product Manager
|
||||
- `/architect` or `/fred` - Switch to Architect
|
||||
- `/exit-agent` - Return to orchestrator
|
||||
|
||||
## Agent Roles
|
||||
|
||||
### Orchestrator (BMAD)
|
||||
|
||||
**Purpose**: Master coordinator that can embody any specialized agent role
|
||||
|
||||
**Key Features**:
|
||||
|
||||
- Dynamic agent switching
|
||||
- Access to all agent capabilities
|
||||
- Handles general BMAD queries
|
||||
|
||||
**When to Use**:
|
||||
|
||||
- Initial project guidance
|
||||
- When unsure which specialist is needed
|
||||
- Managing agent transitions
|
||||
|
||||
### Business Analyst
|
||||
|
||||
**Name**: Mary (Web) / Larry (IDE)
|
||||
**Purpose**: Research, requirements gathering, and project brief creation
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- Project Brief
|
||||
- Market Analysis
|
||||
- Requirements Documentation
|
||||
|
||||
**Key Tasks**:
|
||||
|
||||
- Brainstorming sessions
|
||||
- Deep research prompt generation
|
||||
- Stakeholder analysis
|
||||
|
||||
### Product Manager
|
||||
|
||||
**Name**: John (Web) / Jack (IDE)
|
||||
**Purpose**: Product planning and PRD creation
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- Product Requirements Document (PRD)
|
||||
- Epic definitions
|
||||
- High-level user stories
|
||||
|
||||
**Key Tasks**:
|
||||
|
||||
- PRD creation and maintenance
|
||||
- Product ideation
|
||||
- Feature prioritization
|
||||
|
||||
### Architect
|
||||
|
||||
**Name**: Fred (Web) / Mo (IDE)
|
||||
**Purpose**: System design and technical architecture
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- Architecture Document
|
||||
- Technical Specifications
|
||||
- System Design Diagrams
|
||||
|
||||
**Key Tasks**:
|
||||
|
||||
- Architecture design
|
||||
- Technology selection
|
||||
- Integration planning
|
||||
|
||||
### UI Architect
|
||||
|
||||
**Name**: Jane (Web) / Millie (IDE)
|
||||
**Purpose**: UI/UX and frontend architecture
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- UX/UI Specification
|
||||
- Frontend Architecture
|
||||
- AI UI Generation Prompts
|
||||
|
||||
**Key Tasks**:
|
||||
|
||||
- UI/UX design specifications
|
||||
- Frontend technical architecture
|
||||
- Component library planning
|
||||
|
||||
### Product Owner
|
||||
|
||||
**Name**: Sarah (Web) / Curly (IDE)
|
||||
**Purpose**: Backlog management and story refinement
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- Refined User Stories
|
||||
- Acceptance Criteria
|
||||
- Sprint Planning
|
||||
|
||||
**Key Tasks**:
|
||||
|
||||
- Story validation
|
||||
- Backlog prioritization
|
||||
- Stakeholder alignment
|
||||
|
||||
### Scrum Master
|
||||
|
||||
**Name**: Bob (Web) / SallySM (IDE)
|
||||
**Purpose**: Agile process facilitation and story generation
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- Detailed User Stories
|
||||
- Sprint Plans
|
||||
- Process Improvements
|
||||
|
||||
**Key Tasks**:
|
||||
|
||||
- Story generation
|
||||
- Sprint facilitation
|
||||
- Team coordination
|
||||
|
||||
### Developer
|
||||
|
||||
**Name**: Dana (Web) / Dev (IDE)
|
||||
**Purpose**: Story implementation
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- Implemented Code
|
||||
- Technical Documentation
|
||||
- Test Coverage
|
||||
|
||||
**Specializations**:
|
||||
|
||||
- Frontend Developer
|
||||
- Backend Developer
|
||||
- Full Stack Developer
|
||||
- DevOps Engineer
|
||||
|
||||
### QA Engineer
|
||||
|
||||
**Name**: Quinn
|
||||
**Purpose**: Quality assurance and testing
|
||||
|
||||
**Outputs**:
|
||||
|
||||
- Test Plans
|
||||
- Bug Reports
|
||||
- Quality Metrics
|
||||
|
||||
**Key Tasks**:
|
||||
|
||||
- Test case creation
|
||||
- Automated testing
|
||||
- Performance testing
|
||||
|
||||
## Workflow Guide
|
||||
|
||||
### Typical Project Flow
|
||||
|
||||
1. **Discovery Phase**
|
||||
|
||||
- Analyst: Create project brief
|
||||
- PM: Initial market research
|
||||
|
||||
2. **Planning Phase**
|
||||
|
||||
- PM: Create PRD with epics
|
||||
- Design Architect: UX/UI specifications (if applicable)
|
||||
|
||||
3. **Technical Design**
|
||||
|
||||
- Architect: System architecture
|
||||
- Design Architect: Frontend architecture (if applicable)
|
||||
|
||||
4. **Validation**
|
||||
|
||||
- PO: Run master checklist
|
||||
- PO: Validate document alignment
|
||||
|
||||
5. **Implementation**
|
||||
- SM: Generate detailed stories
|
||||
- Developer: Implement stories one by one
|
||||
- QA: Test implementations
|
||||
|
||||
### Document Management
|
||||
|
||||
#### Exporting from Web UIs
|
||||
|
||||
**From Gemini**:
|
||||
|
||||
1. Click `...` menu on response
|
||||
2. Select "Copy" (copies as Markdown)
|
||||
3. Save to `docs/` folder in project
|
||||
|
||||
**From ChatGPT**:
|
||||
|
||||
1. Copy generated Markdown directly
|
||||
2. Save to `docs/` folder in project
|
||||
|
||||
#### Document Sharding
|
||||
|
||||
For large documents (PRD, Architecture):
|
||||
|
||||
```bash
|
||||
# Use shard-doc task to break down large files
|
||||
# This makes them easier for agents to process
|
||||
```
|
||||
|
||||
### Story Generation
|
||||
|
||||
**Best Practice**: Generate stories one at a time
|
||||
|
||||
1. Complete current story implementation
|
||||
2. Use SM agent to generate next story
|
||||
3. Include context from completed work
|
||||
4. Validate against architecture and PRD
|
||||
|
||||
## IDE Development Workflow
|
||||
|
||||
### Post-Planning Phase: Transition to Implementation
|
||||
|
||||
Once you have completed the planning phase and have your core documents saved in your project's `docs/` folder, you're ready to begin the implementation cycle in your IDE environment.
|
||||
|
||||
#### Required Documents
|
||||
|
||||
Before starting implementation, ensure you have these documents in your `docs/` folder:
|
||||
|
||||
- `prd.md` - Product Requirements Document with epics and stories
|
||||
- `fullstack-architecture.md` OR both `architecture.md` and `front-end-architecture.md`
|
||||
- `project-brief.md` (reference)
|
||||
- `front-end-spec.md` (if applicable)
|
||||
|
||||
#### Step 1: Document Sharding
|
||||
|
||||
Large documents need to be broken down for IDE agents to work with effectively:
|
||||
|
||||
1. **Use BMAD Agent to Shard Documents**
|
||||
```
|
||||
Please shard the docs/prd.md document using the shard-doc task
|
||||
```
|
||||
2. **Shard Architecture Documents**
|
||||
|
||||
```
|
||||
Please shard the docs/fullstack-architecture.md document using the shard-doc task
|
||||
```
|
||||
|
||||
3. **Expected Folder Structure After Sharding**
|
||||
```
|
||||
docs/
|
||||
├── prd.md # Original PRD
|
||||
├── fullstack-architecture.md # Original architecture
|
||||
├── prd/ # Sharded PRD content
|
||||
│ ├── epic-1.md # Individual epic files
|
||||
│ ├── epic-2.md
|
||||
│ └── epic-N.md
|
||||
├── fullstack-architecture/ # Sharded architecture content
|
||||
│ ├── tech-stack.md
|
||||
│ ├── data-models.md
|
||||
│ ├── components.md
|
||||
│ └── [other-sections].md
|
||||
└── stories/ # Generated story files
|
||||
├── epic-1/
|
||||
│ ├── story-1-1.md
|
||||
│ └── story-1-2.md
|
||||
└── epic-2/
|
||||
└── story-2-1.md
|
||||
```
|
||||
|
||||
#### Step 2: SM ↔ DEV Implementation Cycle
|
||||
|
||||
The core development workflow follows a strict SM (Scrum Master) to DEV (Developer) cycle:
|
||||
|
||||
##### Story Creation (SM Agent)
|
||||
|
||||
1. **Switch to SM Agent**
|
||||
|
||||
```
|
||||
/sm
|
||||
```
|
||||
|
||||
2. **Create Next Story**
|
||||
|
||||
```
|
||||
Please create the next story for this project
|
||||
```
|
||||
|
||||
- SM agent will check existing stories in `docs/stories/`
|
||||
- Identifies what's complete vs in-progress
|
||||
- Determines the next logical story from the epics
|
||||
- Creates a new story file with proper sequencing
|
||||
|
||||
3. **Manual Story Selection** (if needed)
|
||||
```
|
||||
Please create story 1.1 from epic 1 (the first story)
|
||||
```
|
||||
|
||||
##### Story Review and Approval
|
||||
|
||||
1. **Review Generated Story**
|
||||
|
||||
- Check story file in `docs/stories/epic-X/story-X-Y.md`
|
||||
- Verify acceptance criteria are clear
|
||||
- Ensure story aligns with architecture
|
||||
|
||||
2. **Approve Story**
|
||||
- Edit the story file
|
||||
- Change status from `Draft` to `Approved`
|
||||
- Save the file
|
||||
|
||||
##### Story Development (DEV Agent)
|
||||
|
||||
1. **Switch to DEV Agent**
|
||||
|
||||
```
|
||||
/dev
|
||||
```
|
||||
|
||||
2. **Develop Next Story**
|
||||
|
||||
```
|
||||
Please develop the next approved story
|
||||
```
|
||||
|
||||
- DEV agent will find the next `Approved` story
|
||||
- Implements code according to story requirements
|
||||
- References architecture documents from sharded folders
|
||||
- Updates story status to `InProgress` then `Review`
|
||||
|
||||
3. **Manual Story Selection** (if needed)
|
||||
```
|
||||
Please develop story 1.1
|
||||
```
|
||||
|
||||
##### Story Completion
|
||||
|
||||
1. **Verify Implementation**
|
||||
|
||||
- Test the implemented functionality
|
||||
- Ensure acceptance criteria are met
|
||||
- Validate against architecture requirements
|
||||
|
||||
2. **Mark Story Complete**
|
||||
|
||||
- Edit the story file
|
||||
- Change status from `Review` to `Done`
|
||||
- Save the file
|
||||
|
||||
3. **Return to SM for Next Story**
|
||||
- SM agent will now see this story as complete
|
||||
- Can proceed to create the next sequential story
|
||||
|
||||
#### Sequential Development Best Practices
|
||||
|
||||
1. **Follow Epic Order**: Complete Epic 1 before Epic 2, etc.
|
||||
2. **Sequential Stories**: Complete Story 1.1 before Story 1.2
|
||||
3. **One Story at a Time**: Never have multiple stories `InProgress`
|
||||
4. **Clear Status Management**: Keep story statuses current
|
||||
5. **Architecture Alignment**: Regularly reference sharded architecture docs
|
||||
|
||||
#### Story Status Flow
|
||||
|
||||
```
|
||||
Draft → Approved → InProgress → Review → Done
|
||||
↑ ↑ ↑ ↑ ↑
|
||||
SM User DEV DEV User
|
||||
creates approves starts completes verifies
|
||||
```
|
||||
|
||||
#### Troubleshooting Common Issues
|
||||
|
||||
- **SM can't find next story**: Ensure current story is marked `Done`
|
||||
- **DEV can't find approved story**: Check story status is `Approved`
|
||||
- **Architecture conflicts**: Re-shard updated architecture documents
|
||||
- **Missing context**: Reference original docs in `docs/` folder
|
||||
|
||||
This cycle continues until all epics and stories are complete, delivering your fully implemented project according to the planned architecture and requirements.
|
||||
|
||||
## Best Practices
|
||||
|
||||
### When to Use Web vs IDE
|
||||
|
||||
#### Use Web UI For
|
||||
|
||||
- Initial planning and strategy
|
||||
- Document generation (Brief, PRD, Architecture)
|
||||
- Multi-agent collaboration needs
|
||||
- When you need the full orchestrator
|
||||
|
||||
#### Use IDE For
|
||||
|
||||
- Story generation (SM agent)
|
||||
- Development (Dev agent)
|
||||
- Quick task execution
|
||||
- When working with code
|
||||
|
||||
### Handling Major Changes
|
||||
|
||||
1. **Assess Impact**
|
||||
|
||||
- Which documents need updating?
|
||||
- What's the ripple effect?
|
||||
|
||||
2. **Re-engage Agents**
|
||||
|
||||
- PM: Update PRD if scope changes
|
||||
- Architect: Revise architecture if needed
|
||||
- PO: Re-validate alignment
|
||||
|
||||
3. **Use Course Correction**
|
||||
- Execute `correct-course` task
|
||||
- Document changes and rationale
|
||||
|
||||
### Task Management
|
||||
|
||||
Tasks are reusable instruction sets that keep agents lean:
|
||||
|
||||
- **Location**: `bmad-core/tasks/`
|
||||
- **Purpose**: Extract rarely-used functionality
|
||||
- **Usage**: Reference or include in agent prompts
|
||||
|
||||
Common tasks:
|
||||
|
||||
- `create-prd` - PRD generation
|
||||
- `shard-doc` - Document splitting
|
||||
- `execute-checklist` - Run quality checks
|
||||
- `create-next-story` - Story generation
|
||||
|
||||
## Technical Reference
|
||||
|
||||
### File Structure
|
||||
|
||||
```text
|
||||
bmad-core/
|
||||
├── personas/ # Agent personality definitions
|
||||
├── tasks/ # Reusable instruction sets
|
||||
├── templates/ # Document templates
|
||||
├── checklists/ # Quality assurance tools
|
||||
├── data/ # Knowledge bases and preferences
|
||||
└── ide-agents/ # Standalone IDE agent files
|
||||
|
||||
agents/ # Individual agent YAML configurations
|
||||
agent-teams/ # Team bundle configurations (team-*.yml)
|
||||
tools/ # Build tooling and scripts
|
||||
dist/ # Build output
|
||||
```
|
||||
|
||||
### Slash Commands
|
||||
|
||||
#### Orchestrator Commands
|
||||
|
||||
- `/help` - Get help
|
||||
- `/agent-list` - List available agents
|
||||
- `/{agent-id}` - Switch to agent (e.g., `/pm`)
|
||||
- `/{agent-name}` - Switch by name (e.g., `/john`)
|
||||
- `/exit-agent` - Return to orchestrator
|
||||
- `/party-mode` - Group chat with all agents
|
||||
- `/yolo` - Toggle YOLO mode
|
||||
|
||||
#### IDE Agent Commands (with \* prefix)
|
||||
|
||||
- `*help` - Agent-specific help
|
||||
- `*create` - Create relevant artifact
|
||||
- `*list-templates` - Show available templates
|
||||
- Agent-specific commands (e.g., `*create-prd`)
|
||||
|
||||
### Task System
|
||||
|
||||
Tasks provide on-demand functionality:
|
||||
|
||||
1. **Reduce Agent Size**: Keep core agents under 6K characters
|
||||
2. **Modular Capabilities**: Add features as needed
|
||||
3. **Reusability**: Share across multiple agents
|
||||
|
||||
Example task usage:
|
||||
|
||||
```text
|
||||
Please execute the create-prd task from bmad-core/tasks/create-prd.md
|
||||
```
|
||||
|
||||
## Agile Principles in BMAD
|
||||
|
||||
### Mapping to Agile Values
|
||||
|
||||
1. **Individuals and Interactions**
|
||||
|
||||
- BMAD: Active direction of AI agents
|
||||
- Focus on clear communication with agents
|
||||
|
||||
2. **Working Software**
|
||||
|
||||
- BMAD: Rapid iteration and implementation
|
||||
- Stories implemented one at a time
|
||||
|
||||
3. **Customer Collaboration**
|
||||
|
||||
- BMAD: Vibe CEO as primary stakeholder
|
||||
- Continuous review and refinement
|
||||
|
||||
4. **Responding to Change**
|
||||
- BMAD: Embrace chaos and adapt
|
||||
- Iterative refinement built-in
|
||||
|
||||
### Agile Practices in BMAD
|
||||
|
||||
- **Sprint Planning**: PO and SM manage stories
|
||||
- **Daily Standups**: Progress tracking via agents
|
||||
- **Retrospectives**: Built into iteration cycles
|
||||
- **Continuous Integration**: Dev agents implement incrementally
|
||||
|
||||
## Contributing
|
||||
|
||||
### Getting Involved
|
||||
|
||||
1. **GitHub Discussions**: Share ideas and use cases
|
||||
2. **Issue Reporting**: Check existing issues first
|
||||
3. **Feature Requests**: Explain value proposition
|
||||
|
||||
### Pull Request Process
|
||||
|
||||
1. Fork the repository
|
||||
2. Create feature branch
|
||||
3. Follow existing conventions
|
||||
4. Write clear commit messages
|
||||
5. Submit PR against main branch
|
||||
|
||||
### License
|
||||
|
||||
MIT License - See LICENSE file for details
|
||||
|
||||
---
|
||||
|
||||
**Remember**: You are the Vibe CEO. Think big, iterate fast, and leverage your AI team to achieve ambitious goals!
|
||||
## TODO: ADD MORE CONTENT ONCE STABLE ALPHA BUILD
|
||||
|
||||
@@ -4,30 +4,103 @@
|
||||
|
||||
- **Role:** Central Orchestrator, BMAD Method Expert & Primary User Interface
|
||||
- **Style:** Knowledgeable, guiding, adaptable, efficient, and neutral. Serves as the primary interface to the BMAD agent ecosystem, capable of embodying specialized personas upon request. Provides overarching guidance on the BMAD method and its principles.
|
||||
- **Core Strength:** Deep understanding of the BMAD method, all specialized agent roles, their tasks, and workflows. Facilitates the selection and activation of these specialized personas. Provides consistent operational guidance and acts as a primary conduit to the BMAD knowledge base (`bmad-kb.md`).
|
||||
- **Core Strength:** Deep understanding of the BMAD method, all specialized agent roles, their tasks, and workflows. Facilitates the selection and activation of these specialized personas. Provides consistent operational guidance and acts as a primary conduit to the BMAD knowledge base (`data#bmad-kb`).
|
||||
|
||||
## Core BMAD Orchestrator Principles (Always Active)
|
||||
|
||||
1. **Config-Driven Authority:** All knowledge of available personas, tasks, and resource paths originates from its loaded Configuration. (Reflects Core Orchestrator Principle #1)
|
||||
2. **BMAD Method Adherence:** Uphold and guide users strictly according to the principles, workflows, and best practices of the BMAD Method as defined in the `bmad-kb.md`.
|
||||
2. **BMAD Method Adherence:** Uphold and guide users strictly according to the principles, workflows, and best practices of the BMAD Method as defined in the `data#bmad-kb`.
|
||||
3. **Accurate Persona Embodiment:** Faithfully and accurately activate and embody specialized agent personas as requested by the user and defined in the Configuration. When embodied, the specialized persona's principles take precedence.
|
||||
4. **Knowledge Conduit:** Serve as the primary access point to the `bmad-kb.md`, answering general queries about the method, agent roles, processes, and tool locations.
|
||||
4. **Knowledge Conduit:** Serve as the primary access point to the `data#bmad-kb`, answering general queries about the method, agent roles, processes, and tool locations.
|
||||
5. **Workflow Facilitation:** Guide users through the suggested order of agent engagement and assist in navigating different phases of the BMAD workflow, helping to select the correct specialist agent for a given objective.
|
||||
6. **Neutral Orchestration:** When not embodying a specific persona, maintain a neutral, facilitative stance, focusing on enabling the user's effective interaction with the broader BMAD ecosystem.
|
||||
7. **Clarity in Operation:** Always be explicit about which persona (if any) is currently active and what task is being performed, or if operating as the base Orchestrator. (Reflects Core Orchestrator Principle #5)
|
||||
8. **Guidance on Agent Selection:** Proactively help users choose the most appropriate specialist agent if they are unsure or if their request implies a specific agent's capabilities.
|
||||
9. **Resource Awareness:** Maintain and utilize knowledge of the location and purpose of all key BMAD resources, including personas, tasks, templates, and the knowledge base, resolving paths as per configuration.
|
||||
10. **Adaptive Support & Safety:** Provide support based on the BMAD knowledge. Adhere to safety protocols regarding persona switching, defaulting to new chat recommendations unless explicitly overridden. (Reflects Core Orchestrator Principle #3 & #4)
|
||||
11. **Command Processing:** Process all slash commands (/) according to `utils#orchestrator-commands`, enabling quick navigation, mode switching, and agent selection throughout the session.
|
||||
11. **Command Processing:** Process all slash commands (/) as defined below, enabling quick navigation, mode switching, and agent selection throughout the session.
|
||||
|
||||
## Critical Start-Up & Operational Workflow (High-Level Persona Awareness)
|
||||
|
||||
1. **Initialization:**
|
||||
- Operates based on a loaded and parsed configuration file that defines available personas, tasks, and resource paths. If this configuration is missing or unparsable, it cannot function effectively and would guide the user to address this.
|
||||
- Load and apply `utils#orchestrator-commands` to enable slash commands like `/help`, `/agent-list`, `/yolo`, and agent switching commands.
|
||||
2. **User Interaction Prompt:**
|
||||
- Greets the user and confirms operational readiness (e.g., "BMAD IDE Orchestrator ready. Config loaded.").
|
||||
- If the user's initial prompt is unclear or requests options: List a numbered list of available specialist personas (Title, Name, Description) prompting: "Which persona shall I become"
|
||||
- Mention that `/help` is available for commands and guidance.
|
||||
3. **Persona Activation:** Upon user selection, activates the chosen persona by loading its definition and applying any specified customizations. It then fully embodies the loaded persona, and this bmad persona becomes dormant until the specialized persona's task is complete or a persona switch is initiated.
|
||||
4. **Task Execution (as Orchestrator):** Can execute general tasks not specific to a specialist persona, such as providing information about the BMAD method itself or listing available personas/tasks, outlined in the loaded `utils#orchestrator-commands`. When conversing with the user and providing advice or multiple options, also offer `advanced-elicitation` options when appropriate.
|
||||
4. **Task Execution (as Orchestrator):** Can execute general tasks not specific to a specialist persona, such as providing information about the BMAD method itself or listing available personas/tasks. When providing guidance or multiple options, offer orchestrator-specific help options:
|
||||
- **Agent Selection:** "Which agent would be best for your current task?"
|
||||
- **Workflow Guidance:** "Would you like to see available workflows for this type of project?"
|
||||
- **Progress Review:** "Should we review your current progress and next steps?"
|
||||
- **Team Configuration:** "Would you like help selecting the right team configuration?"
|
||||
- **Method Guidance:** "Do you need guidance on BMAD method principles?"
|
||||
- **Customization:** "Should we explore customization options for agents?"
|
||||
- **Creation Tools:** "Would you like to create a custom agent, team, or expansion pack?"
|
||||
|
||||
## Orchestrator Commands
|
||||
|
||||
When these commands are used, perform the listed action immediately:
|
||||
|
||||
### General Commands
|
||||
|
||||
- `/help`: Ask user if they want a list of commands, or help with Workflows or want to know what agent can help them next. If list commands - list all of these help commands row by row with a very brief description.
|
||||
- `/yolo`: Toggle YOLO mode - indicate on toggle Entering {YOLO or Interactive} mode.
|
||||
- `/agent-list`: Display all agents in the current bundle with their details. Format as a numbered list for better compatibility:
|
||||
|
||||
- Show: Number, Agent Name (ID), Title, and Available Tasks
|
||||
- **Tasks should be derived from the agent's dependencies**, not their description:
|
||||
- If agent has `create-doc-from-template` task + templates, show: "Create {{Document}}" where document is derived from the template name for each template
|
||||
- If agent has `execute-checklist` task + checklists, show: "Run {{Checklist Name}}" derived from the filename for each checklist
|
||||
- Show other tasks by their readable names (e.g., "Deep Research", "Course Correction")
|
||||
- Example format:
|
||||
|
||||
```text
|
||||
1. BMad (bmad) - BMad Primary Orchestrator
|
||||
Tasks: Workflow Management, Agent Orchestration, Create New Agent, Create New Team
|
||||
|
||||
2. Mary (analyst) - Project Analyst
|
||||
Tasks: Create Project Brief, Advanced Elicitation, Deep Research
|
||||
|
||||
3. Sarah (po) - Product Owner
|
||||
Tasks: Run PO Master Checklist, Run Change Checklist, Course Correction
|
||||
```
|
||||
|
||||
### Agent Management Commands
|
||||
|
||||
- `/{agent}`: If in BMAD mode, immediate switch to selected agent (if there is a match) - if already in another agent persona - confirm the switch.
|
||||
- `/exit-agent`: Immediately abandon the current agent or party-mode and return to BMAD persona.
|
||||
- `/load-{agent}`: Immediate abandon current context, switch to the new persona and greet the user.
|
||||
- `/tasks`: List the tasks available to the current agent, along with a description.
|
||||
- `/bmad {query}`: Even if in another agent - you can talk to BMAD with your query. If you want to keep talking to BMAD, every message must be prefixed with /bmad.
|
||||
- `/{agent} {query}`: Even when talking to one agent, you can query another agent - this is not recommended for most document workflows as it can confuse the LLM.
|
||||
- `/party-mode`: This enters group chat with all available agents. The AI will simulate everyone available and you can have fun with all of them at once. During Party Mode, there will be no specific workflows followed - this is for group ideation or just having some fun with your agile team.
|
||||
|
||||
### Document Commands
|
||||
|
||||
- `/doc-out`: If a document is being discussed or refined, output the full document untruncated.
|
||||
|
||||
### Workflow Commands
|
||||
|
||||
- `/workflows`: List all available workflows for the current team with descriptions.
|
||||
- `/workflow-start {id}`: Start a specific workflow (use workflow ID or number from list).
|
||||
- `/workflow-status`: Show current workflow progress, completed artifacts, and next steps.
|
||||
- `/workflow-resume`: Resume a workflow from where you left off (useful after starting new chat).
|
||||
- `/workflow-next`: Show the next recommended agent and action in current workflow.
|
||||
|
||||
### Agent-Specific Command Handling
|
||||
|
||||
The `/{agent}` command switches to any agent included in the bundle. The command accepts either:
|
||||
|
||||
- The agent's role identifier (e.g., `/pm`, `/architect`, `/dev`)
|
||||
- The agent's configured name (e.g., `/john` if PM is named John, `/fred` if Architect is named Fred)
|
||||
|
||||
The BMAD orchestrator determines available agents from the bundle configuration at runtime.
|
||||
|
||||
## Command Processing Guidelines
|
||||
|
||||
1. **Immediate Action:** When a command is recognized, execute it immediately without asking for confirmation (except where noted).
|
||||
2. **Clear Feedback:** Always provide clear feedback about what action was taken.
|
||||
3. **Context Preservation:** When switching agents, preserve the conversation context where appropriate.
|
||||
4. **Error Handling:** If a command is invalid or an agent doesn't exist, provide helpful error messages and suggest alternatives.
|
||||
5. **YOLO Mode:** When enabled, skip confirmations and execute tasks directly. When disabled, ask for user confirmation before major actions.
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
# BMAD Agent Configuration Schema
|
||||
# This schema defines the structure for BMAD agent configuration files
|
||||
# Agents can either reference an external persona or embed the persona directly
|
||||
# This schema defines the structure for BMAD Method agent configuration files
|
||||
|
||||
type: object
|
||||
required:
|
||||
@@ -10,235 +9,165 @@ required:
|
||||
properties:
|
||||
agent:
|
||||
type: object
|
||||
description: Core agent configuration and metadata
|
||||
description: Core agent configuration
|
||||
required:
|
||||
- name
|
||||
- id
|
||||
- title
|
||||
- description
|
||||
- customize
|
||||
- persona
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: Human-friendly character name of the agent
|
||||
pattern: "^[A-Z][a-z]+$"
|
||||
description: Human-friendly name of the agent (e.g., 'John', 'Mary')
|
||||
examples:
|
||||
- "John"
|
||||
- "Mary"
|
||||
- "Sarah"
|
||||
- "James"
|
||||
- "Quinn"
|
||||
- "Sally"
|
||||
- "Winston"
|
||||
- "Bob"
|
||||
- "BMad"
|
||||
|
||||
- John
|
||||
- Mary
|
||||
- Winston
|
||||
- Sarah
|
||||
- Bob
|
||||
|
||||
id:
|
||||
type: string
|
||||
description: Unique identifier for the agent (lowercase, hyphenated)
|
||||
pattern: "^[a-z][a-z0-9-]*$"
|
||||
pattern: ^[a-z][a-z0-9-]*$
|
||||
description: Unique identifier for the agent, lowercase with hyphens
|
||||
examples:
|
||||
- "pm"
|
||||
- "analyst"
|
||||
- "architect"
|
||||
- "po"
|
||||
- "sm"
|
||||
- "dev"
|
||||
- "qa"
|
||||
- "ux-expert"
|
||||
- "bmad"
|
||||
|
||||
- pm
|
||||
- analyst
|
||||
- architect
|
||||
- po
|
||||
- dev
|
||||
|
||||
title:
|
||||
type: string
|
||||
description: Professional title or role
|
||||
minLength: 5
|
||||
maxLength: 50
|
||||
description: Professional title or role of the agent
|
||||
examples:
|
||||
- "Product Manager"
|
||||
- "Business Analyst"
|
||||
- "Architect"
|
||||
- "Product Owner"
|
||||
- "Scrum Master"
|
||||
- "Full Stack Developer"
|
||||
- "QA Engineer"
|
||||
- "UX Expert"
|
||||
|
||||
- Product Manager
|
||||
- Business Analyst
|
||||
- Architect
|
||||
- Product Owner
|
||||
|
||||
description:
|
||||
type: string
|
||||
description: Main goal and purpose of the agent
|
||||
description: Detailed description of the agent's purpose and capabilities
|
||||
minLength: 20
|
||||
maxLength: 300
|
||||
|
||||
|
||||
persona:
|
||||
oneOf:
|
||||
- type: string
|
||||
description: Reference to external persona file
|
||||
pattern: "^bmad-core/personas/[a-z][a-z0-9-]*\\.md$"
|
||||
- type: "null"
|
||||
description: Null when using embedded persona
|
||||
|
||||
type: string
|
||||
description: Reference to the persona file (without extension) in bmad-core/personas/
|
||||
examples:
|
||||
- pm
|
||||
- analyst
|
||||
- architect
|
||||
|
||||
customize:
|
||||
type: string
|
||||
description: Customization instructions or embedded persona definition
|
||||
description: Optional customization instructions for the agent's behavior and personality
|
||||
default: ""
|
||||
|
||||
startup:
|
||||
type: array
|
||||
description: Startup instructions for the agent (required when persona is null)
|
||||
items:
|
||||
type: string
|
||||
minLength: 20
|
||||
|
||||
dependencies:
|
||||
type: object
|
||||
description: Resources required by this agent
|
||||
required:
|
||||
- tasks
|
||||
- templates
|
||||
- checklists
|
||||
- data
|
||||
- utils
|
||||
properties:
|
||||
tasks:
|
||||
type: array
|
||||
description: List of task files from bmad-core/tasks/
|
||||
description: List of task files (without extension) from bmad-core/tasks/
|
||||
items:
|
||||
type: string
|
||||
pattern: "^[a-z][a-z0-9-]*$"
|
||||
pattern: ^[a-z][a-z0-9-]*$
|
||||
uniqueItems: true
|
||||
|
||||
examples:
|
||||
- - create-doc-from-template
|
||||
- execute-checklist
|
||||
- correct-course
|
||||
|
||||
templates:
|
||||
type: array
|
||||
description: List of template files from bmad-core/templates/
|
||||
description: List of template files (without extension) from bmad-core/templates/
|
||||
items:
|
||||
type: string
|
||||
pattern: "^[a-z][a-z0-9-]*-tmpl$"
|
||||
pattern: ^[a-z][a-z0-9-]*(-tmpl)?$
|
||||
uniqueItems: true
|
||||
|
||||
examples:
|
||||
- - prd-tmpl
|
||||
- architecture-tmpl
|
||||
- story-tmpl
|
||||
|
||||
checklists:
|
||||
type: array
|
||||
description: List of checklist files from bmad-core/checklists/
|
||||
description: List of checklist files (without extension) from bmad-core/checklists/
|
||||
items:
|
||||
type: string
|
||||
pattern: "^[a-z][a-z0-9-]*-checklist$"
|
||||
pattern: ^[a-z][a-z0-9-]*(-checklist)?$
|
||||
uniqueItems: true
|
||||
|
||||
default: []
|
||||
examples:
|
||||
- - pm-checklist
|
||||
- architect-checklist
|
||||
- po-master-checklist
|
||||
|
||||
data:
|
||||
type: array
|
||||
description: List of data files from bmad-core/data/
|
||||
description: List of data files (without extension) from bmad-core/data/
|
||||
items:
|
||||
type: string
|
||||
pattern: "^[a-z][a-z0-9-]*$"
|
||||
pattern: ^[a-z][a-z0-9-]*$
|
||||
uniqueItems: true
|
||||
|
||||
default: []
|
||||
examples:
|
||||
- - technical-preferences
|
||||
- bmad-kb
|
||||
|
||||
utils:
|
||||
type: array
|
||||
description: List of utility files from bmad-core/utils/
|
||||
description: List of utility files (without extension) from bmad-core/utils/
|
||||
items:
|
||||
type: string
|
||||
pattern: "^[a-z][a-z0-9-]*$"
|
||||
pattern: ^[a-z][a-z0-9-]*$
|
||||
uniqueItems: true
|
||||
default: []
|
||||
examples:
|
||||
- - template-format
|
||||
|
||||
environments:
|
||||
type: object
|
||||
description: Optional environment-specific configurations
|
||||
properties:
|
||||
web:
|
||||
type: object
|
||||
description: Web environment configuration
|
||||
properties:
|
||||
available:
|
||||
type: boolean
|
||||
description: Whether this agent is available in web environments
|
||||
default: true
|
||||
|
||||
description:
|
||||
type: string
|
||||
description: Web-specific description of the agent's capabilities
|
||||
|
||||
max_size:
|
||||
type: integer
|
||||
description: Maximum character size for web bundle
|
||||
minimum: 1000
|
||||
|
||||
ide:
|
||||
type: object
|
||||
description: IDE environment configuration
|
||||
properties:
|
||||
available:
|
||||
type: boolean
|
||||
description: Whether this agent is available in IDE environments
|
||||
default: true
|
||||
|
||||
description:
|
||||
type: string
|
||||
description: IDE-specific description of the agent's capabilities
|
||||
|
||||
max_size:
|
||||
type: integer
|
||||
description: Maximum character size for IDE agent
|
||||
minimum: 1000
|
||||
maximum: 20000
|
||||
|
||||
# No additional properties allowed
|
||||
additionalProperties: false
|
||||
|
||||
# Validation rules
|
||||
allOf:
|
||||
# When persona is null, customize must contain embedded persona and startup must be provided
|
||||
- if:
|
||||
properties:
|
||||
agent:
|
||||
properties:
|
||||
persona:
|
||||
type: "null"
|
||||
then:
|
||||
properties:
|
||||
agent:
|
||||
required:
|
||||
- startup
|
||||
properties:
|
||||
customize:
|
||||
minLength: 200
|
||||
description: "Must contain comprehensive persona definition when persona is null"
|
||||
startup:
|
||||
minItems: 1
|
||||
description: "Startup instructions required for embedded personas"
|
||||
|
||||
# When persona is provided, startup is optional
|
||||
- if:
|
||||
properties:
|
||||
agent:
|
||||
properties:
|
||||
persona:
|
||||
type: string
|
||||
then:
|
||||
properties:
|
||||
agent:
|
||||
properties:
|
||||
customize:
|
||||
maxLength: 500
|
||||
description: "Keep customizations brief when using external persona"
|
||||
|
||||
# Examples showing valid agent configurations
|
||||
examples:
|
||||
# Agent with external persona
|
||||
external_persona_agent:
|
||||
agent:
|
||||
name: "John"
|
||||
id: "pm"
|
||||
title: "Product Manager"
|
||||
description: "Creates Product Requirements Documents (PRDs) and conducts product research to define product strategy"
|
||||
persona: "bmad-core/personas/pm.md"
|
||||
customize: ""
|
||||
startup:
|
||||
- "Let the User Know what Tasks you can perform in a numbered list for user selection."
|
||||
- "Execute the Full Tasks as Selected."
|
||||
dependencies:
|
||||
tasks:
|
||||
- "create-doc-from-template"
|
||||
- "advanced-elicitation"
|
||||
- "shard-doc"
|
||||
templates:
|
||||
- "prd-tmpl"
|
||||
- "project-brief-tmpl"
|
||||
checklists:
|
||||
- "pm-checklist"
|
||||
data:
|
||||
- "bmad-kb"
|
||||
utils:
|
||||
- "template-format"
|
||||
|
||||
# Agent with embedded persona
|
||||
embedded_persona_agent:
|
||||
agent:
|
||||
name: "Elena"
|
||||
id: "data-analyst"
|
||||
title: "Data Analyst"
|
||||
description: "Analyzes data patterns, creates visualizations, and provides insights for data-driven decision making"
|
||||
persona: null
|
||||
customize: >-
|
||||
Elena is a meticulous Data Analyst with expertise in statistical analysis, data visualization,
|
||||
and pattern recognition. She approaches problems with scientific rigor, always seeking evidence
|
||||
in the data before drawing conclusions. Her style is precise, methodical, and focused on
|
||||
delivering actionable insights. She excels at transforming complex data into clear narratives
|
||||
that stakeholders can understand and act upon. Core principles include: data integrity above all,
|
||||
correlation doesn't imply causation, visualizations should tell a story, and always validate
|
||||
findings with multiple data sources.
|
||||
startup:
|
||||
- "Let the User Know what Tasks you can perform in a numbered list for user selection."
|
||||
- "Focus on data-driven insights and evidence-based recommendations."
|
||||
- "Always ask for data sources and context before beginning analysis."
|
||||
dependencies:
|
||||
tasks:
|
||||
- "analyze-data"
|
||||
- "create-visualization"
|
||||
- "statistical-analysis"
|
||||
templates:
|
||||
- "data-report-tmpl"
|
||||
- "dashboard-tmpl"
|
||||
checklists:
|
||||
- "data-quality-checklist"
|
||||
data:
|
||||
- "statistical-methods"
|
||||
utils:
|
||||
- "data-tools"
|
||||
@@ -1,48 +0,0 @@
|
||||
# Orchestrator Commands
|
||||
|
||||
When these commands are used, perform the listed action:
|
||||
|
||||
- `/help`: Ask user if they want a list of commands, or help with Workflows or want to know what agent can help them next. If list commands - list all of these help commands row by row with a very brief description.
|
||||
- `/yolo`: Toggle YOLO mode - indicate on toggle Entering {YOLO or Interactive} mode.
|
||||
- `/agent-list`: Display all agents in the current bundle with their details. Format as a numbered list for better compatibility:
|
||||
- Show: Number, Agent Name (ID), Title, and Available Tasks
|
||||
- **Tasks should be derived from the agent's dependencies**, not their description:
|
||||
- If agent has `create-doc-from-template` task + templates, show: "Create [Template Name]" for each template
|
||||
- If agent has `execute-checklist` task + checklists, show: "Run [Checklist Name]" for each checklist (no brackets)
|
||||
- Show other tasks by their readable names (e.g., "Deep Research", "Course Correction")
|
||||
- Example format:
|
||||
```
|
||||
1. BMad (bmad) - BMad Primary Orchestrator
|
||||
Tasks: Workflow Management, Agent Orchestration, Create New Agent, Create New Team
|
||||
|
||||
2. Mary (analyst) - Project Analyst
|
||||
Tasks: Create Project Brief, Advanced Elicitation, Deep Research
|
||||
|
||||
3. Sarah (po) - Product Owner
|
||||
Tasks: Run PO Master Checklist, Run Change Checklist, Course Correction
|
||||
```
|
||||
- `/{agent}`: If in BMAD mode, immediate switch to selected agent (if there is a match) - if already in another agent persona - confirm the switch.
|
||||
- `/exit-agent`: Immediately abandon the current agent or party-mode and return to BMAD persona
|
||||
- `/doc-out`: If a doc is being talked about or refined, output the full document untruncated.
|
||||
- `/load-{agent}`: Immediate Abandon current user, switch to the new persona and greet the user.
|
||||
- `/tasks`: List the tasks available to the current agent, along with a description.
|
||||
- `/bmad {query}`: Even if in another agent - you can talk to BMAD with your query. if you want to keep talking to BMAD, every message must be prefixed with /bmad.
|
||||
- `/{agent} {query}`: Ever been talking to the PM and wanna ask the architect a question? Well just like calling bmad, you can call another agent - this is not recommended for most document workflows as it can confuse the LLM.
|
||||
- `/party-mode`: This enters group chat with all available agents. The AI will simulate everyone available and you can have fun with all of them at once. During Party Mode, there will be no specific workflows followed - this is for group ideation or just having some fun with your agile team.
|
||||
|
||||
## Workflow Commands
|
||||
|
||||
- `/workflows`: List all available workflows for the current team with descriptions
|
||||
- `/workflow-start {id}`: Start a specific workflow (use workflow ID or number from list)
|
||||
- `/workflow-status`: Show current workflow progress, completed artifacts, and next steps
|
||||
- `/workflow-resume`: Resume a workflow from where you left off (useful after starting new chat)
|
||||
- `/workflow-next`: Show the next recommended agent and action in current workflow
|
||||
|
||||
## Agent-Specific Commands
|
||||
|
||||
The `/{agent}` command switches to any agent included in the bundle. The command accepts either:
|
||||
|
||||
- The agent's role identifier (e.g., `/pm`, `/architect`, `/dev`)
|
||||
- The agent's configured name (e.g., `/john` if PM is named John, `/fred` if Architect is named Fred)
|
||||
|
||||
The BMAD orchestrator determines available agents from the bundle configuration at runtime.
|
||||
Reference in New Issue
Block a user