Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/ide-info/antigravity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# BMAD Method - Google Antigravity Instructions

## Activating Agents

BMAD agents are installed as slash commands in `.agent/workflows/` with flattened
`bmad-*.md` naming.

### How to Use

1. **Type Slash Command**: Start with `/` to see available commands
2. **Select Agent**: Choose from `bmad-` prefixed commands
3. **Execute**: Press Enter to activate that agent persona

### Examples

```
/bmad-bmm-agents-dev - Activate development agent
/bmad-bmm-agents-architect - Activate architect agent
/bmad-bmm-workflows-dev-story - Execute dev-story workflow
```

### Notes

- Commands are autocompleted when you type `/`
- All BMAD items start with `bmad-`
- Agent remains active for the conversation
- Start a new conversation to switch agents
12 changes: 7 additions & 5 deletions docs/ide-info/claude-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@

## Activating Agents

BMAD agents are installed as slash commands in `.claude/commands/bmad/`.
BMAD agents are installed as slash commands in `.claude/commands/` with flattened
`bmad-*.md` naming.

### How to Use

1. **Type Slash Command**: Start with `/` to see available commands
2. **Select Agent**: Type `/bmad-{agent-name}` (e.g., `/bmad-dev`)
2. **Select Agent**: Choose from `bmad-` prefixed commands
3. **Execute**: Press Enter to activate that agent persona

### Examples

```
/bmad:bmm:agents:dev - Activate development agent
/bmad:bmm:agents:architect - Activate architect agent
/bmad:bmm:workflows:dev-story - Execute dev-story workflow
/bmad-bmm-agents-dev - Activate development agent
/bmad-bmm-agents-architect - Activate architect agent
/bmad-bmm-workflows-dev-story - Execute dev-story workflow
```

### Notes

- Commands are autocompleted when you type `/`
- All BMAD items start with `bmad-`
- Agent remains active for the conversation
- Start a new conversation to switch agents
36 changes: 16 additions & 20 deletions docs/ide-info/cline.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,26 @@

## Activating Agents

BMAD agents are installed as **toggleable rules** in `.clinerules/` directory.

### Important: Rules are OFF by default

- Rules are NOT automatically loaded to avoid context pollution
- You must manually enable the agent you want to use
BMAD agents are installed as slash commands in `.clinerules/workflows/` with
flattened `bmad-*.md` naming.

### How to Use

1. **Open Rules Panel**: Click the rules icon below the chat input
2. **Enable an Agent**: Toggle ON the specific agent rule you need (e.g., `01-core-dev`)
3. **Activate in Chat**: Type `@{agent-name}` to activate that persona
4. **Disable When Done**: Toggle OFF to free up context

### Best Practices
1. **Type Slash Command**: Start with `/` to see available commands
2. **Select Agent**: Choose from `bmad-` prefixed commands
3. **Execute**: Press Enter to activate that agent persona

- Only enable 1-2 agents at a time to preserve context
- Disable agents when switching tasks
- Rules are numbered (01-, 02-) for organization, not priority

### Example
### Examples

```
Toggle ON: 01-core-dev.md
In chat: "@dev help me refactor this code"
When done: Toggle OFF the rule
/bmad-bmm-agents-dev - Activate development agent
/bmad-bmm-agents-architect - Activate architect agent
/bmad-bmm-workflows-dev-story - Execute dev-story workflow
```

### Notes

- Commands are autocompleted when you type `/`
- All BMAD items start with `bmad-`
- Agent remains active for the conversation
- Start a new conversation to switch agents
24 changes: 11 additions & 13 deletions docs/ide-info/crush.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
21 changes: 12 additions & 9 deletions docs/ide-info/cursor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
29 changes: 19 additions & 10 deletions docs/ide-info/github-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
29 changes: 20 additions & 9 deletions docs/ide-info/windsurf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
52 changes: 52 additions & 0 deletions tools/cli/installers/lib/ide/_base-ide.js
Original file line number Diff line number Diff line change
Expand Up @@ -629,6 +629,58 @@ class BaseIdeSetup {
return `bmad-${sanitized}`;
}

/**
* Clear old BMAD files from a directory (prefix-based cleanup)
* Removes files and directories starting with 'bmad-' or named 'bmad'
* Used by IDEs with flat slash command structure (Antigravity, Codex)
* @param {string} dir - Directory to clean
* @returns {number} Number of items removed
*/
async clearBmadPrefixedFiles(dir) {
if (!(await fs.pathExists(dir))) {
return 0;
}

const entries = await fs.readdir(dir);
let removedCount = 0;

for (const entry of entries) {
if (!entry.startsWith('bmad-') && entry !== 'bmad') {
continue;
}

const entryPath = path.join(dir, entry);
const stat = await fs.stat(entryPath);
if (stat.isFile() || stat.isDirectory()) {
await fs.remove(entryPath);
removedCount++;
}
}

return removedCount;
}

/**
* Write artifacts with flattened naming to a directory
* Used by IDEs with flat slash command structure (Antigravity, Codex)
* @param {Array} artifacts - Array of artifact objects with relativePath and content
* @param {string} destDir - Destination directory
* @returns {number} Number of files written
*/
async writeFlattenedArtifacts(artifacts, destDir) {
await this.ensureDir(destDir);
let written = 0;

for (const artifact of artifacts) {
const flattenedName = this.flattenFilename(artifact.relativePath);
const targetPath = path.join(destDir, flattenedName);
await this.writeFile(targetPath, artifact.content);
written++;
}

return written;
}

/**
* Create agent configuration file
* @param {string} bmadDir - BMAD installation directory
Expand Down
Loading