squadai

README

SquadAI

Standardize AI coding agent environments across your team.

---

What It Does

One command configures every AI coding agent on your team to use the same methodology, team structure, MCP servers, and coding standards.

squadai init --methodology tdd
squadai apply

That's it. Every developer on the team gets identical agent configurations, regardless of which editor they use.

5 supported agents. OpenCode, Claude Code, VS Code Copilot, Cursor, Windsurf.

9 components. Memory protocols, team rules, editor settings, MCP servers, team agents, methodology skills, commands, plugins, workflows.

3 methodologies. TDD (6 roles), SDD (8 roles), Conventional (4 roles) — each with an orchestrator that delegates to specialized sub-agents.

3 delegation strategies. Native sub-agent files (OpenCode, Cursor), prompt-based Task tool injection (Claude Code), solo all-in-one prompts (VS Code, Windsurf).

MCP integration. Context7 enabled by default. Each agent gets MCP config in its native format.

Community skills. Vercel skills ecosystem integration via the find-skills shared skill.

---

Quick Start

# Install (macOS / Linux)
brew install PedroMosquera/tap/squadai

# Initialize with TDD methodology
squadai init --methodology tdd

# Preview changes
squadai plan --dry-run

# Apply configuration
squadai apply

# Verify compliance
squadai verify

Other install methods (curl, deb/rpm, go install, AI agent) are documented in the Installation section.

Run squadai with no arguments to launch the interactive TUI wizard (methodology, MCP servers, plugins, summary).

---

Supported Agents

Agent	Config File	Delegation	MCP Strategy
OpenCode	AGENTS.md	native (sub-agent files in .opencode/agents/)	MergeIntoSettings (opencode.json "mcp" key)
Claude Code	CLAUDE.md	prompt (Task tool injection)	MCPConfigFile (<project>/.mcp.json)
VS Code Copilot	.instructions.md	solo (all-in-one prompt)	MCPConfigFile (.vscode/mcp.json)
Cursor	.cursor/rules/squadai.mdc	native (agent files in .cursor/agents/)	MCPConfigFile (.cursor/mcp.json)
Windsurf	.windsurf/rules/squadai.md	solo + workflows	MCPConfigFile (.windsurf/mcp_config.json)

All detected agents are auto-enabled during init. The planner generates actions only for agents actually installed on each developer's machine.

---

Supported Languages

Language	Auto-detection	Standards Included
Go	go.mod	Error wrapping, table-driven tests, context.Context, MixedCaps
TypeScript	tsconfig.json	strict: true, discriminated unions, explicit return types
JavaScript	package.json	Module patterns, ESLint + Prettier, const by default
Python	pyproject.toml, requirements.txt	Type hints, dataclasses, ruff, pytest fixtures
Rust	Cargo.toml	Ownership, thiserror/anyhow, Clippy lints
Java	pom.xml, build.gradle	Sealed classes, records, Optional, Javadoc
Kotlin	build.gradle.kts	Shared Java standards
Ruby	Gemfile	RuboCop, minitest/RSpec, frozen string literals
C#	*.csproj, *.sln	Nullable refs, async/await, EditorConfig
PHP	composer.json	PSR-12, PHPStan, type declarations
Swift	Package.swift, *.xcodeproj	SwiftLint, value types, protocol-oriented
C/C++	CMakeLists.txt	Smart pointers, RAII, clang-tidy
Dart	pubspec.yaml	Null safety, Flutter widgets, effective Dart
Elixir	mix.exs	Pattern matching, GenServer, dialyzer
Scala	build.sbt	Case classes, implicits, ScalaTest

Monorepo support: when multiple languages are detected, all language standards are combined.

---

Components

squadai apply installs up to 9 components per agent:

