2.4 KiB
2.4 KiB
BMad Method Guide for GitHub Copilot
For the complete workflow, see the BMad Workflow Guide.
Installation
When running npx bmad-method install, select GitHub Copilot as your IDE. This command will perform the following actions:
.bmad-core/folder with all agents, tasks, templates and other data files- Creates the
.vscode/directory and add asettings.jsonfile if it does not already exist, and add the basic configuration to enable GitHub Copilot's agent mode. - Creates a chatmodes file under your .github folder for each specific agent being added
Using BMAD Agents in GitHub Copilot
- Open GitHub Copilot chat in VS Code (
⌃⌘Ion Mac,Ctrl+Alt+Ion Windows/Linux). - Select the agent you want to use from the chat input's participant selector (e.g.,
@workspace>dev). - The agent adopts that persona for the conversation.
- Use
*helpto see the commands available for the selected agent.
Available Agents
You can switch between agents using the chat participant selector. The following agents are available for GitHub Copilot:
bmad-master- Master Task Executordev- Development expertqa- Quality Assurance specialistux-expert- UX specialist
GitHub Copilot-Specific Features
- Settings: Use the
.vscode/settings.jsonfile to configure Copilot behavior. The installer can configure these for you.chat.agent.maxRequests: Maximum requests per agent session (recommended: 15).github.copilot.chat.agent.runTasks: Allow agents to run workspace tasks (e.g., frompackage.jsonscripts).github.copilot.chat.agent.autoFix: Enable automatic error detection and fixing in generated code.chat.tools.autoApprove: Auto-approve ALL tools without confirmation (use with caution).
- VS Code integration: Works within VS Code's GitHub Copilot chat panel.
- Tool Confirmation: Copilot will ask for confirmation before running tools that can modify files. You can approve a tool once, for the session, or always.
Tips for GitHub Copilot Users
- You can use a
.github/copilot-instructions.mdfile to provide additional context or instructions for your projects that are not covered by the BMAD framework. - BMAD agents can come with a pre-configured set of tools. You can see which tools an agent uses by looking at the
toolssection in its.github/chatmodes/[agent].chatmode.mdfile.