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 gives you a human-directed AI development team through GitHub Copilot. Describe what you’re building and you get a team of specialists — frontend, backend, tester, lead — that live in your repository as markdown files. They persist across sessions, learn your codebase, share decisions, and help you move faster without giving up oversight. Squad is a programmable multi-agent runtime, not a chatbot wearing different hats. Each team member runs in its own isolated context, reads only its own knowledge, and writes back what it learned — so every session builds on the last.

Quickstart

Install the CLI, scaffold your team, and start your first conversation in under a minute.

CLI Commands

Full reference for every squad command — init, upgrade, triage, doctor, and more.

Concepts

Understand agents, teams, routing, casting, skills, ceremonies, and the decision log.

SDK Reference

Use @bradygaster/squad-sdk to build programmable agent pipelines in TypeScript.

What makes Squad different

Most AI coding tools give you a single context window that resets every session. Squad takes a different approach across four dimensions. Agents have isolated context. Each agent reads only its own charter.md (its role and identity) and its own history.md (what it has learned about your project). No agent sees another agent’s raw state. This prevents context bleed, keeps each specialist focused, and means a frontend agent won’t override a backend agent’s conventions. Decisions are shared. Every decision any agent makes is appended to .squad/decisions.md — a single, append-only shared brain that every agent on the team can read. No agent can unilaterally override a previous decision without leaving a traceable entry. The entire history of your team’s choices is visible, auditable, and committed to git. Work is inspectable. Because agents live as markdown files in .squad/, everything is human-readable at all times. You can open any agent’s charter.md or history.md in your editor, see exactly what the agent knows, and edit it directly. There’s no opaque database, no hidden state — it’s all text, and it’s all in your repo. Sessions are resumable. If a session is interrupted, agents resume from checkpoint. Sessions are stored in .squad/sessions/. Anyone who clones your repository inherits the full team — cast names, accumulated knowledge, routing rules, and all — without any additional setup.

Alpha notice

Squad is experimental software currently in alpha. APIs, CLI commands, and file formats may change between releases. All breaking changes are documented in CHANGELOG.md. Use the main branch and pin to a known version in production-adjacent workflows.

Monorepo structure

Squad ships as an npm workspace with two JavaScript packages and one .NET preview package. @bradygaster/squad-sdk is the core runtime library for programmable agent orchestration. It provides builder functions (defineSquad, defineAgent, defineTeam, etc.), the casting engine, skills system, state backends, SDK-first configuration, and the full public TypeScript API. Install it directly when you want to integrate Squad into your own tooling: npm install @bradygaster/squad-sdk. @bradygaster/squad-cli is the command-line interface that wraps the SDK and exposes it as the squad command. It includes squad init, squad upgrade, squad triage, squad doctor, and the full suite of 17+ commands. It requires Node.js ≥ 22.5.0. Install globally with npm install -g @bradygaster/squad-cli. Squad.Agents.AI is a preview NuGet package under src/Squad.Agents.AI for .NET developers who want to call a Squad team as a Microsoft Agent Framework agent. It registers a Squad-backed AIAgent in dependency injection and targets early 0.1.0-preview consumers.
Squad is built to amplify a human operator with GitHub Copilot — not to remove humans from the loop. People stay accountable for priorities, approvals, and final decisions. Squad handles coordination, repetition, and parallel execution. Use it to delegate faster, review better, and keep governance close to the code.

Build docs developers (and LLMs) love