feat: Massive documentation refactor, added explanation of the new expanded role of the QA agent that will make your code quality MUCH better. 2 new diagram clearly explain the role of the pre dev ideation cycle (prd and architecture) and the details of how the dev cycle works.
This commit is contained in:
Brian Madison
36
docs/agentic-tools/claude-code-guide.md
Normal file
36
docs/agentic-tools/claude-code-guide.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# BMAD Method Guide for Claude Code
|
||||
|
||||
This guide covers Claude Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Claude Code** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.claude/commands/` folder with agent command files (`.md`)
|
||||
|
||||
## Using BMAD Agents in Claude Code
|
||||
|
||||
Type `/agent-name` in your chat to activate an agent:
|
||||
|
||||
- `/bmad-master` - Universal task executor
|
||||
- `/sm` - Scrum Master
|
||||
- `/dev` - Full-stack developer
|
||||
- `/architect` - Solution architect
|
||||
- `/pm` - Product manager
|
||||
- `/analyst` - Business analyst
|
||||
- `/qa` - QA specialist
|
||||
- `/po` - Product owner
|
||||
- `/ux-expert` - UX specialist
|
||||
|
||||
## Claude Code-Specific Features
|
||||
|
||||
- **Command files**: Stored in `.claude/commands/` as `.md` files
|
||||
- **Activation**: Use forward slash `/` prefix for all agents
|
||||
- **Chat management**: Start new chats when switching agents for clean context
|
||||
|
||||
## Tips for Claude Code Users
|
||||
|
||||
- Commands are auto-suggested as you type `/`
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Claude Code maintains excellent context within each chat
|
||||
42
docs/agentic-tools/cline-guide.md
Normal file
42
docs/agentic-tools/cline-guide.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# BMAD Method Guide for Cline (VS Code)
|
||||
|
||||
This guide covers Cline-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Cline** as your IDE. This creates:
|
||||
|
||||
- `.clinerules/` directory with numbered agent rule files (`.md`)
|
||||
- Agents ordered by priority (bmad-master first)
|
||||
|
||||
## Using BMAD Agents in Cline
|
||||
|
||||
1. **Open Cline panel** in VS Code
|
||||
2. **Type `@agent-name`** in the chat (e.g., `@dev`, `@sm`, `@architect`)
|
||||
3. The agent adopts that persona for the conversation
|
||||
|
||||
## Available Agents
|
||||
|
||||
All agents use `@` prefix:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Cline-Specific Features
|
||||
|
||||
- **Rule files**: Stored as numbered files in `.clinerules/` (e.g., `01-bmad-master.md`)
|
||||
- **Agent ordering**: Prioritized list with core agents first
|
||||
- **VS Code integration**: Works within VS Code's Cline extension panel
|
||||
|
||||
## Tips for Cline Users
|
||||
|
||||
- Cline maintains conversation context well
|
||||
- Use `@agent-name` at the start of your message for best results
|
||||
- Agent rules are loaded automatically when mentioned
|
||||
37
docs/agentic-tools/cursor-guide.md
Normal file
37
docs/agentic-tools/cursor-guide.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# BMAD Method Guide for Cursor
|
||||
|
||||
This guide covers Cursor-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Cursor** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.cursor/rules/` folder with agent rule files (`.mdc`)
|
||||
|
||||
## Using BMAD Agents in Cursor
|
||||
|
||||
Type `@agent-name` in chat (Ctrl+L / Cmd+L) to activate an agent:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Cursor-Specific Features
|
||||
|
||||
- **Rule files**: Stored in `.cursor/rules/` as `.mdc` files
|
||||
- **Auto-completion**: Cursor suggests agents as you type `@`
|
||||
- **Context awareness**: Agents can see your current file selection
|
||||
- **Custom agents**: For better performance, copy agent content into Cursor's custom modes
|
||||
|
||||
## Tips for Cursor Users
|
||||
|
||||
- Start new chats when switching agents
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Leverage Cursor's file context for more accurate assistance
|
||||
46
docs/agentic-tools/gemini-cli-guide.md
Normal file
46
docs/agentic-tools/gemini-cli-guide.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# BMAD Method Guide for Gemini CLI
|
||||
|
||||
This guide covers Gemini CLI-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Gemini CLI** as your IDE. This creates:
|
||||
|
||||
- `.gemini/agents/` directory with all agent context files
|
||||
- `.gemini/settings.json` configured to load all agents automatically
|
||||
|
||||
## Using BMAD Agents with Gemini CLI
|
||||
|
||||
Simply mention the agent in your prompt:
|
||||
|
||||
- "As @dev, implement the login feature"
|
||||
- "Acting as @architect, review this system design"
|
||||
- "@sm, create the next story for our project"
|
||||
|
||||
The Gemini CLI automatically loads the appropriate agent context.
|
||||
|
||||
## Available Agents
|
||||
|
||||
All agents are referenced with `@` in prompts:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Gemini CLI-Specific Features
|
||||
|
||||
- **Context files**: All agents loaded as context in `.gemini/agents/`
|
||||
- **Automatic loading**: Settings.json ensures agents are always available
|
||||
- **Natural language**: No special syntax needed, just mention the agent
|
||||
|
||||
## Tips for Gemini CLI Users
|
||||
|
||||
- Be explicit about which agent you're addressing
|
||||
- You can switch agents mid-conversation by mentioning a different one
|
||||
- The CLI maintains context across your session
|
||||
46
docs/agentic-tools/roo-code-guide.md
Normal file
46
docs/agentic-tools/roo-code-guide.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# BMAD Method Guide for Roo Code
|
||||
|
||||
This guide covers Roo Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Roo Code** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.roomodes` file in project root with custom modes
|
||||
|
||||
## Using BMAD Agents in Roo Code
|
||||
|
||||
Select mode from the mode selector (usually in status bar):
|
||||
|
||||
- `bmad-bmad-master` - 🧙 Universal task executor
|
||||
- `bmad-sm` - 🏃 Scrum Master
|
||||
- `bmad-dev` - 💻 Full-stack developer
|
||||
- `bmad-architect` - 🏗️ Solution architect
|
||||
- `bmad-pm` - 📋 Product manager
|
||||
- `bmad-analyst` - 📊 Business analyst
|
||||
- `bmad-qa` - 🧪 QA specialist
|
||||
- `bmad-po` - 🎯 Product owner
|
||||
- `bmad-ux-expert` - 🎨 UX specialist
|
||||
|
||||
## Roo Code-Specific Features
|
||||
|
||||
- **Mode file**: `.roomodes` in project root
|
||||
- **Mode switching**: Use mode selector instead of starting new chats
|
||||
- **Context preservation**: Maintains context across mode switches
|
||||
- **File permissions**: Each agent has specific file access:
|
||||
|
||||
### File Permission Summary
|
||||
|
||||
- **Documentation agents** (analyst, pm, po, sm): `.md`, `.txt` only
|
||||
- **bmad-architect**: `.md`, `.txt`, `.yml`, `.yaml`, `.json`
|
||||
- **bmad-qa**: Test files (`.test.*`, `.spec.*`) and `.md`
|
||||
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx`
|
||||
- **Full access**: `bmad-dev`, `bmad-bmad-master`, `bmad-orchestrator`
|
||||
|
||||
## Tips for Roo Code Users
|
||||
|
||||
- Switch modes instead of starting new chats
|
||||
- Each mode supports `*help` to see available commands
|
||||
- Agents respect file permission boundaries
|
||||
- Context persists across mode switches
|
||||
37
docs/agentic-tools/windsurf-guide.md
Normal file
37
docs/agentic-tools/windsurf-guide.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# BMAD Method Guide for Windsurf
|
||||
|
||||
This guide covers Windsurf-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Windsurf** as your IDE. This creates:
|
||||
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.windsurf/rules/` folder with agent rule files (`.md`)
|
||||
|
||||
## Using BMAD Agents in Windsurf
|
||||
|
||||
Type `@agent-name` in chat to activate an agent:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Windsurf-Specific Features
|
||||
|
||||
- **Rule files**: Stored in `.windsurf/rules/` as `.md` files
|
||||
- **Activation**: Use `@` prefix to mention agents
|
||||
- **Collaborative features**: Works well with BMAD's agent-switching pattern
|
||||
- **Project context**: Agents have access to your full project context
|
||||
|
||||
## Tips for Windsurf Users
|
||||
|
||||
- Start new chats when switching agents
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Leverage Windsurf's collaboration features for team reviews
|
||||
Reference in New Issue
Block a user