Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/bradygaster/squad/llms.txt

Use this file to discover all available pages before exploring further.

Squad turns GitHub Copilot into a coordinated team of AI specialists that live in your repository as plain markdown files. Each team member runs in its own context, remembers your codebase across sessions, and writes back what it learned — so knowledge compounds every time your team works.

Quickstart

Install Squad and scaffold your first team in under a minute

CLI Commands

Reference for all 17 Squad CLI commands and their flags

Concepts

Understand agents, routing, casting, skills, and ceremonies

SDK Reference

Use the TypeScript SDK to define teams programmatically

What is Squad?

Squad gives developers a human-directed AI development team through GitHub Copilot. Describe what you’re building, and Squad scaffolds a team of specialists — frontend, backend, tester, lead — that persist across sessions, share decisions, and help you move faster without giving up oversight.
Squad is alpha software. APIs and CLI commands may change between releases. Breaking changes are documented in the CHANGELOG.

How it works

1

Install the CLI

npm install -g @bradygaster/squad-cli
2

Initialize your team

Run squad init in any git repository. Squad scaffolds a .squad/ directory with team configuration, agent charters, routing rules, and decision logs.
3

Authenticate with GitHub

gh auth login
Squad uses your GitHub Copilot access to drive agent sessions.
4

Talk to your team

Open GitHub Copilot Chat, select the Squad agent, and describe what you’re building. Your team responds with proposals and begins working in parallel.

Key capabilities

Persistent Teams

Agent charters, histories, and decisions live in .squad/ — committed to git so the whole team persists across machines and contributors

Watch Mode

Ralph automatically polls GitHub Issues, triages them to the right agents, and dispatches Copilot sessions to execute work

SDK-First Mode

Define your entire team in TypeScript using builder functions, then generate all markdown with squad build

Casting Engine

Agents get themed names from fictional universes (The Usual Suspects, Breaking Bad, etc.) that persist deterministically across sessions

Plugin Marketplace

Extend agents with community plugins for knowledge graphs, memory providers, and custom tool integrations

.NET Integration

Use Squad.Agents.AI to expose a Squad team as a Microsoft Agent Framework AIAgent in any .NET application

Explore the docs

Agents & Teams

Learn how to configure, customize, and manage your AI team members

Watch Mode

Automate issue triage and agent dispatch with Ralph’s polling loop

Skills

Add reusable skills to agents — compressed learnings that travel with your team

Samples

Eight working examples from beginner to advanced patterns

Build docs developers (and LLMs) love