Squad Documentation
Public-facing documentation for Squad. GitHub Pages ready.
Guides
- Product Guide — Complete reference for all Squad features
- Sample Prompts — Ready-to-use prompts showing what Squad can do
Feature Reference
Core
- Team Setup — Init mode, first session, team creation
- Work Routing — How work gets assigned to agents
- Parallel Execution — Background vs sync, fan-out
- Response Modes — Tiered response speed/depth
- Memory System — How agents learn and remember
- Directives — Capturing team rules and preferences
- Reviewer Protocol — Rejection lockout and revision routing
Workflow
- GitHub Issues Mode — Issue-driven development
- PRD Mode — Product requirements decomposition
- Labels & Triage — go:/release:/type:/priority: taxonomy
- Ralph — Work Monitor — Autonomous backlog processing
- Project Boards — GitHub Projects V2 integration
Team
- Human Team Members — Mixed AI/human teams
- @copilot Coding Agent — Autonomous issue agent
- Skills System — Earned knowledge with confidence lifecycle
- Ceremonies — Team meetings and rituals
- Notifications — Ping via Teams/MCP
Infrastructure
- Per-Agent Model Selection — Cost-first model routing
- Git Worktrees — Multi-branch team state
- Export & Import — Portable team snapshots
Walkthroughs
- First Session — Your first time using Squad
- GitHub Issues — Issue-driven development walkthrough
Scenarios
Getting Started
- Starting a New Project — Greenfield setup
- Adding to an Existing Repo — Drop Squad into existing code
- Mid-Project Onboarding — Adding Squad halfway through
- Upgrading Squad — Update to the latest version
Team Management
- Solo Developer — Is Squad overkill for one person?
- Mixed Human + AI Team — Humans and agents working together
- Keeping Your Squad — Persistence across projects
- Combining Old Squads — Cherry-picking from multiple teams
Project Types
- Large Codebases — Will Squad choke on a big repo?
- Monorepos — Multiple services, one squad
- Open Source Projects — Triage, contributors, community
Operations
- Client Compatibility Matrix — What works on CLI, VS Code, JetBrains, GitHub.com
- Issue-Driven Development — End-to-end issue workflow
- CI/CD Integration — Squad + GitHub Actions
- Moving a Team — Export and import between repos
- Team State Storage — Gitignore, submodules, branches, and more
- Model Selection Strategies — Budget vs quality tradeoffs
- Privacy & Security — What stays private
- Disaster Recovery — When things go wrong