Component	ID	What It Installs
Memory Protocol	memory	Session persistence files (AGENTS.md, CLAUDE.md) with marker blocks
Team Rules	rules	Team coding standards injected into each agent's system prompt
Editor Settings	settings	Agent-specific config files (opencode.json, .vscode/settings.json, etc.)
MCP Servers	mcp	MCP server definitions in each agent's native format
Team Agents	agents	Sub-agent role definitions (orchestrator, implementer, reviewer, etc.)
Methodology Skills	skills	Skill files for each methodology phase (TDD red-green-refactor, SDD spec workflow, etc.)
Commands	commands	Agent-specific command definitions (OpenCode .opencode/commands/)
Plugins	plugins	Third-party plugin installation (Claude Code plugins, skill files)
Workflows	workflows	Agent-specific workflow files (Windsurf .windsurf/workflows/)

Not every agent supports every component. Each adapter declares which components it handles; the planner skips unsupported combinations.

---

Methodologies

Each methodology defines a team of roles with an orchestrator that delegates work to specialized sub-agents.

TDD (6 roles)

Role	Description
orchestrator	Delegates phases to specialized sub-agents
brainstormer	Requirements exploration and question-asking
planner	Test plan and implementation plan creation
implementer	Red-green-refactor implementation cycles
reviewer	Two-stage code review: automated + design
debugger	4-phase debugging: reproduce, isolate, fix, verify

SDD (8 roles)

Role	Description
orchestrator	Manages spec-driven workflow
explorer	Codebase analysis and context gathering
proposer	Solution proposals with tradeoff analysis
spec-writer	Formal specification document authoring
designer	Architecture and interface design
task-planner	Dependency-ordered task breakdown
implementer	Spec-faithful implementation
verifier	Spec compliance verification

Conventional (4 roles)

Role	Description
orchestrator	Direct implementation with review gates
implementer	General-purpose implementation
reviewer	Code review checklist
tester	Test writing and coverage

---

Configuration

Three-Layer Merge

Configuration follows strict precedence:

Policy (locked fields)  >  Project config  >  User defaults

Layer	File	Scope
User defaults	~/.squadai/config.json	Personal preferences, backup paths
Project config	.squadai/project.json	Per-repo settings, methodology, team, MCP
Team policy	.squadai/policy.json	Locked fields that cannot be overridden

Example project.json

{
  "version": 1,
  "methodology": "tdd",
  "adapters": {
    "opencode": { "enabled": true },
    "claude-code": { "enabled": true },
    "vscode-copilot": { "enabled": true },
    "cursor": { "enabled": true },
    "windsurf": { "enabled": true }
  },
  "components": {
    "memory": { "enabled": true },
    "rules": { "enabled": true },
    "settings": { "enabled": true },
    "mcp": { "enabled": true },
    "agents": { "enabled": true },
    "skills": { "enabled": true },
    "commands": { "enabled": true },
    "plugins": { "enabled": true },
    "workflows": { "enabled": true }
  },
  "copilot": {
    "instructions_template": "standard"
  },
  "mcp": {
    "context7": {
      "type": "local",
      "command": ["npx", "-y", "@upstash/context7-mcp@latest"],
      "enabled": true
    }
  },
  "team": {
    "orchestrator": { "description": "TDD orchestrator", "mode": "subagent" },
    "brainstormer": { "description": "Requirements exploration", "mode": "subagent", "skill_ref": "tdd/brainstorming" },
    "planner": { "description": "Test plan creation", "mode": "subagent", "skill_ref": "tdd/writing-plans" },
    "implementer": { "description": "Red-green-refactor cycles", "mode": "subagent", "skill_ref": "tdd/test-driven-development" },
    "reviewer": { "description": "Two-stage code review", "mode": "subagent", "skill_ref": "shared/code-review" },
    "debugger": { "description": "Systematic debugging", "mode": "subagent", "skill_ref": "tdd/systematic-debugging" }
  },
  "meta": {
    "name": "my-project",
    "language": "go",
    "test_command": "go test -race ./...",
    "build_command": "go build ./..."
  }
}

Operational Modes

