ros/BMAD-METHOD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: documentation updates

Browse Source
This commit is contained in:
Brian Madison
2025-07-04 08:35:28 -05:00
parent 38dd71db7f
commit 2018ad07c7
9 changed files with 36 additions and 557 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/agentic-tools/claude-code-guide.md
View File

@@ -1,6 +1,6 @@
# 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).
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -11,23 +11,7 @@ When running `npx bmad-method install`, select **Claude Code** as your IDE. This
## 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
Type `/agent-name` in your chat to activate an agent.
## Tips for Claude Code Users

22
docs/agentic-tools/cline-guide.md
View File

@@ -1,6 +1,6 @@
# 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).
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -14,23 +14,3 @@ When running `npx bmad-method install`, select **Cline** as your IDE. This creat
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

27
docs/agentic-tools/cursor-guide.md
View File

@@ -1,6 +1,6 @@
# 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).
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -11,27 +11,4 @@ When running `npx bmad-method install`, select **Cursor** as your IDE. This crea
## 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
Type `@agent-name` in chat (Ctrl+L / Cmd+L) to activate an agent. Make sure you select the icon that looks like a small ruler if presented with multiple options in the popup window.

16
docs/agentic-tools/gemini-cli-guide.md
View File

@@ -1,6 +1,6 @@
# 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).
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -19,20 +19,6 @@ Simply mention the agent in your prompt:
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/`

43
docs/agentic-tools/github-copilot-guide.md
View File

@@ -1,53 +1,22 @@
# BMad Method Guide for Visual Studio Code
# BMad Method Guide for Github Copilot
This guide covers the setup and usage of the BMad Method in Visual Studio Code. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
When running `npx bmad-method install`, select **Visual Studio Code** as your IDE. This command will perform the following actions:
When running `npx bmad-method install`, select **Github Copilot** as your IDE. This command will perform the following actions:
- Create the `.bmad-core/` directory with all the agent rule files.
- Create the `.vscode/` directory and add a `settings.json` file with the basic configuration to enable GitHub Copilot's agent mode.
- Create the `.vscode/` directory and add a `settings.json` file if it does not already exist, and add the basic configuration to enable GitHub Copilot's agent mode.
- Create a chatmodes file under your .github folder for each specific agent being added
## Using BMad Agents in VS Code
1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list (usually located next to the input field).
2. Once in Agent Mode, type `@` and the agent's name in the chat input to activate it:
- `@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
1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list.
## VS Code Specific Features
- **Dynamic Configuration**: When you first invoke an agent (e.g., `@dev`), VS Code will automatically update `.vscode/settings.json` by adding the configuration for that chat mode.
- **Activation**: Use the `@` prefix in the GitHub Copilot Chat for instant switching between agents.
- **Collaboration**: Fully compatible with **Live Share**, allowing you, your team, and BMad agents to work together in real-time.
- **Project Context**: Agents have full access to your workspace, including open files and the selected code.
## Tips for VS Code Users
- Use the `help` command (e.g., `@dev help`) to see the available commands for each agent.
- Use `@workspace` in the Copilot Chat to ask questions about your entire project.
- Consider adding `.vscode/` and `.bmad-core/` to your `.gitignore` file in team projects to avoid conflicts with personal settings.

35
docs/agentic-tools/roo-code-guide.md
View File

@@ -1,7 +1,5 @@
# 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:
@@ -9,38 +7,7 @@ When running `npx bmad-method install`, select **Roo Code** as your IDE. This cr
- `.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`, `.yaml`, `.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
- **Mode switching**: Use mode selecto

2
docs/agentic-tools/windsurf-guide.md
View File

@@ -1,7 +1,5 @@
# 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: