readme update
This commit is contained in:
Brian Madison
10203
.bmad-core/web-bundles/teams/team-all.txt
Normal file
10203
.bmad-core/web-bundles/teams/team-all.txt
Normal file
File diff suppressed because it is too large
Load Diff
9557
.bmad-core/web-bundles/teams/team-fullstack.txt
Normal file
9557
.bmad-core/web-bundles/teams/team-fullstack.txt
Normal file
File diff suppressed because it is too large
Load Diff
8400
.bmad-core/web-bundles/teams/team-no-ui.txt
Normal file
8400
.bmad-core/web-bundles/teams/team-no-ui.txt
Normal file
File diff suppressed because it is too large
Load Diff
260
README.md
260
README.md
@@ -1,73 +1,157 @@
|
||||
# BMAD-METHOD
|
||||
|
||||
AI agent orchestration framework for software development. Provides specialized AI agents that function as a complete Agile development team.
|
||||
[](docs/versions.md)
|
||||
[](LICENSE)
|
||||
[](https://nodejs.org)
|
||||
|
||||
**AI-Powered Agile Development Framework** - Transform your software development with specialized AI agents that work as your complete Agile team.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Install a Single Agent (Recommended for First Time)
|
||||
|
||||
```bash
|
||||
npx bmad-method install --agent pm --ide cursor
|
||||
```
|
||||
|
||||
This installs the Product Manager agent with all its dependencies and configures it for your IDE.
|
||||
|
||||
### Install Complete Framework
|
||||
|
||||
```bash
|
||||
npx bmad-method install --full --ide cursor
|
||||
```
|
||||
|
||||
## 📋 Table of Contents
|
||||
|
||||
- [Overview](#overview)
|
||||
- [Installation](#installation)
|
||||
- [Available Agents](#available-agents)
|
||||
- [Usage](#usage)
|
||||
- [Project Structure](#project-structure)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD-METHOD (Breakthrough Method of AgileAI Driven Development) transforms software development workflows by providing 10 specialized AI agents that handle different aspects of the development lifecycle.
|
||||
BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) revolutionizes software development by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain and can collaborate to deliver complete software projects.
|
||||
|
||||
## Features
|
||||
### Why BMAD?
|
||||
|
||||
### Specialized Agents
|
||||
|
||||
- Business Analyst: Requirements gathering and project briefs
|
||||
- Product Manager: Product roadmaps and PRDs
|
||||
- UX Expert: User experience design and UI specifications
|
||||
- Solution Architect: System design and technical architecture
|
||||
- Product Owner: Story validation and backlog management
|
||||
- Scrum Master: Story generation and sprint planning
|
||||
- Developer: Code implementation
|
||||
- QA Specialist: Testing and quality assurance
|
||||
- BMAD Orchestrator: Role transformation via slash commands and BMAD Method Tutor
|
||||
- BMAD Master: Universal executor of all capabilities without role switching
|
||||
|
||||
### Team Configurations
|
||||
|
||||
- Team All: Complete agile team with all roles
|
||||
- Team Fullstack: Full-stack application development focus
|
||||
- Team No-UI: Backend/service development without UX roles
|
||||
|
||||
### Structured Workflows
|
||||
|
||||
- Greenfield: New project workflows (fullstack, service, UI)
|
||||
- Brownfield: Existing project workflows (fullstack, service, UI)
|
||||
- Decision guidance for complex and simple project paths
|
||||
- **🎯 Specialized Expertise**: Each agent is an expert in their specific role
|
||||
- **🔄 True Agile Workflow**: Follows real Agile methodologies and best practices
|
||||
- **📦 Modular Design**: Use one agent or an entire team
|
||||
- **🛠️ IDE Integration**: Works seamlessly with Cursor, Claude Code, and Windsurf
|
||||
- **🌐 Platform Agnostic**: Use with ChatGPT, Claude, Gemini, or any AI platform
|
||||
|
||||
## Installation
|
||||
|
||||
### Option 1: Web Bundles (No Installation)
|
||||
### Method 1: CLI Installer (Recommended) 🎯
|
||||
|
||||
1. Download pre-built bundles from `.bmad-core/web-bundles/`
|
||||
2. Upload to ChatGPT or Gemini
|
||||
3. Set instructions: "Your critical operating instructions are attached, you ARE the BMad Agent..."
|
||||
4. Start with `/help` command if unsure what to do!
|
||||
|
||||
### Option 2: IDE Integration
|
||||
|
||||
1. Copy `.bmad-core/` to project root
|
||||
2. Use agents from `.bmad-core/agents/`
|
||||
3. Configure IDE slash commands
|
||||
|
||||
### Option 3: Build Custom Bundles
|
||||
The easiest way to get started is with our interactive CLI installer:
|
||||
|
||||
```bash
|
||||
git clone [repository]
|
||||
npm install
|
||||
npm run build
|
||||
# Interactive installation
|
||||
npx bmad-method install
|
||||
|
||||
# Install specific agent
|
||||
npx bmad-method install --agent pm --ide cursor
|
||||
|
||||
# Install everything
|
||||
npx bmad-method install --full --ide claude-code
|
||||
```
|
||||
|
||||
Find bundles in `dist/`
|
||||
**Supported IDEs:**
|
||||
|
||||
## Build Commands
|
||||
The BMad Method works with any idea, but there are some built in install helpers, more coming soon.
|
||||
|
||||
- `cursor` - Cursor IDE with @agent commands
|
||||
- `claude-code` - Claude Code with /agent commands
|
||||
- `windsurf` - Windsurf with @agent commands
|
||||
|
||||
### Method 2: Pre-Built Web Bundles 📦
|
||||
|
||||
For ChatGPT, Claude, or Gemini web interfaces:
|
||||
|
||||
1. Download bundles from `.bmad-core/web-bundles/`
|
||||
2. Upload a single `.txt` bundle file to your AI chat (agents or teams)
|
||||
3. Start with: "Your critical operating instructions are attached, do not break character as directed"
|
||||
4. Type `/help` to see available commands
|
||||
|
||||
## Available Agents
|
||||
|
||||
### Core Development Team
|
||||
|
||||
| Agent | Role | Specialty |
|
||||
| ----------- | ------------------ | --------------------------------------------- |
|
||||
| `analyst` | Business Analyst | market analysis, brainstorming, project brief |
|
||||
| `pm` | Product Manager | Product strategy, roadmaps, PRDs |
|
||||
| `architect` | Solution Architect | System design, technical architecture |
|
||||
| `dev` | Developer | Code implementation across all technologies |
|
||||
| `qa` | QA Specialist | Testing strategies, quality assurance |
|
||||
| `ux-expert` | UX Designer | User experience, UI design, prototypes |
|
||||
| `po` | Product Owner | Backlog management, story validation |
|
||||
| `sm` | Scrum Master | Sprint planning, story creation |
|
||||
|
||||
### Meta Agents
|
||||
|
||||
| Agent | Role | Specialty |
|
||||
| ------------------- | ---------------- | ------------------------------------- |
|
||||
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching |
|
||||
| `bmad-master` | Universal Expert | All capabilities without switching |
|
||||
|
||||
## Usage
|
||||
|
||||
### With IDE Integration
|
||||
|
||||
After installation with `--ide` flag:
|
||||
|
||||
```bash
|
||||
npm run build # Build all bundles
|
||||
npm run build:agents # Build agent bundles only
|
||||
npm run build:teams # Build team bundles only
|
||||
npm run list:agents # List available agents
|
||||
npm run validate # Validate configurations
|
||||
# In Cursor
|
||||
@pm Create a PRD for a task management app
|
||||
|
||||
# In Claude Code
|
||||
/architect Design a microservices architecture
|
||||
|
||||
# In Windsurf
|
||||
@dev Implement story 1.3
|
||||
```
|
||||
|
||||
### With Web UI (ChatGPT/Claude/Gemini)
|
||||
|
||||
After uploading a bundle you can ask /help of the agent to learn what it can do
|
||||
|
||||
### CLI Commands
|
||||
|
||||
```bash
|
||||
# List all available agents
|
||||
npx bmad-method list
|
||||
|
||||
# Update existing installation with changes
|
||||
npx bmad-method update
|
||||
|
||||
# Check installation status
|
||||
npx bmad-method status
|
||||
```
|
||||
|
||||
## Teams & Workflows
|
||||
|
||||
### Pre-Configured Teams
|
||||
|
||||
Save context by using specialized teams:
|
||||
|
||||
- **Team All**: Complete Agile team with all 10 agents
|
||||
- **Team Fullstack**: Frontend + Backend development focus
|
||||
- **Team No-UI**: Backend/API development without UX
|
||||
|
||||
### Workflows
|
||||
|
||||
Structured approaches for different scenarios:
|
||||
|
||||
- **Greenfield**: Starting new projects (fullstack/service/UI)
|
||||
- **Brownfield**: Enhancing existing projects
|
||||
- **Simple**: Quick prototypes and MVPs
|
||||
- **Complex**: Enterprise and large-scale projects
|
||||
|
||||
## Project Structure
|
||||
|
||||
```plaintext
|
||||
@@ -75,33 +159,75 @@ npm run validate # Validate configurations
|
||||
├── agents/ # Individual agent definitions
|
||||
├── agent-teams/ # Team configurations
|
||||
├── workflows/ # Development workflows
|
||||
├── templates/ # Document templates
|
||||
├── tasks/ # Reusable task definitions
|
||||
├── checklists/ # Quality checklists
|
||||
├── data/ # Knowledge base
|
||||
└── web-bundles/ # Pre-built bundles
|
||||
├── templates/ # Document templates (PRD, Architecture, etc.)
|
||||
├── tasks/ # Reusable task definitions
|
||||
├── checklists/ # Quality checklists
|
||||
├── data/ # Knowledge base
|
||||
└── web-bundles/ # Pre-built bundles
|
||||
|
||||
expansion-packs/ # Modular extensions
|
||||
tools/ # Build and CLI tools
|
||||
tools/
|
||||
├── cli.js # Build tool
|
||||
├── installer/ # NPX installer
|
||||
└── lib/ # Build utilities
|
||||
|
||||
expansion-packs/ # Optional add-ons (DevOps, Mobile, etc.)
|
||||
```
|
||||
|
||||
## Technical Details
|
||||
## Advanced Features
|
||||
|
||||
- Language: JavaScript
|
||||
- Runtime: Node.js 14.0.0+
|
||||
- Configuration: YAML-based
|
||||
- License: [MIT](LICENSE)
|
||||
### Dynamic Dependencies
|
||||
|
||||
Each agent only loads the resources it needs, keeping context windows lean.
|
||||
|
||||
### Template System
|
||||
|
||||
Rich templates for all document types:
|
||||
|
||||
- Product Requirements (PRD)
|
||||
- Architecture Documents
|
||||
- User Stories
|
||||
- Test Plans
|
||||
- And more...
|
||||
|
||||
### Slash Commands
|
||||
|
||||
Quick actions and role switching:
|
||||
|
||||
- `/help` - Show available commands
|
||||
- `/pm` - Switch to Product Manager
|
||||
- `*create-doc` - Create from template
|
||||
- `*validate` - Run validations
|
||||
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
|
||||
### Development Setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmadcode/bmad-method.git
|
||||
cd bmad-method
|
||||
npm install
|
||||
npm run validate # Check configurations
|
||||
npm test # Run tests
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
- 📖 [Documentation](docs/)
|
||||
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
|
||||
- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
## Author
|
||||
|
||||
Brian (BMad) Madison
|
||||
Created by Brian (BMad) Madison
|
||||
|
||||
## Version
|
||||
---
|
||||
|
||||
4.0.0
|
||||
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
||||
|
||||
See [versions.md](docs/versions.md) for previous versions and history.
|
||||
<sub>Built with ❤️ for the AI-assisted development community</sub>
|
||||
|
||||
Reference in New Issue
Block a user