Skip to content
Copilot Swarm

Quick Start

Prerequisites

Section titled “Prerequisites”
  • Node.js — latest LTS (v22+)
  • GitHub Copilot — active subscription (Business or Enterprise for SDK access)
  • gh CLI — optional, for GitHub issue input

Install

Section titled “Install”
Terminal window
npx @copilot-swarm/core "Add a dark mode toggle"

Your first plan + run

Section titled “Your first plan + run”

  1. Create a session to group related runs:

    Terminal window
    swarm session create "OAuth login feature"

  2. Plan — interactively refine your requirements. A PM agent asks questions to fill gaps, an engineer validates feasibility, and a designer clarifies UI/UX:

    Terminal window
    swarm plan "Add OAuth login with PKCE flow"

    During planning, agents ask targeted questions in a split-pane editor. Answer what you can, skip what’s clear. The plan is saved to .swarm/plans/plan-latest.md.

  3. Run — execute the full pipeline using the refined plan:

    Terminal window
    swarm --plan .swarm/plans/plan-latest.md

    The orchestrator will:

    • Skip the spec phase (the plan is the spec)
    • Decompose work into parallel tasks
    • Spawn engineer streams for each task
    • Run code review and QA on each stream
    • Cross-model review (if configured)
    • Verify with build/test/lint commands

  4. Review the output — check what was implemented:

    Terminal window
    swarm digest

    This shows a concise summary of what was done, key decisions, files changed, and verification status.

  5. Commit and ship:

    Terminal window
    git add -A
    git commit -m "feat: OAuth login with PKCE"
    git push

Understanding the output

Section titled “Understanding the output”

All output is organized under .swarm/ in your project:

.swarm/
  sessions/
    <sessionId>/
      session.json          # Session metadata
      runs/<runId>/
        checkpoint.json     # Resume state (deleted on success)
        summary.md          # Final summary
        roles/              # Per-agent summaries
      plans/
        plan-latest.md      # Latest plan
        plan-<timestamp>.md # Timestamped plans
      analysis/
        repo-analysis.md    # Repository analysis

What’s next?

Section titled “What’s next?”