Mode	Behavior
team	Policy-controlled. Required settings enforced, locked fields immutable.
personal	User-controlled. Optional adapters and personal defaults.

Note: hybrid mode is deprecated. SquadAI resolves it automatically based on policy.json presence.

---

Commands

Command	Description
squadai init	Initialize project config and detect agents
squadai plan	Compute and display the action plan
squadai diff	Preview what apply would change (unified diffs)
squadai apply	Execute plan with backup and rollback safety (idempotent — re-run to sync)
squadai verify	Run compliance checks and print health report
squadai doctor	Run deep health checks (~22 across 6 categories); --fix resolves common issues
squadai update	Self-update: --check, --enable-checks, or download + stage latest release
squadai status	Show project health: adapters, components, managed files
squadai validate-policy	Validate policy schema and lock/required consistency
squadai backup create	Manually snapshot managed files
squadai backup list	List available backups
squadai backup delete <id>	Delete a specific backup snapshot
squadai backup prune --keep=N	Remove old backups, keep N most recent
squadai restore <id>	Restore files from a backup
squadai remove --force	Remove all managed files and strip marker blocks
squadai version	Print version

Flags

Flag	Commands	Description
--methodology=<tdd|sdd|conventional>	init	Set development methodology
--mcp=<csv>	init	Comma-separated MCP server IDs to enable
--plugins=<csv>	init	Comma-separated plugin IDs to enable
--with-policy	init	Generate team policy template
--force	init, remove	Overwrite existing template and skill files; required for remove
--merge	init	Re-run init, merge new config on top of existing (preserves customizations)
--dry-run	plan, apply, sync, restore	Preview changes without writing files
--json	plan, apply, verify, backup	Machine-readable JSON output
--keep=N	backup prune	Number of backups to retain (default 10)

Interactive TUI

Run squadai with no arguments for a guided wizard:

1. Intro screen with detected agents and mode
2. Methodology selection (TDD / SDD / Conventional)
3. MCP server configuration
4. Plugin selection (filtered by methodology and detected agents)
5. Summary and confirmation
6. Menu: Plan, Apply, Sync, Verify, Restore, Quit

---

Architecture

Six-layer architecture with strict dependency direction:

Layer 1: Domain       Types, interfaces, errors (no side effects)
Layer 2: Config       Three-layer merge with policy enforcement
Layer 3: Planner      Compute actions from merged config + detected adapters
Layer 4: Pipeline     Execute actions with backup/rollback safety
Layer 5: Verifier     Post-apply compliance assertions
Layer 6: Interfaces   CLI commands, TUI wizard

Key design principles:

• Adapters own all paths. No hardcoded agent paths outside adapter packages.
• Marker blocks for managed content. User content outside <!-- squadai:SECTION --> markers is never modified.
• Atomic writes. Temp file + rename via fileutil.WriteAtomic for crash safety.
• Idempotent by default. Planner returns ActionSkip when state matches; writer skips when bytes are identical.
• Fail loudly. Errors are always surfaced, never silently swallowed.

Full architecture details: docs/architecture.md

Safety

Every apply operation:

1. Snapshots all target files to a backup manifest
2. Executes steps in deterministic order with step-level logging
3. On failure, rolls back all completed steps from the manifest
4. Emits a failure summary with the backup ID for manual recovery

---

Installation

Homebrew (macOS / Linux) — recommended

brew install PedroMosquera/tap/squadai

To upgrade:

brew upgrade squadai

The formula is published to PedroMosquera/homebrew-tap automatically by every release.

Linux native packages (deb / rpm)

Every release publishes .deb and .rpm packages alongside the tarballs. Download the matching package from Releases:

# Debian / Ubuntu
sudo dpkg -i squadai_<version>_linux_<arch>.deb

# Fedora / RHEL / openSUSE
sudo rpm -i squadai_<version>_linux_<arch>.rpm

The binary lands at /usr/bin/squadai.

