diff --git a/README.md b/README.md index ffe791c5..1e0ce92c 100644 --- a/README.md +++ b/README.md @@ -292,7 +292,7 @@ See the **[Core Architecture](docs/core-architecture.md)** for the complete sour - 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code - 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code) - ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI -- 💻 [Github Copilot Guide](docs/agentic-tools/github-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot +- 💻 [GitHub Copilot Guide](docs/agentic-tools/github-copilot-guide.md) - Setup and usage for GitHub Copilot ## 🌟 Beyond Software Development - Expansion Packs diff --git a/bmad-core/data/bmad-kb.md b/bmad-core/data/bmad-kb.md index f70be65d..0279d4eb 100644 --- a/bmad-core/data/bmad-kb.md +++ b/bmad-core/data/bmad-kb.md @@ -78,7 +78,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -94,7 +94,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -281,7 +281,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/dist/agents/analyst.txt b/dist/agents/analyst.txt index 80404f6e..7a23e68d 100644 --- a/dist/agents/analyst.txt +++ b/dist/agents/analyst.txt @@ -2034,7 +2034,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -2050,7 +2050,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -2237,7 +2237,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/dist/agents/bmad-master.txt b/dist/agents/bmad-master.txt index 0f2120c7..2af8dd0f 100644 --- a/dist/agents/bmad-master.txt +++ b/dist/agents/bmad-master.txt @@ -8843,7 +8843,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -8859,7 +8859,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -9046,7 +9046,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/dist/agents/bmad-orchestrator.txt b/dist/agents/bmad-orchestrator.txt index 47343841..009d1fe5 100644 --- a/dist/agents/bmad-orchestrator.txt +++ b/dist/agents/bmad-orchestrator.txt @@ -1063,7 +1063,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -1079,7 +1079,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -1266,7 +1266,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/dist/teams/team-all.txt b/dist/teams/team-all.txt index 03f110ca..c58e57fa 100644 --- a/dist/teams/team-all.txt +++ b/dist/teams/team-all.txt @@ -1552,7 +1552,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -1568,7 +1568,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -1755,7 +1755,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/dist/teams/team-fullstack.txt b/dist/teams/team-fullstack.txt index 4a68a625..e6edc792 100644 --- a/dist/teams/team-fullstack.txt +++ b/dist/teams/team-fullstack.txt @@ -1400,7 +1400,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -1416,7 +1416,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -1603,7 +1603,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/dist/teams/team-ide-minimal.txt b/dist/teams/team-ide-minimal.txt index ae278f3a..3e63089d 100644 --- a/dist/teams/team-ide-minimal.txt +++ b/dist/teams/team-ide-minimal.txt @@ -1298,7 +1298,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -1314,7 +1314,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -1501,7 +1501,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/dist/teams/team-no-ui.txt b/dist/teams/team-no-ui.txt index a52811ca..369abd9f 100644 --- a/dist/teams/team-no-ui.txt +++ b/dist/teams/team-no-ui.txt @@ -1338,7 +1338,7 @@ BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agent 5. Type `/help` to see available commands #### Option 2: IDE Integration -**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, Github Copilot users +**Best for**: Cursor, Claude Code, Windsurf, Trae, Cline, Roo Code, GitHub Copilot users ```bash # Interactive installation (recommended) @@ -1354,7 +1354,7 @@ npx bmad-method install - **Trae**: Built-in AI capabilities - **Cline**: VS Code extension with AI features - **Roo Code**: Web-based IDE with agent support - - **Github Copilot**: AI-powered coding assistant + - **GitHub Copilot**: VS Code extension with AI peer programming assistant **Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo. @@ -1541,7 +1541,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. **Chat Management Guidelines**: - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents diff --git a/docs/agentic-tools/github-copilot-guide.md b/docs/agentic-tools/github-copilot-guide.md index 7767c98a..5a94961f 100644 --- a/docs/agentic-tools/github-copilot-guide.md +++ b/docs/agentic-tools/github-copilot-guide.md @@ -1,22 +1,42 @@ -# BMad Method Guide for Github Copilot +# BMad Method Guide for GitHub Copilot For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md). ## Installation -When running `npx bmad-method install`, select **Github Copilot** 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 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 +## Using BMAD Agents in GitHub Copilot -1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list. +1. **Open GitHub Copilot chat** in VS Code (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux). +2. Select the agent you want to use from the chat input's participant selector (e.g., `@workspace` > `dev`). +3. The agent adopts that persona for the conversation. +4. Use `*help` to see the commands available for the selected agent. -## VS Code Specific Features +## Available Agents -- **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. +You can switch between agents using the chat participant selector. The following agents are available for GitHub Copilot: + +- `bmad-master` - Master Task Executor +- `dev` - Development expert +- `qa` - Quality Assurance specialist +- `ux-expert` - UX specialist + +## GitHub Copilot-Specific Features + +- **Settings**: Use the `.vscode/settings.json` file 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., from `package.json` scripts). + - `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.md` file 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 `tools` section in its `.github/chatmodes/[agent].chatmode.md` file. diff --git a/docs/bmad-workflow-guide.md b/docs/bmad-workflow-guide.md index 61bf42b6..d8ae6b84 100644 --- a/docs/bmad-workflow-guide.md +++ b/docs/bmad-workflow-guide.md @@ -22,7 +22,7 @@ The BMad Method follows a structured approach to AI-assisted software developmen ``` - Choose "Complete installation" - - Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or Github Copilot) + - Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or GitHub Copilot) 2. **Verify installation**: - `.bmad-core/` folder created with all agents @@ -114,7 +114,7 @@ Follow the SM → Dev cycle for systematic story development: - **Windsurf**: `@agent-name` (e.g., `@bmad-master`) - **Trae**: `@agent-name` (e.g., `@bmad-master`) - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`) -- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. +- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. ### Chat Management: diff --git a/tools/installer/config/install.config.yaml b/tools/installer/config/install.config.yaml index f4302bc1..5da5aa8c 100644 --- a/tools/installer/config/install.config.yaml +++ b/tools/installer/config/install.config.yaml @@ -86,6 +86,6 @@ ide-configurations: # 1. The installer creates a .github/chatmodes/ directory in your project # 2. Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector. # 3. The agent will adopt that persona for the conversation - # 4. Requires VS Code 1.99+ with `chat.agent.enabled: true` in settings + # 4. Requires VS Code 1.101+ with `chat.agent.enabled: true` in settings # 5. Agent files are stored in .github/chatmodes/ - # 6. Use `/help` to see available commands and agents \ No newline at end of file + # 6. Use `*help` to see available commands and agents \ No newline at end of file diff --git a/tools/installer/lib/ide-setup.js b/tools/installer/lib/ide-setup.js index c41efaa1..4201b2c5 100644 --- a/tools/installer/lib/ide-setup.js +++ b/tools/installer/lib/ide-setup.js @@ -66,7 +66,7 @@ class IdeSetup { case "gemini": return this.setupGeminiCli(installDir, selectedAgent); case "github-copilot": - return this.setupVsCodeCopilot(installDir, selectedAgent, spinner); + return this.setupGitHubCopilot(installDir, selectedAgent, spinner); default: console.log(chalk.yellow(`\nIDE ${ide} not yet supported`)); return false; @@ -566,7 +566,7 @@ class IdeSetup { return true; } - async setupVsCodeCopilot(installDir, selectedAgent, spinner = null) { + async setupGitHubCopilot(installDir, selectedAgent, spinner = null) { await initializeModules(); // Configure VS Code workspace settings first to avoid UI conflicts with loading spinners