docs: update cursor, windsurf, crush, and github-copilot docs for flat file structure

This commit is contained in:
Alex Verkhovsky 2025-12-26 02:38:10 -08:00
parent 4cb0669a9c
commit 994ebb05ba
4 changed files with 62 additions and 41 deletions

View File

@ -2,29 +2,27 @@
## Activating Agents
BMAD agents are installed as commands in `.crush/commands/bmad/`.
BMAD agents are installed as commands in `.crush/commands/` with flattened
`bmad-*.md` naming.
### How to Use
1. **Open Command Palette**: Use Crush command interface
2. **Navigate**: Browse to `_bmad/{module}/agents/`
3. **Select Agent**: Choose the agent command
2. **Type Command**: Start with `/bmad-` to filter BMAD commands
3. **Select Command**: Choose from the available options
4. **Execute**: Run to activate agent persona
### Command Structure
### Examples
```
.crush/commands/bmad/
├── agents/ # All agents
├── tasks/ # All tasks
├── core/ # Core module
│ ├── agents/
│ └── tasks/
└── {module}/ # Other modules
/bmad-bmm-agents-pm - Activate PM agent
/bmad-bmm-agents-architect - Activate architect agent
/bmad-bmm-workflows-create-prd - Execute create-prd workflow
/bmad-core-tasks-workflow - Execute workflow task
```
### Notes
- Commands organized by module
- Can browse hierarchically
- All BMAD commands start with `bmad-`
- Commands include agents, tasks, tools, and workflows
- Agent activates for session

View File

@ -2,24 +2,27 @@
## Activating Agents
BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules.
BMAD agents are installed as MDC rules in `.cursor/rules/` with flattened
`bmad-*.mdc` naming.
### How to Use
1. **Reference in Chat**: Use `@_bmad/{module}/agents/{agent-name}`
2. **Include Entire Module**: Use `@_bmad/{module}`
3. **Reference Index**: Use `@_bmad/index` for all available agents
1. **Reference in Chat**: Use `@bmad-{module}-{type}-{name}`
2. **Browse Available**: Type `@bmad-` to see autocomplete options
3. **Reference Index**: Use `@bmad-index` for installation summary
### Examples
```
@_bmad/core/agents/dev - Activate dev agent
@_bmad/bmm/agents/architect - Activate architect agent
@_bmad/core - Include all core agents/tasks
@bmad-bmm-agents-dev - Activate development agent
@bmad-bmm-agents-architect - Activate architect agent
@bmad-bmm-workflows-create-prd - Execute create-prd workflow
@bmad-core-tasks-workflow - Reference workflow task
```
### Notes
- Rules are Manual type - only loaded when explicitly referenced
- Rules are Manual type (alwaysApply: false) - only loaded when explicitly referenced
- No automatic context pollution
- Can combine multiple agents: `@_bmad/core/agents/dev @_bmad/core/agents/test`
- All BMAD items start with `bmad-`
- Can combine multiple references: `@bmad-bmm-agents-dev @bmad-bmm-agents-architect`

View File

@ -2,25 +2,34 @@
## Activating Agents
BMAD agents are installed as chat modes in `.github/chatmodes/`.
BMAD agents are installed in `.github/agents/` with flattened
`bmad-*.agent.md` naming.
### How to Use
1. **Open Chat View**: Click Copilot icon in VS Code sidebar
2. **Select Mode**: Click mode selector (top of chat)
3. **Choose Agent**: Select the BMAD agent from dropdown
4. **Chat**: Agent is now active for this session
2. **Select Agent**: Use `@bmad-{module}-agents-{name}` to reference an agent
3. **Chat**: Agent persona is now active for this conversation
### Examples
```
@bmad-bmm-agents-pm - Activate PM agent
@bmad-bmm-agents-architect - Activate architect agent
@bmad-bmm-agents-dev - Activate development agent
```
### VS Code Settings
Configured in `.vscode/settings.json`:
- Max requests per session
- Auto-fix enabled
- MCP discovery enabled
- `chat.agent.enabled` - Enable agent mode
- `chat.agent.maxRequests` - Max requests per session
- `github.copilot.chat.agent.autoFix` - Auto-fix enabled
- `chat.mcp.discovery.enabled` - MCP discovery enabled
### Notes
- Modes persist for the chat session
- Switch modes anytime via dropdown
- Multiple agents available in mode selector
- All BMAD agents start with `bmad-`
- Agents have access to VS Code tools (edit, search, terminal, etc.)
- Agent persona persists for the chat session

View File

@ -2,21 +2,32 @@
## Activating Agents
BMAD agents are installed as workflows in `.windsurf/workflows/`.
BMAD agents are installed as workflows in `.windsurf/workflows/` with flattened
`bmad-*.md` naming.
### How to Use
1. **Open Workflows**: Access via Windsurf menu or command palette
2. **Select Workflow**: Choose the agent/task workflow
3. **Execute**: Run to activate that agent persona
1. **Type Slash Command**: Start with `/` to see available commands
2. **Select Workflow**: Choose from `bmad-` prefixed workflows
3. **Execute**: Press Enter to activate that agent persona
### Workflow Types
### Examples
- **Agent workflows**: `{module}-{agent}.md` (auto_execution_mode: 3)
- **Task workflows**: `task-{module}-{task}.md` (auto_execution_mode: 2)
```
/bmad-bmm-agents-pm - Activate PM agent
/bmad-bmm-agents-architect - Activate architect agent
/bmad-bmm-workflows-create-prd - Execute create-prd workflow
/bmad-core-tasks-workflow - Execute workflow task
```
### Execution Modes
- **Agent workflows**: `auto_execution_mode: 3` (higher autonomy)
- **Task workflows**: `auto_execution_mode: 2` (guided execution)
- **Workflow commands**: `auto_execution_mode: 1` (step-by-step)
### Notes
- Agents run with higher autonomy (mode 3)
- Tasks run with guided execution (mode 2)
- Commands are autocompleted when you type `/`
- All BMAD items start with `bmad-`
- Workflows persist for the session