Shell script (macOS / Linux)

curl -sSL https://raw.githubusercontent.com/PedroMosquera/squadai/main/scripts/install.sh | sh

From source (requires Go 1.24+)

go install github.com/PedroMosquera/squadai/cmd/squadai@latest

GitHub Releases

Download the binary for your architecture from Releases.

Install via your AI agent

If you use Claude Code, OpenCode, Cursor, Windsurf, or VS Code Copilot, paste this prompt into your agent and let it install squadai for you:

Install squadai on this machine following the numbered steps in the "Agent install protocol" section of https://github.com/PedroMosquera/squadai/blob/main/README.md. After install, run squadai doctor and report back any failed checks.

Agent install protocol

Agents: follow these steps in order. Stop at the first method that succeeds.

1. Detect the OS and architecture with uname -sm.
2. Pick the best install method available, in this order:
   1. If brew is on PATH (macOS or Linux): brew install PedroMosquera/tap/squadai.
   2. Else if apt is available (Debian/Ubuntu) and the user can sudo: download the matching .deb from the latest GitHub release and sudo dpkg -i.
   3. Else if dnf or rpm is available (Fedora/RHEL): download the matching .rpm and sudo rpm -i.
   4. Else if curl is available (macOS / Linux): curl -sSL https://raw.githubusercontent.com/PedroMosquera/squadai/main/scripts/install.sh | sh.
   5. Else if go (>= 1.24) is on PATH: go install github.com/PedroMosquera/squadai/cmd/squadai@latest.
   6. Else: stop and tell the user to install one of brew, curl, or go first.
3. Verify the install: squadai version must print a non-empty version string.
4. Run health checks: squadai doctor. If any checks fail, run squadai doctor --fix and re-run squadai doctor.
5. Offer to initialize the workspace: ask the user if they want to run squadai init in the current directory before doing it. Do not run init without confirmation.

Do not modify shell rc files, do not install with sudo unless step 2 explicitly requires it, and do not edit any project files outside the squadai install itself.

Self-update (built-in)

Once installed, squadai can check for and apply its own updates:

squadai update --enable-checks   # opt in to once-per-day background checks
squadai update --check           # see if a newer release exists
squadai update                   # download + stage the latest; applies on next launch

Updates are disabled by default to avoid background network activity. The self-updater skips the swap if the binary lives in a system-managed path (e.g. installed via Homebrew) — use brew upgrade squadai instead.

Windows

Windows binaries (squadai_<version>_windows_<arch>.zip) are published to every release. Native installer support (Scoop / WinGet) is coming soon. For now:

# Option 1: from source (requires Go 1.24+)
go install github.com/PedroMosquera/squadai/cmd/squadai@latest

# Option 2: download the .zip from https://github.com/PedroMosquera/squadai/releases/latest
# and extract squadai.exe to a directory on your PATH.

---

Platform Support

Platform	Status
macOS (darwin/arm64, darwin/amd64)	Fully supported — Homebrew + self-update
Linux (linux/amd64, linux/arm64)	Fully supported — Homebrew + self-update
Windows (windows/amd64, windows/arm64)	Binaries published — Scoop/WinGet planned

---

Roadmap

• ✓ V2 architecture: 5 agents, 9 component installers, 3 methodologies, 3 delegation strategies, 3 MCP strategies
• ✓ Health checks (squadai doctor) with auto-fix
• ✓ Self-update (opt-in)
• ✓ Distribution: Homebrew tap, deb/rpm packages, curl|sh installer
• ⊙ Native Windows installer support (Scoop / WinGet) — planned
• ⊙ Plugin catalog expansion — planned

For tracked work, see GitHub Issues.

---

Development Process

SquadAI uses Spec-Driven Development for its own changes. The openspec/ directory tracks in-flight specs (changes/), living specs (specs/), and completed work (archive/). See openspec/config.yaml for workflow rules and testing conventions.

---

License

MIT