@bradygaster/squad-cli 0.9.1 → 0.9.2-insider.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +329 -329
- package/dist/cli/commands/build.d.ts.map +1 -1
- package/dist/cli/commands/build.js +10 -10
- package/dist/cli/commands/build.js.map +1 -1
- package/dist/cli/commands/config.d.ts +12 -0
- package/dist/cli/commands/config.d.ts.map +1 -0
- package/dist/cli/commands/config.js +157 -0
- package/dist/cli/commands/config.js.map +1 -0
- package/dist/cli/commands/consult.d.ts.map +1 -1
- package/dist/cli/commands/consult.js +9 -4
- package/dist/cli/commands/consult.js.map +1 -1
- package/dist/cli/commands/copilot.d.ts.map +1 -1
- package/dist/cli/commands/copilot.js +8 -7
- package/dist/cli/commands/copilot.js.map +1 -1
- package/dist/cli/commands/doctor.d.ts.map +1 -1
- package/dist/cli/commands/doctor.js +50 -17
- package/dist/cli/commands/doctor.js.map +1 -1
- package/dist/cli/commands/economy.d.ts.map +1 -1
- package/dist/cli/commands/economy.js +3 -2
- package/dist/cli/commands/economy.js.map +1 -1
- package/dist/cli/commands/export.d.ts.map +1 -1
- package/dist/cli/commands/export.js +22 -16
- package/dist/cli/commands/export.js.map +1 -1
- package/dist/cli/commands/extract.d.ts.map +1 -1
- package/dist/cli/commands/extract.js +14 -10
- package/dist/cli/commands/extract.js.map +1 -1
- package/dist/cli/commands/import.d.ts.map +1 -1
- package/dist/cli/commands/import.js +21 -18
- package/dist/cli/commands/import.js.map +1 -1
- package/dist/cli/commands/init-remote.d.ts.map +1 -1
- package/dist/cli/commands/init-remote.js +7 -6
- package/dist/cli/commands/init-remote.js.map +1 -1
- package/dist/cli/commands/link.d.ts.map +1 -1
- package/dist/cli/commands/link.js +11 -10
- package/dist/cli/commands/link.js.map +1 -1
- package/dist/cli/commands/migrate.d.ts.map +1 -1
- package/dist/cli/commands/migrate.js +19 -18
- package/dist/cli/commands/migrate.js.map +1 -1
- package/dist/cli/commands/personal.d.ts.map +1 -1
- package/dist/cli/commands/personal.js +57 -65
- package/dist/cli/commands/personal.js.map +1 -1
- package/dist/cli/commands/plugin.d.ts.map +1 -1
- package/dist/cli/commands/plugin.js +8 -7
- package/dist/cli/commands/plugin.js.map +1 -1
- package/dist/cli/commands/rc.d.ts.map +1 -1
- package/dist/cli/commands/rc.js +19 -12
- package/dist/cli/commands/rc.js.map +1 -1
- package/dist/cli/commands/schedule.d.ts.map +1 -1
- package/dist/cli/commands/schedule.js +6 -5
- package/dist/cli/commands/schedule.js.map +1 -1
- package/dist/cli/commands/start.d.ts.map +1 -1
- package/dist/cli/commands/start.js +18 -11
- package/dist/cli/commands/start.js.map +1 -1
- package/dist/cli/commands/streams.d.ts.map +1 -1
- package/dist/cli/commands/streams.js +3 -2
- package/dist/cli/commands/streams.js.map +1 -1
- package/dist/cli/commands/upstream.d.ts.map +1 -1
- package/dist/cli/commands/upstream.js +23 -19
- package/dist/cli/commands/upstream.js.map +1 -1
- package/dist/cli/commands/watch/capabilities/board.d.ts +22 -0
- package/dist/cli/commands/watch/capabilities/board.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/board.js +121 -0
- package/dist/cli/commands/watch/capabilities/board.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/budget-check.d.ts +29 -0
- package/dist/cli/commands/watch/capabilities/budget-check.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/budget-check.js +38 -0
- package/dist/cli/commands/watch/capabilities/budget-check.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/circuit-breaker.d.ts +52 -0
- package/dist/cli/commands/watch/capabilities/circuit-breaker.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/circuit-breaker.js +152 -0
- package/dist/cli/commands/watch/capabilities/circuit-breaker.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/decision-hygiene.d.ts +14 -0
- package/dist/cli/commands/watch/capabilities/decision-hygiene.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/decision-hygiene.js +72 -0
- package/dist/cli/commands/watch/capabilities/decision-hygiene.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/execute.d.ts +33 -0
- package/dist/cli/commands/watch/capabilities/execute.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/execute.js +156 -0
- package/dist/cli/commands/watch/capabilities/execute.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/health-check.d.ts +29 -0
- package/dist/cli/commands/watch/capabilities/health-check.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/health-check.js +139 -0
- package/dist/cli/commands/watch/capabilities/health-check.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/heartbeat.d.ts +48 -0
- package/dist/cli/commands/watch/capabilities/heartbeat.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/heartbeat.js +115 -0
- package/dist/cli/commands/watch/capabilities/heartbeat.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/index.d.ts +9 -0
- package/dist/cli/commands/watch/capabilities/index.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/index.js +40 -0
- package/dist/cli/commands/watch/capabilities/index.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/lockfile.d.ts +30 -0
- package/dist/cli/commands/watch/capabilities/lockfile.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/lockfile.js +100 -0
- package/dist/cli/commands/watch/capabilities/lockfile.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/machine-capabilities.d.ts +30 -0
- package/dist/cli/commands/watch/capabilities/machine-capabilities.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/machine-capabilities.js +103 -0
- package/dist/cli/commands/watch/capabilities/machine-capabilities.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/monitor-email.d.ts +14 -0
- package/dist/cli/commands/watch/capabilities/monitor-email.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/monitor-email.js +54 -0
- package/dist/cli/commands/watch/capabilities/monitor-email.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/monitor-teams.d.ts +14 -0
- package/dist/cli/commands/watch/capabilities/monitor-teams.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/monitor-teams.js +55 -0
- package/dist/cli/commands/watch/capabilities/monitor-teams.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/post-failure.d.ts +19 -0
- package/dist/cli/commands/watch/capabilities/post-failure.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/post-failure.js +58 -0
- package/dist/cli/commands/watch/capabilities/post-failure.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/priority.d.ts +59 -0
- package/dist/cli/commands/watch/capabilities/priority.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/priority.js +101 -0
- package/dist/cli/commands/watch/capabilities/priority.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/rate-pool.d.ts +67 -0
- package/dist/cli/commands/watch/capabilities/rate-pool.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/rate-pool.js +187 -0
- package/dist/cli/commands/watch/capabilities/rate-pool.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/retro.d.ts +14 -0
- package/dist/cli/commands/watch/capabilities/retro.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/retro.js +81 -0
- package/dist/cli/commands/watch/capabilities/retro.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/self-pull.d.ts +14 -0
- package/dist/cli/commands/watch/capabilities/self-pull.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/self-pull.js +33 -0
- package/dist/cli/commands/watch/capabilities/self-pull.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/stale-reclaim.d.ts +23 -0
- package/dist/cli/commands/watch/capabilities/stale-reclaim.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/stale-reclaim.js +87 -0
- package/dist/cli/commands/watch/capabilities/stale-reclaim.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/two-pass.d.ts +14 -0
- package/dist/cli/commands/watch/capabilities/two-pass.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/two-pass.js +66 -0
- package/dist/cli/commands/watch/capabilities/two-pass.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/wave-dispatch.d.ts +14 -0
- package/dist/cli/commands/watch/capabilities/wave-dispatch.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/wave-dispatch.js +117 -0
- package/dist/cli/commands/watch/capabilities/wave-dispatch.js.map +1 -0
- package/dist/cli/commands/watch/capabilities/webhook-alerts.d.ts +29 -0
- package/dist/cli/commands/watch/capabilities/webhook-alerts.d.ts.map +1 -0
- package/dist/cli/commands/watch/capabilities/webhook-alerts.js +114 -0
- package/dist/cli/commands/watch/capabilities/webhook-alerts.js.map +1 -0
- package/dist/cli/commands/watch/config.d.ts +40 -0
- package/dist/cli/commands/watch/config.d.ts.map +1 -0
- package/dist/cli/commands/watch/config.js +129 -0
- package/dist/cli/commands/watch/config.js.map +1 -0
- package/dist/cli/commands/watch/index.d.ts +109 -0
- package/dist/cli/commands/watch/index.d.ts.map +1 -0
- package/dist/cli/commands/watch/index.js +757 -0
- package/dist/cli/commands/watch/index.js.map +1 -0
- package/dist/cli/commands/watch/registry.d.ts +19 -0
- package/dist/cli/commands/watch/registry.d.ts.map +1 -0
- package/dist/cli/commands/watch/registry.js +28 -0
- package/dist/cli/commands/watch/registry.js.map +1 -0
- package/dist/cli/commands/watch/types.d.ts +57 -0
- package/dist/cli/commands/watch/types.d.ts.map +1 -0
- package/dist/cli/commands/watch/types.js +8 -0
- package/dist/cli/commands/watch/types.js.map +1 -0
- package/dist/cli/core/cast.d.ts.map +1 -1
- package/dist/cli/core/cast.js +15 -19
- package/dist/cli/core/cast.js.map +1 -1
- package/dist/cli/core/detect-squad-dir.d.ts.map +1 -1
- package/dist/cli/core/detect-squad-dir.js +12 -10
- package/dist/cli/core/detect-squad-dir.js.map +1 -1
- package/dist/cli/core/email-scrub.d.ts.map +1 -1
- package/dist/cli/core/email-scrub.js +12 -11
- package/dist/cli/core/email-scrub.js.map +1 -1
- package/dist/cli/core/gh-cli.d.ts +13 -0
- package/dist/cli/core/gh-cli.d.ts.map +1 -1
- package/dist/cli/core/gh-cli.js +24 -0
- package/dist/cli/core/gh-cli.js.map +1 -1
- package/dist/cli/core/init.d.ts +2 -0
- package/dist/cli/core/init.d.ts.map +1 -1
- package/dist/cli/core/init.js +22 -5
- package/dist/cli/core/init.js.map +1 -1
- package/dist/cli/core/migrate-directory.d.ts.map +1 -1
- package/dist/cli/core/migrate-directory.js +14 -13
- package/dist/cli/core/migrate-directory.js.map +1 -1
- package/dist/cli/core/migrations.d.ts.map +1 -1
- package/dist/cli/core/migrations.js +22 -8
- package/dist/cli/core/migrations.js.map +1 -1
- package/dist/cli/core/nap.d.ts.map +1 -1
- package/dist/cli/core/nap.js +116 -49
- package/dist/cli/core/nap.js.map +1 -1
- package/dist/cli/core/project-type.d.ts.map +1 -1
- package/dist/cli/core/project-type.js +11 -10
- package/dist/cli/core/project-type.js.map +1 -1
- package/dist/cli/core/team-md.d.ts.map +1 -1
- package/dist/cli/core/team-md.js +43 -38
- package/dist/cli/core/team-md.js.map +1 -1
- package/dist/cli/core/templates.d.ts.map +1 -1
- package/dist/cli/core/templates.js +4 -3
- package/dist/cli/core/templates.js.map +1 -1
- package/dist/cli/core/upgrade.d.ts.map +1 -1
- package/dist/cli/core/upgrade.js +68 -55
- package/dist/cli/core/upgrade.js.map +1 -1
- package/dist/cli/core/version.d.ts.map +1 -1
- package/dist/cli/core/version.js +8 -7
- package/dist/cli/core/version.js.map +1 -1
- package/dist/cli/index.d.ts +1 -1
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +1 -1
- package/dist/cli/index.js.map +1 -1
- package/dist/cli/self-update.d.ts.map +1 -1
- package/dist/cli/self-update.js +7 -4
- package/dist/cli/self-update.js.map +1 -1
- package/dist/cli/shell/agent-name-parser.d.ts +16 -0
- package/dist/cli/shell/agent-name-parser.d.ts.map +1 -0
- package/dist/cli/shell/agent-name-parser.js +54 -0
- package/dist/cli/shell/agent-name-parser.js.map +1 -0
- package/dist/cli/shell/commands.d.ts.map +1 -1
- package/dist/cli/shell/commands.js +4 -3
- package/dist/cli/shell/commands.js.map +1 -1
- package/dist/cli/shell/coordinator.d.ts +4 -1
- package/dist/cli/shell/coordinator.d.ts.map +1 -1
- package/dist/cli/shell/coordinator.js +29 -26
- package/dist/cli/shell/coordinator.js.map +1 -1
- package/dist/cli/shell/index.d.ts.map +1 -1
- package/dist/cli/shell/index.js +33 -35
- package/dist/cli/shell/index.js.map +1 -1
- package/dist/cli/shell/lifecycle.d.ts +13 -2
- package/dist/cli/shell/lifecycle.d.ts.map +1 -1
- package/dist/cli/shell/lifecycle.js +26 -13
- package/dist/cli/shell/lifecycle.js.map +1 -1
- package/dist/cli/shell/session-store.d.ts.map +1 -1
- package/dist/cli/shell/session-store.js +16 -12
- package/dist/cli/shell/session-store.js.map +1 -1
- package/dist/cli/shell/spawn.d.ts +4 -1
- package/dist/cli/shell/spawn.d.ts.map +1 -1
- package/dist/cli/shell/spawn.js +28 -10
- package/dist/cli/shell/spawn.js.map +1 -1
- package/dist/cli-entry.js +136 -12
- package/dist/cli-entry.js.map +1 -1
- package/package.json +8 -4
- package/scripts/patch-esm-imports.mjs +105 -105
- package/scripts/patch-ink-rendering.mjs +115 -115
- package/templates/casting/Futurama.json +9 -9
- package/templates/casting-history.json +4 -4
- package/templates/casting-policy.json +37 -37
- package/templates/casting-reference.md +104 -104
- package/templates/casting-registry.json +3 -3
- package/templates/ceremonies.md +41 -41
- package/templates/charter.md +53 -53
- package/templates/constraint-tracking.md +38 -38
- package/templates/cooperative-rate-limiting.md +229 -229
- package/templates/copilot-instructions.md +46 -46
- package/templates/history.md +10 -10
- package/templates/identity/now.md +9 -9
- package/templates/identity/wisdom.md +15 -15
- package/templates/issue-lifecycle.md +412 -412
- package/templates/keda-scaler.md +164 -164
- package/templates/machine-capabilities.md +74 -74
- package/templates/mcp-config.md +90 -90
- package/templates/multi-agent-format.md +28 -28
- package/templates/orchestration-log.md +27 -27
- package/templates/plugin-marketplace.md +49 -49
- package/templates/ralph-circuit-breaker.md +313 -313
- package/templates/raw-agent-output.md +37 -37
- package/templates/roster.md +60 -60
- package/templates/routing.md +39 -39
- package/templates/run-output.md +50 -50
- package/templates/scribe-charter.md +123 -119
- package/templates/skill.md +24 -24
- package/templates/skills/agent-collaboration/SKILL.md +42 -42
- package/templates/skills/agent-conduct/SKILL.md +24 -24
- package/templates/skills/architectural-proposals/SKILL.md +151 -151
- package/templates/skills/ci-validation-gates/SKILL.md +84 -84
- package/templates/skills/cli-wiring/SKILL.md +47 -47
- package/templates/skills/client-compatibility/SKILL.md +89 -89
- package/templates/skills/cross-machine-coordination/SKILL.md +434 -0
- package/templates/skills/cross-squad/SKILL.md +114 -114
- package/templates/skills/distributed-mesh/SKILL.md +287 -287
- package/templates/skills/distributed-mesh/mesh.json.example +30 -30
- package/templates/skills/distributed-mesh/sync-mesh.ps1 +111 -111
- package/templates/skills/distributed-mesh/sync-mesh.sh +104 -104
- package/templates/skills/docs-standards/SKILL.md +71 -71
- package/templates/skills/economy-mode/SKILL.md +114 -114
- package/templates/skills/error-recovery/SKILL.md +99 -0
- package/templates/skills/external-comms/SKILL.md +329 -329
- package/templates/skills/gh-auth-isolation/SKILL.md +183 -183
- package/templates/skills/git-workflow/SKILL.md +204 -204
- package/templates/skills/github-multi-account/SKILL.md +95 -95
- package/templates/skills/history-hygiene/SKILL.md +36 -36
- package/templates/skills/humanizer/SKILL.md +105 -105
- package/templates/skills/init-mode/SKILL.md +102 -102
- package/templates/skills/iterative-retrieval/SKILL.md +165 -0
- package/templates/skills/model-selection/SKILL.md +117 -117
- package/templates/skills/nap/SKILL.md +24 -24
- package/templates/skills/notification-routing/SKILL.md +105 -0
- package/templates/skills/personal-squad/SKILL.md +57 -57
- package/templates/skills/pr-screenshots/SKILL.md +149 -0
- package/templates/skills/ralph-two-pass-scan/SKILL.md +35 -0
- package/templates/skills/reflect/SKILL.md +229 -0
- package/templates/skills/release-process/SKILL.md +131 -423
- package/templates/skills/reskill/SKILL.md +92 -92
- package/templates/skills/retro-enforcement/SKILL.md +148 -0
- package/templates/skills/reviewer-protocol/SKILL.md +79 -79
- package/templates/skills/secret-handling/SKILL.md +200 -200
- package/templates/skills/session-recovery/SKILL.md +155 -155
- package/templates/skills/squad-conventions/SKILL.md +69 -69
- package/templates/skills/test-discipline/SKILL.md +37 -37
- package/templates/skills/tiered-memory/SKILL.md +234 -0
- package/templates/skills/windows-compatibility/SKILL.md +98 -74
- package/templates/{squad.agent.md → squad.agent.md.template} +1316 -1287
- package/templates/workflows/squad-ci.yml +24 -24
- package/templates/workflows/squad-docs.yml +54 -54
- package/templates/workflows/squad-heartbeat.yml +0 -4
- package/templates/workflows/squad-insider-release.yml +61 -61
- package/templates/workflows/squad-issue-assign.yml +161 -161
- package/templates/workflows/squad-label-enforce.yml +181 -181
- package/templates/workflows/squad-preview.yml +55 -55
- package/templates/workflows/squad-promote.yml +120 -120
- package/templates/workflows/squad-release.yml +77 -77
- package/templates/workflows/squad-triage.yml +260 -260
- package/templates/workflows/sync-squad-labels.yml +169 -169
- package/dist/cli/commands/watch.d.ts +0 -18
- package/dist/cli/commands/watch.d.ts.map +0 -1
- package/dist/cli/commands/watch.js +0 -306
- package/dist/cli/commands/watch.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,329 +1,329 @@
|
|
|
1
|
-
# @bradygaster/squad-cli
|
|
2
|
-
|
|
3
|
-
The programmable multi-agent CLI for GitHub Copilot. Build an AI team, assign roles, and let them work your repo—automating issue triage, code review, documentation, and more through orchestrated AI agents.
|
|
4
|
-
|
|
5
|
-
> ⚠️ **Experimental** — Squad is alpha software. APIs, commands, and behavior may change between releases.
|
|
6
|
-
|
|
7
|
-
## Installation
|
|
8
|
-
|
|
9
|
-
### Prerequisites
|
|
10
|
-
|
|
11
|
-
- **Node.js ≥ 20** — Squad requires modern JavaScript runtime features
|
|
12
|
-
- **GitHub Copilot** — provides the AI backend for agent orchestration and code analysis
|
|
13
|
-
- **GitHub CLI** (`gh`) — required for issue/PR operations and the work loop
|
|
14
|
-
|
|
15
|
-
### Install from npm
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
# Global (recommended)
|
|
19
|
-
npm install -g @bradygaster/squad-cli
|
|
20
|
-
|
|
21
|
-
# Project-local
|
|
22
|
-
npm install --save-dev @bradygaster/squad-cli
|
|
23
|
-
|
|
24
|
-
# One-shot (no install)
|
|
25
|
-
npx @bradygaster/squad-cli
|
|
26
|
-
|
|
27
|
-
# Insider channel (pre-release builds)
|
|
28
|
-
npm install -g @bradygaster/squad-cli@insider
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### Verify Installation
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
squad --version
|
|
35
|
-
squad doctor # Validate setup
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## Quick Start
|
|
39
|
-
|
|
40
|
-
Get a working AI team in three steps:
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
# 1. Initialize Squad in your repo
|
|
44
|
-
squad init
|
|
45
|
-
|
|
46
|
-
# 2. Launch the interactive shell and talk to your team
|
|
47
|
-
squad
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
The `init` command creates a `.squad/` directory with default agents and configuration. Then `squad` opens a REPL where you can chat with agents, assign work, and monitor progress.
|
|
51
|
-
|
|
52
|
-
**Example:**
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
squad > @Neo, review the authentication module
|
|
56
|
-
squad > Trinity, add unit tests for the login page
|
|
57
|
-
squad > /status # See what's in progress
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
## Commands Reference
|
|
61
|
-
|
|
62
|
-
For detailed documentation on each command, see the [CLI Reference](https://docs.squad.ai/reference/cli) on the docs site.
|
|
63
|
-
|
|
64
|
-
### Core Commands
|
|
65
|
-
|
|
66
|
-
| Command | Purpose |
|
|
67
|
-
|---------|---------|
|
|
68
|
-
| `squad` | Enter interactive shell (no arguments) |
|
|
69
|
-
| `squad init` | Initialize Squad in current repo (idempotent) |
|
|
70
|
-
| `squad init --global` | Create a personal squad in your home directory |
|
|
71
|
-
| `squad status` | Show which squad is active and why |
|
|
72
|
-
| `squad doctor` | Validate setup integrity and diagnose issues |
|
|
73
|
-
| `squad upgrade` | Update Squad-owned files to latest version |
|
|
74
|
-
|
|
75
|
-
### Team Management
|
|
76
|
-
|
|
77
|
-
| Command | Purpose |
|
|
78
|
-
|---------|---------|
|
|
79
|
-
| `squad hire --name <name> --role <role>` | Add a new agent to your team |
|
|
80
|
-
| `squad copilot` | Add the @copilot coding agent |
|
|
81
|
-
| `squad copilot --off` | Remove @copilot from the team |
|
|
82
|
-
| `squad copilot --auto-assign` | Enable auto-assignment for @copilot |
|
|
83
|
-
|
|
84
|
-
### Work & Automation
|
|
85
|
-
|
|
86
|
-
| Command | Purpose |
|
|
87
|
-
|---------|---------|
|
|
88
|
-
| `squad triage` | Auto-triage issues and assign to agents |
|
|
89
|
-
| `squad triage --interval <min>` | Run triage continuously (default: 10 min) |
|
|
90
|
-
| `squad plugin` | Manage plugin marketplaces (add/remove/list/browse) |
|
|
91
|
-
|
|
92
|
-
### Export & Import
|
|
93
|
-
|
|
94
|
-
| Command | Purpose |
|
|
95
|
-
|---------|---------|
|
|
96
|
-
| `squad export` | Export team to a portable JSON snapshot |
|
|
97
|
-
| `squad export --out <path>` | Export to custom path |
|
|
98
|
-
| `squad import <file>` | Import team from snapshot (or existing squad) |
|
|
99
|
-
| `squad import <file> --force` | Replace existing team (archives old one) |
|
|
100
|
-
|
|
101
|
-
### Utilities
|
|
102
|
-
|
|
103
|
-
| Command | Purpose |
|
|
104
|
-
|---------|---------|
|
|
105
|
-
| `squad scrub-emails [directory]` | Remove email addresses from `.squad/` state files |
|
|
106
|
-
| `squad --version` | Print installed version |
|
|
107
|
-
| `squad help` | Show command help |
|
|
108
|
-
|
|
109
|
-
## Interactive Shell
|
|
110
|
-
|
|
111
|
-
Run `squad` with no arguments to enter the REPL. You'll see:
|
|
112
|
-
|
|
113
|
-
```
|
|
114
|
-
squad >
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
### Shell Commands
|
|
118
|
-
|
|
119
|
-
All shell commands start with `/`.
|
|
120
|
-
|
|
121
|
-
| Command | Purpose |
|
|
122
|
-
|---------|---------|
|
|
123
|
-
| `/status` | Show active agents, sessions, recent decisions |
|
|
124
|
-
| `/history` | View session log — tasks, decisions, agent work |
|
|
125
|
-
| `/agents` | List team members with roles and expertise |
|
|
126
|
-
| `/sessions` | List saved sessions |
|
|
127
|
-
| `/resume <id>` | Restore a past session |
|
|
128
|
-
| `/clear` | Clear terminal output |
|
|
129
|
-
| `/help` | Show all commands |
|
|
130
|
-
| `/quit` | Exit the shell (also: `Ctrl+C`) |
|
|
131
|
-
|
|
132
|
-
### Addressing Agents
|
|
133
|
-
|
|
134
|
-
Use agent names to route messages. Name matching is **case-insensitive**:
|
|
135
|
-
|
|
136
|
-
```
|
|
137
|
-
squad > @Neo, review the architecture
|
|
138
|
-
squad > @trinity fix the login bug
|
|
139
|
-
squad > Summarize the latest decisions
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
Omit the agent name and the coordinator routes to the best fit.
|
|
143
|
-
|
|
144
|
-
### Keyboard Shortcuts
|
|
145
|
-
|
|
146
|
-
| Shortcut | Action |
|
|
147
|
-
|----------|--------|
|
|
148
|
-
| `↑` / `↓` | Scroll command history |
|
|
149
|
-
| `Ctrl+A` | Jump to start of line |
|
|
150
|
-
| `Ctrl+E` | Jump to end of line |
|
|
151
|
-
| `Ctrl+U` | Clear to start of line |
|
|
152
|
-
| `Ctrl+K` | Clear to end of line |
|
|
153
|
-
| `Ctrl+W` | Delete previous word |
|
|
154
|
-
| `Ctrl+C` | Exit shell |
|
|
155
|
-
|
|
156
|
-
## .squad/ Directory Structure
|
|
157
|
-
|
|
158
|
-
When you run `squad init`, Squad creates a `.squad/` directory with this structure:
|
|
159
|
-
|
|
160
|
-
```
|
|
161
|
-
.squad/
|
|
162
|
-
├── team.md # Roster — agent names, roles, human members
|
|
163
|
-
├── routing.md # Work routing rules (which agent handles what)
|
|
164
|
-
├── decisions.md # Architectural decisions log (append-only)
|
|
165
|
-
├── directives.md # Permanent team rules and conventions
|
|
166
|
-
├── ceremonies.md # Team ceremonies and rituals
|
|
167
|
-
├── casting-state.json # Agent names, universe theme
|
|
168
|
-
├── model-config.json # Per-agent model overrides
|
|
169
|
-
├── manifest.json # Squad metadata and version
|
|
170
|
-
├── config.json # Local config (teamRoot, etc.)
|
|
171
|
-
├── agents/ # Agent knowledge files
|
|
172
|
-
│ ├── neo/
|
|
173
|
-
│ │ ├── charter.md # Role definition, expertise
|
|
174
|
-
│ │ └── history.md # Accumulated knowledge
|
|
175
|
-
│ └── ...
|
|
176
|
-
├── skills/ # Reusable knowledge (markdown files)
|
|
177
|
-
│ ├── auth-rate-limiting.md
|
|
178
|
-
│ └── ...
|
|
179
|
-
└── sessions/ # Saved REPL sessions
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
### Key Files
|
|
183
|
-
|
|
184
|
-
**`team.md`** — Defines your roster:
|
|
185
|
-
|
|
186
|
-
```markdown
|
|
187
|
-
## Team
|
|
188
|
-
|
|
189
|
-
🏗️ Neo — Lead Scope, decisions, code review
|
|
190
|
-
⚛️ Trinity — Frontend React, TypeScript, UI
|
|
191
|
-
🔧 Morpheus — Backend Node.js, Express, databases
|
|
192
|
-
🧪 Tank — Tester Jest, integration tests
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
**`routing.md`** — Controls work assignment:
|
|
196
|
-
|
|
197
|
-
```markdown
|
|
198
|
-
# Routing Rules
|
|
199
|
-
|
|
200
|
-
**Frontend changes** → Trinity
|
|
201
|
-
**Backend API work** → Morpheus
|
|
202
|
-
**Database migrations** → Morpheus
|
|
203
|
-
**Test writing** → Tank
|
|
204
|
-
**Architecture** → Neo
|
|
205
|
-
```
|
|
206
|
-
|
|
207
|
-
**`decisions.md`** — Append-only architectural log (agents read this before every task):
|
|
208
|
-
|
|
209
|
-
```markdown
|
|
210
|
-
### 2025-03-20: Use Zod for API validation
|
|
211
|
-
**By:** Morpheus
|
|
212
|
-
**What:** All API input validation uses Zod schemas
|
|
213
|
-
**Why:** Type-safe, composable, generates TypeScript types
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
**`directives.md`** — Permanent rules agents always follow:
|
|
217
|
-
|
|
218
|
-
```markdown
|
|
219
|
-
- Always use TypeScript strict mode
|
|
220
|
-
- No any/unknown casts
|
|
221
|
-
- All database queries through Prisma, no raw SQL
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
## Configuration
|
|
225
|
-
|
|
226
|
-
### .squadrc / config.json
|
|
227
|
-
|
|
228
|
-
Squad looks for `.squad/config.json` to customize behavior:
|
|
229
|
-
|
|
230
|
-
```json
|
|
231
|
-
{
|
|
232
|
-
"teamRoot": "./team-config",
|
|
233
|
-
"maxAgents": 10,
|
|
234
|
-
"modelDefaults": {
|
|
235
|
-
"temperature": 0.7
|
|
236
|
-
}
|
|
237
|
-
}
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
### Environment Variables
|
|
241
|
-
|
|
242
|
-
| Variable | Purpose | Example |
|
|
243
|
-
|----------|---------|---------|
|
|
244
|
-
| `SQUAD_CLIENT` | Detected platform | `cli`, `vscode` |
|
|
245
|
-
| `COPILOT_TOKEN` | Copilot auth token (SDK usage) | `gho_...` |
|
|
246
|
-
|
|
247
|
-
### Squad Resolution Order
|
|
248
|
-
|
|
249
|
-
When Squad starts, it looks for `.squad/` in this order:
|
|
250
|
-
|
|
251
|
-
1. Current directory (`./.squad/`)
|
|
252
|
-
2. Parent directories (walk up to project root)
|
|
253
|
-
3. Personal squad directory (platform-specific: `~/.config/squad/` on Linux, `~/Library/Application Support/squad/` on macOS, `%APPDATA%\squad\` on Windows)
|
|
254
|
-
4. Global CLI default (fallback only)
|
|
255
|
-
|
|
256
|
-
First match wins.
|
|
257
|
-
|
|
258
|
-
## Troubleshooting
|
|
259
|
-
|
|
260
|
-
### Run `squad doctor`
|
|
261
|
-
|
|
262
|
-
When something isn't working, run:
|
|
263
|
-
|
|
264
|
-
```bash
|
|
265
|
-
squad doctor
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
This performs a comprehensive diagnostic check:
|
|
269
|
-
|
|
270
|
-
- `.squad/` directory structure
|
|
271
|
-
- Required files: `team.md`, `routing.md`, `decisions.md`
|
|
272
|
-
- Agent directory and count
|
|
273
|
-
- Configuration validity
|
|
274
|
-
- Team root resolution (remote mode)
|
|
275
|
-
|
|
276
|
-
**Example output:**
|
|
277
|
-
|
|
278
|
-
```
|
|
279
|
-
🩺 Squad Doctor
|
|
280
|
-
═══════════════
|
|
281
|
-
|
|
282
|
-
Mode: local
|
|
283
|
-
|
|
284
|
-
✅ .squad/ directory exists — directory present
|
|
285
|
-
✅ team.md found — file present
|
|
286
|
-
✅ routing.md found — file present
|
|
287
|
-
✅ agents/ directory exists (4 agents)
|
|
288
|
-
✅ decisions.md exists — file present
|
|
289
|
-
|
|
290
|
-
Summary: 5 passed, 0 failed
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
### Common Issues
|
|
294
|
-
|
|
295
|
-
**Missing `.squad/` directory**
|
|
296
|
-
|
|
297
|
-
Run `squad init` to create it.
|
|
298
|
-
|
|
299
|
-
**Authentication errors**
|
|
300
|
-
|
|
301
|
-
Ensure GitHub Copilot is installed and you're authenticated. Check your token:
|
|
302
|
-
|
|
303
|
-
```bash
|
|
304
|
-
gh auth status
|
|
305
|
-
```
|
|
306
|
-
|
|
307
|
-
**Node.js version mismatch**
|
|
308
|
-
|
|
309
|
-
Squad requires Node.js ≥ 20. Check your version:
|
|
310
|
-
|
|
311
|
-
```bash
|
|
312
|
-
node --version
|
|
313
|
-
```
|
|
314
|
-
|
|
315
|
-
**ESM import errors**
|
|
316
|
-
|
|
317
|
-
Squad is an ESM-only module. If you see import errors, ensure your Node.js version is 20+.
|
|
318
|
-
|
|
319
|
-
## Links
|
|
320
|
-
|
|
321
|
-
- **Documentation:** [docs.squad.ai](https://docs.squad.ai)
|
|
322
|
-
- **CLI Reference:** [docs.squad.ai/reference/cli](https://docs.squad.ai/reference/cli) — detailed command docs
|
|
323
|
-
- **SDK:** [@bradygaster/squad-sdk](https://www.npmjs.com/package/@bradygaster/squad-sdk) — programmatic API
|
|
324
|
-
- **GitHub:** [github.com/bradygaster/squad](https://github.com/bradygaster/squad)
|
|
325
|
-
- **Issues:** [github.com/bradygaster/squad/issues](https://github.com/bradygaster/squad/issues)
|
|
326
|
-
|
|
327
|
-
## License
|
|
328
|
-
|
|
329
|
-
MIT. See [LICENSE](https://github.com/bradygaster/squad/blob/main/LICENSE) in the repository root.
|
|
1
|
+
# @bradygaster/squad-cli
|
|
2
|
+
|
|
3
|
+
The programmable multi-agent CLI for GitHub Copilot. Build an AI team, assign roles, and let them work your repo—automating issue triage, code review, documentation, and more through orchestrated AI agents.
|
|
4
|
+
|
|
5
|
+
> ⚠️ **Experimental** — Squad is alpha software. APIs, commands, and behavior may change between releases.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
### Prerequisites
|
|
10
|
+
|
|
11
|
+
- **Node.js ≥ 20** — Squad requires modern JavaScript runtime features
|
|
12
|
+
- **GitHub Copilot** — provides the AI backend for agent orchestration and code analysis
|
|
13
|
+
- **GitHub CLI** (`gh`) — required for issue/PR operations and the work loop
|
|
14
|
+
|
|
15
|
+
### Install from npm
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Global (recommended)
|
|
19
|
+
npm install -g @bradygaster/squad-cli@latest
|
|
20
|
+
|
|
21
|
+
# Project-local
|
|
22
|
+
npm install --save-dev @bradygaster/squad-cli
|
|
23
|
+
|
|
24
|
+
# One-shot (no install)
|
|
25
|
+
npx @bradygaster/squad-cli
|
|
26
|
+
|
|
27
|
+
# Insider channel (pre-release builds)
|
|
28
|
+
npm install -g @bradygaster/squad-cli@insider
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Verify Installation
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
squad --version
|
|
35
|
+
squad doctor # Validate setup
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Quick Start
|
|
39
|
+
|
|
40
|
+
Get a working AI team in three steps:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# 1. Initialize Squad in your repo
|
|
44
|
+
squad init
|
|
45
|
+
|
|
46
|
+
# 2. Launch the interactive shell and talk to your team
|
|
47
|
+
squad
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The `init` command creates a `.squad/` directory with default agents and configuration. Then `squad` opens a REPL where you can chat with agents, assign work, and monitor progress.
|
|
51
|
+
|
|
52
|
+
**Example:**
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
squad > @Neo, review the authentication module
|
|
56
|
+
squad > Trinity, add unit tests for the login page
|
|
57
|
+
squad > /status # See what's in progress
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Commands Reference
|
|
61
|
+
|
|
62
|
+
For detailed documentation on each command, see the [CLI Reference](https://docs.squad.ai/reference/cli) on the docs site.
|
|
63
|
+
|
|
64
|
+
### Core Commands
|
|
65
|
+
|
|
66
|
+
| Command | Purpose |
|
|
67
|
+
|---------|---------|
|
|
68
|
+
| `squad` | Enter interactive shell (no arguments) |
|
|
69
|
+
| `squad init` | Initialize Squad in current repo (idempotent) |
|
|
70
|
+
| `squad init --global` | Create a personal squad in your home directory |
|
|
71
|
+
| `squad status` | Show which squad is active and why |
|
|
72
|
+
| `squad doctor` | Validate setup integrity and diagnose issues |
|
|
73
|
+
| `squad upgrade` | Update Squad-owned files to latest version |
|
|
74
|
+
|
|
75
|
+
### Team Management
|
|
76
|
+
|
|
77
|
+
| Command | Purpose |
|
|
78
|
+
|---------|---------|
|
|
79
|
+
| `squad hire --name <name> --role <role>` | Add a new agent to your team |
|
|
80
|
+
| `squad copilot` | Add the @copilot coding agent |
|
|
81
|
+
| `squad copilot --off` | Remove @copilot from the team |
|
|
82
|
+
| `squad copilot --auto-assign` | Enable auto-assignment for @copilot |
|
|
83
|
+
|
|
84
|
+
### Work & Automation
|
|
85
|
+
|
|
86
|
+
| Command | Purpose |
|
|
87
|
+
|---------|---------|
|
|
88
|
+
| `squad triage` | Auto-triage issues and assign to agents |
|
|
89
|
+
| `squad triage --interval <min>` | Run triage continuously (default: 10 min) |
|
|
90
|
+
| `squad plugin` | Manage plugin marketplaces (add/remove/list/browse) |
|
|
91
|
+
|
|
92
|
+
### Export & Import
|
|
93
|
+
|
|
94
|
+
| Command | Purpose |
|
|
95
|
+
|---------|---------|
|
|
96
|
+
| `squad export` | Export team to a portable JSON snapshot |
|
|
97
|
+
| `squad export --out <path>` | Export to custom path |
|
|
98
|
+
| `squad import <file>` | Import team from snapshot (or existing squad) |
|
|
99
|
+
| `squad import <file> --force` | Replace existing team (archives old one) |
|
|
100
|
+
|
|
101
|
+
### Utilities
|
|
102
|
+
|
|
103
|
+
| Command | Purpose |
|
|
104
|
+
|---------|---------|
|
|
105
|
+
| `squad scrub-emails [directory]` | Remove email addresses from `.squad/` state files |
|
|
106
|
+
| `squad --version` | Print installed version |
|
|
107
|
+
| `squad help` | Show command help |
|
|
108
|
+
|
|
109
|
+
## Interactive Shell
|
|
110
|
+
|
|
111
|
+
Run `squad` with no arguments to enter the REPL. You'll see:
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
squad >
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Shell Commands
|
|
118
|
+
|
|
119
|
+
All shell commands start with `/`.
|
|
120
|
+
|
|
121
|
+
| Command | Purpose |
|
|
122
|
+
|---------|---------|
|
|
123
|
+
| `/status` | Show active agents, sessions, recent decisions |
|
|
124
|
+
| `/history` | View session log — tasks, decisions, agent work |
|
|
125
|
+
| `/agents` | List team members with roles and expertise |
|
|
126
|
+
| `/sessions` | List saved sessions |
|
|
127
|
+
| `/resume <id>` | Restore a past session |
|
|
128
|
+
| `/clear` | Clear terminal output |
|
|
129
|
+
| `/help` | Show all commands |
|
|
130
|
+
| `/quit` | Exit the shell (also: `Ctrl+C`) |
|
|
131
|
+
|
|
132
|
+
### Addressing Agents
|
|
133
|
+
|
|
134
|
+
Use agent names to route messages. Name matching is **case-insensitive**:
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
squad > @Neo, review the architecture
|
|
138
|
+
squad > @trinity fix the login bug
|
|
139
|
+
squad > Summarize the latest decisions
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Omit the agent name and the coordinator routes to the best fit.
|
|
143
|
+
|
|
144
|
+
### Keyboard Shortcuts
|
|
145
|
+
|
|
146
|
+
| Shortcut | Action |
|
|
147
|
+
|----------|--------|
|
|
148
|
+
| `↑` / `↓` | Scroll command history |
|
|
149
|
+
| `Ctrl+A` | Jump to start of line |
|
|
150
|
+
| `Ctrl+E` | Jump to end of line |
|
|
151
|
+
| `Ctrl+U` | Clear to start of line |
|
|
152
|
+
| `Ctrl+K` | Clear to end of line |
|
|
153
|
+
| `Ctrl+W` | Delete previous word |
|
|
154
|
+
| `Ctrl+C` | Exit shell |
|
|
155
|
+
|
|
156
|
+
## .squad/ Directory Structure
|
|
157
|
+
|
|
158
|
+
When you run `squad init`, Squad creates a `.squad/` directory with this structure:
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
.squad/
|
|
162
|
+
├── team.md # Roster — agent names, roles, human members
|
|
163
|
+
├── routing.md # Work routing rules (which agent handles what)
|
|
164
|
+
├── decisions.md # Architectural decisions log (append-only)
|
|
165
|
+
├── directives.md # Permanent team rules and conventions
|
|
166
|
+
├── ceremonies.md # Team ceremonies and rituals
|
|
167
|
+
├── casting-state.json # Agent names, universe theme
|
|
168
|
+
├── model-config.json # Per-agent model overrides
|
|
169
|
+
├── manifest.json # Squad metadata and version
|
|
170
|
+
├── config.json # Local config (teamRoot, etc.)
|
|
171
|
+
├── agents/ # Agent knowledge files
|
|
172
|
+
│ ├── neo/
|
|
173
|
+
│ │ ├── charter.md # Role definition, expertise
|
|
174
|
+
│ │ └── history.md # Accumulated knowledge
|
|
175
|
+
│ └── ...
|
|
176
|
+
├── skills/ # Reusable knowledge (markdown files)
|
|
177
|
+
│ ├── auth-rate-limiting.md
|
|
178
|
+
│ └── ...
|
|
179
|
+
└── sessions/ # Saved REPL sessions
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### Key Files
|
|
183
|
+
|
|
184
|
+
**`team.md`** — Defines your roster:
|
|
185
|
+
|
|
186
|
+
```markdown
|
|
187
|
+
## Team
|
|
188
|
+
|
|
189
|
+
🏗️ Neo — Lead Scope, decisions, code review
|
|
190
|
+
⚛️ Trinity — Frontend React, TypeScript, UI
|
|
191
|
+
🔧 Morpheus — Backend Node.js, Express, databases
|
|
192
|
+
🧪 Tank — Tester Jest, integration tests
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
**`routing.md`** — Controls work assignment:
|
|
196
|
+
|
|
197
|
+
```markdown
|
|
198
|
+
# Routing Rules
|
|
199
|
+
|
|
200
|
+
**Frontend changes** → Trinity
|
|
201
|
+
**Backend API work** → Morpheus
|
|
202
|
+
**Database migrations** → Morpheus
|
|
203
|
+
**Test writing** → Tank
|
|
204
|
+
**Architecture** → Neo
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
**`decisions.md`** — Append-only architectural log (agents read this before every task):
|
|
208
|
+
|
|
209
|
+
```markdown
|
|
210
|
+
### 2025-03-20: Use Zod for API validation
|
|
211
|
+
**By:** Morpheus
|
|
212
|
+
**What:** All API input validation uses Zod schemas
|
|
213
|
+
**Why:** Type-safe, composable, generates TypeScript types
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
**`directives.md`** — Permanent rules agents always follow:
|
|
217
|
+
|
|
218
|
+
```markdown
|
|
219
|
+
- Always use TypeScript strict mode
|
|
220
|
+
- No any/unknown casts
|
|
221
|
+
- All database queries through Prisma, no raw SQL
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
## Configuration
|
|
225
|
+
|
|
226
|
+
### .squadrc / config.json
|
|
227
|
+
|
|
228
|
+
Squad looks for `.squad/config.json` to customize behavior:
|
|
229
|
+
|
|
230
|
+
```json
|
|
231
|
+
{
|
|
232
|
+
"teamRoot": "./team-config",
|
|
233
|
+
"maxAgents": 10,
|
|
234
|
+
"modelDefaults": {
|
|
235
|
+
"temperature": 0.7
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Environment Variables
|
|
241
|
+
|
|
242
|
+
| Variable | Purpose | Example |
|
|
243
|
+
|----------|---------|---------|
|
|
244
|
+
| `SQUAD_CLIENT` | Detected platform | `cli`, `vscode` |
|
|
245
|
+
| `COPILOT_TOKEN` | Copilot auth token (SDK usage) | `gho_...` |
|
|
246
|
+
|
|
247
|
+
### Squad Resolution Order
|
|
248
|
+
|
|
249
|
+
When Squad starts, it looks for `.squad/` in this order:
|
|
250
|
+
|
|
251
|
+
1. Current directory (`./.squad/`)
|
|
252
|
+
2. Parent directories (walk up to project root)
|
|
253
|
+
3. Personal squad directory (platform-specific: `~/.config/squad/` on Linux, `~/Library/Application Support/squad/` on macOS, `%APPDATA%\squad\` on Windows)
|
|
254
|
+
4. Global CLI default (fallback only)
|
|
255
|
+
|
|
256
|
+
First match wins.
|
|
257
|
+
|
|
258
|
+
## Troubleshooting
|
|
259
|
+
|
|
260
|
+
### Run `squad doctor`
|
|
261
|
+
|
|
262
|
+
When something isn't working, run:
|
|
263
|
+
|
|
264
|
+
```bash
|
|
265
|
+
squad doctor
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
This performs a comprehensive diagnostic check:
|
|
269
|
+
|
|
270
|
+
- `.squad/` directory structure
|
|
271
|
+
- Required files: `team.md`, `routing.md`, `decisions.md`
|
|
272
|
+
- Agent directory and count
|
|
273
|
+
- Configuration validity
|
|
274
|
+
- Team root resolution (remote mode)
|
|
275
|
+
|
|
276
|
+
**Example output:**
|
|
277
|
+
|
|
278
|
+
```
|
|
279
|
+
🩺 Squad Doctor
|
|
280
|
+
═══════════════
|
|
281
|
+
|
|
282
|
+
Mode: local
|
|
283
|
+
|
|
284
|
+
✅ .squad/ directory exists — directory present
|
|
285
|
+
✅ team.md found — file present
|
|
286
|
+
✅ routing.md found — file present
|
|
287
|
+
✅ agents/ directory exists (4 agents)
|
|
288
|
+
✅ decisions.md exists — file present
|
|
289
|
+
|
|
290
|
+
Summary: 5 passed, 0 failed
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### Common Issues
|
|
294
|
+
|
|
295
|
+
**Missing `.squad/` directory**
|
|
296
|
+
|
|
297
|
+
Run `squad init` to create it.
|
|
298
|
+
|
|
299
|
+
**Authentication errors**
|
|
300
|
+
|
|
301
|
+
Ensure GitHub Copilot is installed and you're authenticated. Check your token:
|
|
302
|
+
|
|
303
|
+
```bash
|
|
304
|
+
gh auth status
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
**Node.js version mismatch**
|
|
308
|
+
|
|
309
|
+
Squad requires Node.js ≥ 20. Check your version:
|
|
310
|
+
|
|
311
|
+
```bash
|
|
312
|
+
node --version
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
**ESM import errors**
|
|
316
|
+
|
|
317
|
+
Squad is an ESM-only module. If you see import errors, ensure your Node.js version is 20+.
|
|
318
|
+
|
|
319
|
+
## Links
|
|
320
|
+
|
|
321
|
+
- **Documentation:** [docs.squad.ai](https://docs.squad.ai)
|
|
322
|
+
- **CLI Reference:** [docs.squad.ai/reference/cli](https://docs.squad.ai/reference/cli) — detailed command docs
|
|
323
|
+
- **SDK:** [@bradygaster/squad-sdk](https://www.npmjs.com/package/@bradygaster/squad-sdk) — programmatic API
|
|
324
|
+
- **GitHub:** [github.com/bradygaster/squad](https://github.com/bradygaster/squad)
|
|
325
|
+
- **Issues:** [github.com/bradygaster/squad/issues](https://github.com/bradygaster/squad/issues)
|
|
326
|
+
|
|
327
|
+
## License
|
|
328
|
+
|
|
329
|
+
MIT. See [LICENSE](https://github.com/bradygaster/squad/blob/main/LICENSE) in the repository root.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/build.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;
|
|
1
|
+
{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/build.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAidH,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwDrF"}
|