Getting Started

Install the plugin, initialize your project, and start building.

1. Prerequisites

   VS Code

   • VS Code 1.113.0+ with the GitHub Copilot Chat extension

   • GitHub Copilot active subscription, signed in via the Copilot extension

   • Node.js 18+ (required for MCP servers)

   • Enable nested sub-agent workflows:

     chat.subagents.allowInvocationsFromSubagents
   GitHub Copilot CLI
   • GitHub Copilot CLI 1.0.6+
   • GitHub Copilot active subscription, authenticated via gh auth login
   • Node.js 18+ (required for MCP servers)

2. Installation

   VS Code
   Install

   If you see an error, check the Troubleshooting page.

   GitHub Copilot CLI

   Register the plugin from the marketplace, then install it:

   copilot plugin marketplace add microsoft/devsquad-copilot
   copilot plugin install devsquad@devsquad-copilot

   Direct Install (Deprecated)

   Older CLI versions support direct install via copilot plugin install microsoft/devsquad-copilot. This method is deprecated and will be removed in a future release.

   If you see an error, check the Troubleshooting page.

3. Start the Conductor

   The conductor is your single entry point agent. It detects your project state, asks questions, and delegates to specialist agents as needed.

   VS Code

   Open the Chat panel and select the conductor:

   /agents devsquad

   GitHub Copilot CLI

   copilot --agent devsquad:devsquad

   Unattended Mode

   The --yolo flag enables unattended mode, where the agent operates autonomously by automatically approving terminal commands, file changes, and tool usage without requiring user confirmation.

   copilot --agent devsquad:devsquad --yolo

   Note

   Once familiar with the workflow, you can invoke agents directly (e.g., devsquad.implement, devsquad.security). See Agents Overview for the full catalog.

4. Initialize the Project

   The conductor detects missing framework files and scaffolds them automatically. You can also ask it directly:

   Initialize my project

   This creates:

   • Config files: copilot-instructions.md, instruction files for specs/ADRs/tasks, coding guidelines, markdownlint config.
   • Documentation templates: Templates for features, migrations, envisioning, and ADRs.
   • Community files (optional): SECURITY.md, CONTRIBUTING.md, LICENSE, CODE_OF_CONDUCT.md.

   After initialization, your project structure will look like this:

   • Directory.github/

     • Directorydocs/

       • coding-guidelines.md
     • Directoryinstructions/

       • adrs.instructions.md
       • documentation-style.instructions.md
       • envisioning.instructions.md
       • migration-specs.instructions.md
       • migration-tasks.instructions.md
       • specs.instructions.md
       • tasks.instructions.md
     • copilot-instructions.md
   • Directorydocs/

     • Directoryarchitecture/

       • Directorydecisions/

         • ADR-TEMPLATE.md
     • Directoryenvisioning/

       • TEMPLATE.md
     • Directoryfeatures/

       • TEMPLATE.md
     • Directorymigrations/

       • TEMPLATE.md
   • .markdownlint.yaml

5. Build Something

   Describe what you want to build. The conductor takes you from idea to pull request, producing artifacts at each phase.

   I want to add user notification preferences - users should choose which
   notifications they receive and through which channels (email, push, in-app).

   Tip

   Follow the Build a Feature walkthrough for a step-by-step example of the full workflow.

Next Steps

Build a Feature End-to-end walkthrough from idea to pull request.

Framework Architecture Design principles, usage scenarios, and entry points.

Agents Reference Conductor, specialist agents, and nested worker flow.

Extensibility Add custom instructions, skills, agents, and hooks.

Coming from a Different Angle?

For Architects Understand the workflow, decision records, and technical design structure.

For Leadership How guardrails keep delivery predictable and traceable.

For Platform Teams Customize with your own instructions, skills, agents, and hooks.