squads-cli 0.6.1 → 0.7.0

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.
Files changed (112) hide show
  1. package/README.md +196 -1152
  2. package/dist/auth-YW3UPFSB.js +23 -0
  3. package/dist/autonomy-BWTVDEAT.js +102 -0
  4. package/dist/autonomy-BWTVDEAT.js.map +1 -0
  5. package/dist/chunk-3KCWNZWW.js +401 -0
  6. package/dist/chunk-3KCWNZWW.js.map +1 -0
  7. package/dist/chunk-67RO2HKR.js +174 -0
  8. package/dist/chunk-67RO2HKR.js.map +1 -0
  9. package/dist/chunk-7JVD7RD4.js +275 -0
  10. package/dist/chunk-7JVD7RD4.js.map +1 -0
  11. package/dist/chunk-BODLDQY7.js +452 -0
  12. package/dist/chunk-BODLDQY7.js.map +1 -0
  13. package/dist/chunk-FFFCFZ6A.js +121 -0
  14. package/dist/chunk-FFFCFZ6A.js.map +1 -0
  15. package/dist/chunk-FIWT2NMM.js +165 -0
  16. package/dist/chunk-FIWT2NMM.js.map +1 -0
  17. package/dist/chunk-L6GQCHDF.js +222 -0
  18. package/dist/chunk-L6GQCHDF.js.map +1 -0
  19. package/dist/{chunk-O7UV3FWI.js → chunk-LDM62TIX.js} +2 -2
  20. package/dist/chunk-LDM62TIX.js.map +1 -0
  21. package/dist/chunk-LOA3KWYJ.js +294 -0
  22. package/dist/chunk-LOA3KWYJ.js.map +1 -0
  23. package/dist/chunk-NA45DFXY.js +616 -0
  24. package/dist/chunk-NA45DFXY.js.map +1 -0
  25. package/dist/{chunk-4CMAEQQY.js → chunk-NQN6JPI7.js} +4 -3
  26. package/dist/chunk-NQN6JPI7.js.map +1 -0
  27. package/dist/chunk-OQJHPULO.js +103 -0
  28. package/dist/chunk-OQJHPULO.js.map +1 -0
  29. package/dist/chunk-QHNUMM4V.js +87 -0
  30. package/dist/chunk-QHNUMM4V.js.map +1 -0
  31. package/dist/chunk-RM6BWILN.js +74 -0
  32. package/dist/chunk-RM6BWILN.js.map +1 -0
  33. package/dist/chunk-WBR5J7EX.js +90 -0
  34. package/dist/chunk-WBR5J7EX.js.map +1 -0
  35. package/dist/chunk-Z2UKDBNL.js +162 -0
  36. package/dist/chunk-Z2UKDBNL.js.map +1 -0
  37. package/dist/cli.js +2151 -12594
  38. package/dist/cli.js.map +1 -1
  39. package/dist/context-M2A2DOFV.js +291 -0
  40. package/dist/context-M2A2DOFV.js.map +1 -0
  41. package/dist/context-feed-JMNW4GAM.js +391 -0
  42. package/dist/context-feed-JMNW4GAM.js.map +1 -0
  43. package/dist/cost-N37I4UTA.js +274 -0
  44. package/dist/cost-N37I4UTA.js.map +1 -0
  45. package/dist/create-554W5HNU.js +286 -0
  46. package/dist/create-554W5HNU.js.map +1 -0
  47. package/dist/daemon-XWPQPPPN.js +546 -0
  48. package/dist/daemon-XWPQPPPN.js.map +1 -0
  49. package/dist/dashboard-L7YKVQEB.js +945 -0
  50. package/dist/dashboard-L7YKVQEB.js.map +1 -0
  51. package/dist/dashboard-MFNRLCEE.js +794 -0
  52. package/dist/dashboard-MFNRLCEE.js.map +1 -0
  53. package/dist/doctor-RG75M5RO.js +346 -0
  54. package/dist/doctor-RG75M5RO.js.map +1 -0
  55. package/dist/env-config-KCLDBKYX.js +21 -0
  56. package/dist/exec-JQKBF7BL.js +197 -0
  57. package/dist/exec-JQKBF7BL.js.map +1 -0
  58. package/dist/feedback-KA2UYBZG.js +229 -0
  59. package/dist/feedback-KA2UYBZG.js.map +1 -0
  60. package/dist/github-UQTM5KMS.js +23 -0
  61. package/dist/goal-EOPC5ZCD.js +168 -0
  62. package/dist/goal-EOPC5ZCD.js.map +1 -0
  63. package/dist/health-3FZDOSR5.js +209 -0
  64. package/dist/health-3FZDOSR5.js.map +1 -0
  65. package/dist/history-TFVXJEDH.js +229 -0
  66. package/dist/history-TFVXJEDH.js.map +1 -0
  67. package/dist/index.js +1 -1
  68. package/dist/index.js.map +1 -1
  69. package/dist/init-UOWTNMIE.js +747 -0
  70. package/dist/init-UOWTNMIE.js.map +1 -0
  71. package/dist/kpi-2SQ2WCVT.js +413 -0
  72. package/dist/kpi-2SQ2WCVT.js.map +1 -0
  73. package/dist/learn-6ERTERAO.js +269 -0
  74. package/dist/learn-6ERTERAO.js.map +1 -0
  75. package/dist/list-KSOMUBMB.js +92 -0
  76. package/dist/list-KSOMUBMB.js.map +1 -0
  77. package/dist/login-ST6PAXYE.js +155 -0
  78. package/dist/login-ST6PAXYE.js.map +1 -0
  79. package/dist/memory-3CSNKXIL.js +562 -0
  80. package/dist/memory-3CSNKXIL.js.map +1 -0
  81. package/dist/progress-FKG4V2VH.js +202 -0
  82. package/dist/progress-FKG4V2VH.js.map +1 -0
  83. package/dist/providers-66PDCORB.js +65 -0
  84. package/dist/providers-66PDCORB.js.map +1 -0
  85. package/dist/results-2MJFLWEO.js +224 -0
  86. package/dist/results-2MJFLWEO.js.map +1 -0
  87. package/dist/run-72OQLH5A.js +2685 -0
  88. package/dist/run-72OQLH5A.js.map +1 -0
  89. package/dist/session-6H67XPAQ.js +64 -0
  90. package/dist/session-6H67XPAQ.js.map +1 -0
  91. package/dist/{chunk-NHGLXN2F.js → sessions-GVQIMN4W.js} +23 -459
  92. package/dist/sessions-GVQIMN4W.js.map +1 -0
  93. package/dist/{squad-parser-4BI3G4RS.js → squad-parser-CM3HOIWM.js} +2 -2
  94. package/dist/squad-parser-CM3HOIWM.js.map +1 -0
  95. package/dist/stats-ONZI557Q.js +335 -0
  96. package/dist/stats-ONZI557Q.js.map +1 -0
  97. package/dist/status-FYH42FTB.js +346 -0
  98. package/dist/status-FYH42FTB.js.map +1 -0
  99. package/dist/sync-HJZJNXHW.js +800 -0
  100. package/dist/sync-HJZJNXHW.js.map +1 -0
  101. package/dist/update-B4WMUOPO.js +83 -0
  102. package/dist/update-B4WMUOPO.js.map +1 -0
  103. package/dist/{update-ALJKFFM7.js → update-L7FGHN6W.js} +2 -2
  104. package/dist/update-L7FGHN6W.js.map +1 -0
  105. package/package.json +18 -10
  106. package/dist/chunk-4CMAEQQY.js.map +0 -1
  107. package/dist/chunk-NHGLXN2F.js.map +0 -1
  108. package/dist/chunk-O7UV3FWI.js.map +0 -1
  109. package/dist/sessions-6PB7ALCE.js +0 -16
  110. /package/dist/{sessions-6PB7ALCE.js.map → auth-YW3UPFSB.js.map} +0 -0
  111. /package/dist/{squad-parser-4BI3G4RS.js.map → env-config-KCLDBKYX.js.map} +0 -0
  112. /package/dist/{update-ALJKFFM7.js.map → github-UQTM5KMS.js.map} +0 -0
package/README.md CHANGED
@@ -1,1096 +1,168 @@
1
- # squads-cli
1
+ <div align="center">
2
2
 
3
- [![npm version](https://img.shields.io/npm/v/squads-cli)](https://www.npmjs.com/package/squads-cli)
4
- [![npm downloads](https://img.shields.io/npm/dw/squads-cli)](https://www.npmjs.com/package/squads-cli)
5
- [![GitHub stars](https://img.shields.io/github/stars/agents-squads/squads-cli?style=social)](https://github.com/agents-squads/squads-cli)
6
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
7
- [![Docs](https://img.shields.io/badge/docs-agents--squads.com-purple)](https://agents-squads.com/docs)
8
-
9
- **Build your AI workforce.** Finance, marketing, engineering, operations — AI agents organized into domain-aligned squads that actually run your business.
10
-
11
- 📖 **[Documentation](https://agents-squads.com/docs)** · 🚀 **[Getting Started](https://agents-squads.com/onboarding)** · 💡 **[Architecture Guide](https://agents-squads.com/engineering/squads-architecture)**
12
-
13
- ```bash
14
- npm install -g squads-cli && squads init
15
- ```
16
-
17
- > **Why squads?** A full business team costs $1M+/year. An AI workforce costs API calls. Squads organizes AI agents by business domain — giving them persistent memory, goals, and coordinated execution. Your agents, your data, no lock-in. Works with Claude, GPT-4, Gemini, and more.
18
-
19
- ![squads dashboard](./assets/dashboard.png)
20
-
21
- ⭐ **If you find this useful, [star the repo](https://github.com/agents-squads/squads-cli)** — it helps others discover it!
22
-
23
- ```
24
- $ squads status
25
-
26
- squads status
27
- ● 7 active sessions across 1 squad (claude 7)
28
-
29
- 10/10 squads │ memory: enabled
30
-
31
- ┌────────────────────────────────────────────────────────┐
32
- │ SQUAD AGENTS MEMORY ACTIVITY │
33
- ├────────────────────────────────────────────────────────┤
34
- │ cli 7 1 entry today │
35
- │ engineering 6 1 entry today │
36
- │ intelligence 17 1 entry 4d ago │
37
- │ marketing 4 2 entries today │
38
- │ website 10 1 entry 5d ago │
39
- └────────────────────────────────────────────────────────┘
40
- ```
41
-
42
- ## Traditional Hiring vs AI Workforce
43
-
44
- | | Traditional Team | AI Workforce (squads-cli) |
45
- |---|---|---|
46
- | **Cost** | $1M+/year for a small team | API calls ($50-500/month) |
47
- | **Availability** | 8 hours/day, 5 days/week | 24/7, including weekends |
48
- | **Scale** | Hire, train, onboard (months) | Add a markdown file (minutes) |
49
- | **Ownership** | Vendor contracts, platforms | Your agents, your data, your system |
50
- | **Memory** | Tribal knowledge, Notion docs | Persistent state across sessions |
3
+ # squads
51
4
 
52
- ## Why squads-cli?
5
+ **Your AI workforce**
53
6
 
54
- | Other Frameworks | squads-cli |
55
- |------------------|------------|
56
- | Framework lock-in | Markdown files you own |
57
- | Complex setup | `npm install -g` and go |
58
- | No memory | Persistent state across sessions |
59
- | Single agent focus | Domain-aligned teams |
60
- | Code-heavy | CLI-first, zero code to start |
7
+ One person + AI teammates = a real business.
61
8
 
62
- **Works with:** Claude Code, Cursor, Aider, Gemini, GitHub Copilot, and more.
9
+ [![npm version](https://img.shields.io/npm/v/squads-cli.svg)](https://www.npmjs.com/package/squads-cli)
10
+ [![npm downloads](https://img.shields.io/npm/dw/squads-cli.svg)](https://www.npmjs.com/package/squads-cli)
11
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
12
+ [![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg)](https://nodejs.org)
13
+ [![GitHub stars](https://img.shields.io/github/stars/agents-squads/squads-cli?style=social)](https://github.com/agents-squads/squads-cli)
63
14
 
64
- ## Key Features
15
+ [Documentation](https://agents-squads.com/docs) · [Getting Started](https://agents-squads.com/onboarding) · [Architecture](https://agents-squads.com/engineering/squads-architecture)
65
16
 
66
- - **Squads** — Group agents by domain (engineering, research, marketing)
67
- - **Memory** — Persistent state that survives across sessions
68
- - **Goals** — Track objectives and measure progress
69
- - **Sessions** — Real-time detection of running AI assistants
70
- - **Hooks** — Inject context at session start, sync memory at session end
71
- - **Stack** — Optional local infrastructure for telemetry and cost tracking
17
+ </div>
72
18
 
73
- No complex infrastructure. Just markdown files and a CLI.
19
+ ---
74
20
 
75
- ## Installation
21
+ Squads organizes AI agents into domain-aligned teams -- marketing, engineering, finance, operations -- that coordinate work, remember what they learn, and track goals over time. Agents are plain markdown files. No framework lock-in, no proprietary formats. Works with any LLM provider.
76
22
 
77
- ```bash
78
- npm install -g squads-cli
79
- ```
23
+ ![squads dashboard](./assets/dashboard.png)
80
24
 
81
25
  ## Quick Start
82
26
 
83
27
  ```bash
84
- # Initialize in your project
28
+ npm install -g squads-cli
85
29
  squads init
86
-
87
- # See what you have
88
- squads status
89
-
90
- # Full dashboard with goals and metrics
91
- squads dash
92
-
93
- # Run a squad
94
- squads run engineering
95
-
96
- # Search memory
97
- squads memory query "authentication"
98
-
99
- # Set a goal
100
- squads goal set engineering "Ship v2.0 by Friday"
101
- ```
102
-
103
- **Expected output after `squads init`:**
104
-
105
30
  ```
106
- squads init
107
-
108
- ✓ Created .agents/squads/ directory
109
- ✓ Created example squad: engineering
110
- ✓ Created .agents/memory/ directory
111
-
112
- Next steps:
113
- $ squads status See your new squad
114
- $ squads dash Full dashboard view
115
- ```
116
-
117
- ## Features
118
-
119
- ### Dashboard
120
-
121
- View comprehensive metrics across all squads:
122
-
123
- ```
124
- $ squads dash
125
-
126
- squads dashboard
127
- ● 7 active sessions across 1 squad (claude 7)
128
-
129
- 8/10 squads │ 404 commits │ use -f for PRs/issues
130
-
131
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 35% goal progress
132
-
133
- ┌──────────────────────────────────────────────────────────┐
134
- │ SQUAD COMMITS PRs ISSUES GOALS PROGRESS │
135
- ├──────────────────────────────────────────────────────────┤
136
- │ marketing 203 0 0/0 9/12 ━━━━━━━━ │
137
- │ website 203 0 0/0 0/1 ━━━━━━━━ │
138
- │ engineering 139 0 0/0 0/1 ━━━━━━━━ │
139
- │ cli 48 0 0/0 2/3 ━━━━━━━━ │
140
- └──────────────────────────────────────────────────────────┘
141
-
142
- Git Activity (30d)
143
- Last 14d: ▁▁▁▁▁▁▁▄▆▄▆▅█▂
144
- 404 commits │ 13.5/day │ 21 active days
145
- ```
146
-
147
- **CEO Mode** provides an executive summary:
148
-
149
- ```
150
- $ squads dash --ceo
151
-
152
- squads CEO Report
153
- 2026-01-05
154
-
155
- ┌─────────────────────────────────────┐
156
- │ METRIC VALUE │
157
- ├─────────────────────────────────────┤
158
- │ Active Squads 8/10 │
159
- │ P0 Goals 3 │
160
- │ P1 Goals 5 │
161
- │ Blockers 2 │
162
- │ Daily Spend $12.50 / $50 │
163
- └─────────────────────────────────────┘
164
-
165
- P0 Priorities (revenue/launch critical)
166
- ✗ customer Generate first consulting revenue
167
- ✗ website Launch public website
168
- ```
169
-
170
- ### Memory Search
171
-
172
- ```
173
- $ squads memory query "telemetry"
174
-
175
- squads memory query "telemetry"
176
-
177
- 5 results found
178
-
179
- ┌──────────────────────────────────────────────────┐
180
- │ LOCATION TYPE SCORE │
181
- ├──────────────────────────────────────────────────┤
182
- │ cli/cli-lead state 7.2 │
183
- │ engineering/eng-lead state 7.2 │
184
- │ marketing/marketing-lead state 7.2 │
185
- └──────────────────────────────────────────────────┘
186
-
187
- Matches
188
- ◇ Telemetry pipeline COMPLETE. Dashboard showing real-time...
189
- └ cli/cli-lead
190
- ```
191
-
192
- ### Session Detection
193
-
194
- Real-time detection of running AI coding assistants:
195
31
 
196
32
  ```
197
33
  $ squads status
198
34
 
199
- 7 active sessions across 1 squad (claude 7)
200
- ```
201
-
202
- Supports multiple tools:
203
- - Claude Code
204
- - Cursor
205
- - Aider
206
- - Gemini
207
- - GitHub Copilot
208
- - Sourcegraph Cody
209
- - Continue
210
-
211
- ### Stack Management
212
-
213
- Local Docker infrastructure for telemetry and memory:
214
-
215
- ```
216
- $ squads stack health
217
-
218
- squads stack health
219
-
220
- ✓ postgres healthy
221
- ✓ redis healthy
222
- ✓ neo4j healthy
223
- ✓ bridge healthy
224
- ✓ langfuse healthy
225
- ✓ mem0 healthy
226
- ✓ engram healthy
227
-
228
- ● 8/8 services healthy
229
- ```
230
-
231
- **Valid services for `squads stack logs`:**
232
- - `postgres` - PostgreSQL database
233
- - `redis` - Redis cache
234
- - `neo4j` - Graph database
235
- - `bridge` - Conversation capture API
236
- - `langfuse` - Telemetry dashboard
237
- - `mem0` - Memory extraction
238
- - `engram` - Memory MCP server
239
- - `otel` - OpenTelemetry collector
240
-
241
- ### Auto-Update
242
-
243
- ```
244
- $ squads status
245
-
246
- ⬆ Update available: 0.1.2 → 0.2.0 (run `squads update`)
247
-
248
- $ squads update
249
- Checking npm registry...
250
- ⬆ Update available: 0.1.2 → 0.2.0
251
- Update now? [y/N]: y
252
- Installing update...
253
- ● Updated to 0.2.0
254
- ```
255
-
256
- ### Agent History
257
-
258
- Track and review agent execution history with costs and performance metrics:
259
-
260
- ```
261
- $ squads history
262
-
263
- squads history
264
-
265
- Last 7 days of agent executions
266
-
267
- ┌────────────────────────────────────────────────────────────┐
268
- │ TIMESTAMP SQUAD AGENT COST STATUS │
269
- ├────────────────────────────────────────────────────────────┤
270
- │ 2026-01-06 10:30 engineering ci-lead $0.45 ✓ │
271
- │ 2026-01-06 09:15 website seo-critic $0.23 ✓ │
272
- │ 2026-01-05 16:20 customer lead $0.89 ✓ │
273
- └────────────────────────────────────────────────────────────┘
274
-
275
- Total cost: $1.57 │ 3 executions
276
- ```
277
-
278
- Filter by squad and get detailed metrics:
279
-
280
- ```bash
281
- squads history -s engineering -v # Verbose with token details
282
- squads history -d 30 -j # Last 30 days, JSON output
283
- ```
284
-
285
- ### Context Feed
286
-
287
- Get curated context for agents based on goals, memory, and recent activity:
288
-
289
- ```bash
290
- # Human-readable summary
291
- squads context -s engineering
292
-
293
- # JSON for agent consumption
294
- squads context -s engineering --json
295
-
296
- # Search memory for specific topic
297
- squads context -t "authentication" -s website
298
- ```
299
-
300
- Perfect for injecting relevant context into agent prompts or hooks.
301
-
302
- ### Live Monitoring
303
-
304
- **Watch Mode** — Refresh any command in real-time:
305
-
306
- ```bash
307
- squads watch status # Refresh every 2 seconds
308
- squads watch "dash --ceo" -n 5 # Custom interval
309
- ```
310
-
311
- **Live Dashboard** — Interactive TUI like htop:
312
-
313
- ```bash
314
- squads live # Full dashboard
315
- ```
316
-
317
- **Process Table** — Real-time process monitoring:
318
-
319
- ```bash
320
- squads top # Live process table
321
- ```
322
-
323
- ### Infrastructure Health
324
-
325
- Quick health check across all services without verbose Docker output:
326
-
327
- ```
328
- $ squads health
329
-
330
- squads health
331
-
332
- ✓ postgres healthy
333
- ✓ redis healthy
334
- ✓ bridge healthy
335
- ✓ langfuse healthy
336
-
337
- ● 4/4 core services healthy
338
- ```
339
-
340
- Use `-v` to see logs for failing services.
341
-
342
- ## Core Concepts
343
-
344
- ### Squads = Domain-Aligned Teams
345
-
346
- ```
347
- .agents/squads/
348
- ├── engineering/
349
- │ ├── SQUAD.md # Squad config + goals
350
- │ └── ci-optimizer.md # Agent definition
351
- ├── research/
352
- │ ├── SQUAD.md
353
- │ └── market-analyst.md
354
- └── intelligence/
355
- └── ...
356
- ```
357
-
358
- ### Agents = Markdown Prompts
359
-
360
- ```markdown
361
- # CI Optimizer
362
-
363
- ## Purpose
364
- Reduce build times and optimize CI/CD pipelines.
365
-
366
- ## Model
367
- claude-sonnet-4
368
-
369
- ## Tools
370
- - Bash(gh:*, git:*)
371
- - Read
372
- - Edit
373
-
374
- ## Instructions
375
- 1. Analyze current build configuration
376
- 2. Identify slow steps
377
- 3. Implement caching strategies
378
- 4. Verify improvements
379
- ```
380
-
381
- ### Memory = Cross-Session State
382
-
383
- Memory files are stored at `.agents/memory/<squad>/<agent>/<type>.md`:
384
-
385
- ```
386
- .agents/memory/
387
- ├── engineering/
388
- │ └── eng-lead/
389
- │ ├── state.md # Current state
390
- │ ├── learnings.md # Accumulated insights
391
- │ └── feedback.md # Execution feedback
392
- └── research/
393
- └── analyst/
394
- └── state.md
395
- ```
396
-
397
- ```bash
398
- # Agents accumulate knowledge
399
- squads memory show engineering
400
- # → "Switched to pnpm for faster installs"
401
- # → "Build cache reduced CI time by 40%"
402
-
403
- # Search across all squads
404
- squads memory query "performance"
405
- ```
406
-
407
- ### Learning Loop
408
-
409
- Capture insights that persist across sessions:
410
-
411
- ```bash
412
- # After fixing a bug
413
- squads learn "PostgreSQL connection pool exhaustion was caused by unclosed transactions"
414
-
415
- # With metadata
416
- squads learn "Always check memory before researching" --squad engineering --category pattern
417
-
418
- # View learnings
419
- squads learnings show engineering
420
- squads learnings search "postgres"
421
- ```
422
-
423
- Learnings are stored in `.agents/memory/<squad>/shared/learnings.md` and sync with `squads memory sync`.
424
-
425
- **Categories:**
426
- - `success` — What worked well
427
- - `failure` — What didn't work (learn from mistakes)
428
- - `pattern` — Reusable approach
429
- - `tip` — General advice
430
-
431
- **The learning loop:**
432
- 1. Session starts → hooks inject squad status + memory
433
- 2. Work happens → you solve problems, discover things
434
- 3. Session ends → Stop hook prompts "Capture learnings: squads learn..."
435
- 4. Next session → Previous learnings compound via memory queries
436
-
437
- ### Goals with Metrics
438
-
439
- Goals can include optional metric annotations for tracking KPIs:
440
-
441
- ```bash
442
- # Set a goal with metrics
443
- squads goal set finance "Reduce monthly costs by 20%" --metric "cost_usd" --metric "savings_pct"
444
-
445
- # View goals with progress
446
- squads goal list
447
-
448
- finance
449
- ● [1] Reduce monthly costs by 20%
450
- └ Current: $450/mo, target: $400/mo
451
- ```
452
-
453
- ### Learning Extraction
454
-
455
- Extract learnings from recent conversations and store in Engram:
456
-
457
- ```bash
458
- # Extract memories from last 24 hours
459
- squads memory extract
460
-
461
- # Preview without storing
462
- squads memory extract --dry-run
463
-
464
- # Extract from specific time window
465
- squads memory extract --hours 48
466
- ```
467
-
468
- ## Commands
469
-
470
- ### Initialization
471
-
472
- ```bash
473
- squads init # Initialize project with default template
474
- squads init -t minimal # Use minimal template
475
- ```
476
-
477
- ### Status & Dashboard
478
-
479
- ```bash
480
- squads status # All squads overview
481
- squads status engineering # Single squad details
482
- squads status -v # Verbose with agent list
483
-
484
- squads dash # Full dashboard with goals (fast mode)
485
- squads dash -f # Include GitHub PR/issue stats (~30s slower)
486
- squads dash --ceo # Executive summary with priorities and blockers
487
- squads dash -v # Additional details
488
- ```
489
-
490
- ### Running Agents
491
-
492
- ```bash
493
- squads run engineering # Run the whole squad
494
- squads run engineering/ci-optimizer # Run specific agent (slash notation)
495
- squads run engineering -a ci-optimizer # Run specific agent (flag notation)
496
- squads run engineering --dry-run # Preview what would run
497
- squads run engineering --execute # Execute via Claude CLI
498
- squads run engineering --parallel # Run all agents in parallel
499
- squads run engineering --lead # Lead mode: single orchestrator with Task agents
500
- squads run engineering --foreground # Run in foreground (no tmux)
501
- squads run engineering --timeout 60 # Set timeout in minutes (default: 30)
502
- ```
503
-
504
- ### Memory Management
505
-
506
- ```bash
507
- # Query (semantic search across markdown files)
508
- squads memory query "deployment" # Search all memory
509
- squads memory query "auth" -s website # Filter by squad
510
- squads memory query "cache" -a lead # Filter by agent
511
-
512
- # View
513
- squads memory show research # View squad memory
514
- squads memory list # List all entries
515
-
516
- # Update
517
- squads memory update cli "Fixed telemetry bug" # Add to learnings
518
- squads memory update cli "State: ready" -t state # Update state
519
- squads memory update cli "Good" -a cli-lead -t feedback # Add feedback
520
-
521
- # Sync (git-based)
522
- squads memory sync # Pull remote, process commits
523
- squads memory sync -v # Verbose output
524
- squads memory sync -p # Push local changes after sync
525
- squads memory sync --no-pull # Skip pulling from remote
526
-
527
- # Search (postgres via squads-bridge)
528
- squads memory search "authentication" # Search stored conversations
529
- squads memory search "error" -l 20 # Limit results
530
- squads memory search "api" -r user # Filter by role (user/assistant/thinking)
531
- squads memory search "bug" -i high # Filter by importance (low/normal/high)
532
-
533
- # Extract (conversations → Engram memories)
534
- squads memory extract # Extract from last 24h
535
- squads memory extract -h 48 # Extract from last 48h
536
- squads memory extract -s abc123 # Extract specific session
537
- squads memory extract -d # Dry run (preview only)
538
- ```
539
-
540
- ### Execution History
541
-
542
- View and analyze past agent executions:
543
-
544
- ```bash
545
- $ squads exec list
35
+ squads status
36
+ ● 3 active sessions across 2 squads (claude 2, gemini 1)
546
37
 
547
- squads exec list
38
+ 4/4 squads | memory: enabled
548
39
 
549
- ┌────────────────────────────────────────────────────────────────────────────────────┐
550
- AGENT STATUS DURATION TIME ID │
551
- ├────────────────────────────────────────────────────────────────────────────────────┤
552
- cli/code-eval ● completed 5m 30s 2h ago exec_abc123_xyz │
553
- │ website/web-lead running — 3h ago exec_def456_abc │
554
- └────────────────────────────────────────────────────────────────────────────────────┘
40
+ SQUAD AGENTS MEMORY ACTIVITY
41
+ engineering 3 4 entries today
42
+ marketing 2 2 entries today
43
+ research 5 1 entry yesterday
44
+ operations 2 -- 3d ago
555
45
  ```
556
46
 
557
47
  ```bash
558
- squads exec list # Recent executions
559
- squads exec list --squad cli # Filter by squad
560
- squads exec list --status completed # Filter by status
561
- squads exec show <id> # Execution details
562
- squads exec stats # Statistics across all executions
563
- squads exec --json # JSON output for programmatic access
564
- ```
48
+ # Run a specific agent
49
+ squads run engineering/code-review
565
50
 
566
- ### Goal Tracking
51
+ # Run an entire squad in parallel
52
+ squads run engineering --parallel
567
53
 
568
- ```bash
569
- squads goal set finance "Cut costs 20%" # Set goal
570
- squads goal set finance "Track API usage" -m "api_calls" -m "cost_usd" # With metrics
571
- squads goal list # View all active goals
572
- squads goal list -a # Include completed goals
573
- squads goal list finance # View goals for one squad
574
- squads goal progress finance 1 "Reduced to $400/mo" # Update progress (index, text)
575
- squads goal complete finance 1 # Mark done (by index)
576
- ```
54
+ # Search across all agent memory
55
+ squads memory query "authentication patterns"
577
56
 
578
- ### Feedback Loop
579
-
580
- ```bash
581
- squads feedback add research 4 "Good analysis" # Rate 1-5 with comment
582
- squads feedback add cli 5 "Excellent" -l "Cache key insight" # With learning
583
- squads feedback show research # View history
584
- squads feedback show research -n 10 # Show more entries
585
- squads feedback stats # Summary across all squads
57
+ # Set and track goals
58
+ squads goal set engineering "Ship v2.0 by Friday"
59
+ squads dash
586
60
  ```
587
61
 
588
- ### Learnings
62
+ ## Why Squads
589
63
 
590
- ```bash
591
- squads learn "Insight here" # Capture a learning
592
- squads learn "Pattern" -s engineering -c pattern # With squad and category
593
- squads learn "Tip" -t "cli,perf" # With tags
594
- squads learnings show engineering # View squad learnings
595
- squads learnings show engineering -n 5 # Limit results
596
- squads learnings show engineering --category pattern # Filter by category
597
- squads learnings show engineering --tag perf # Filter by tag
598
- squads learnings search "postgres" # Search all learnings
599
- ```
64
+ **Agents are markdown files.** No DSLs, no YAML pipelines, no SDKs. A squad is a directory. An agent is a `.md` file with a role, model preference, and instructions. You own everything -- version it, edit it, fork it.
600
65
 
601
- ### Session Management
66
+ **Multi-provider by default.** Route agents to the right model for the job. Claude for deep reasoning, Gemini for speed, GPT-4o for breadth, Ollama for local execution. Switch providers per agent or per run with a single flag.
602
67
 
603
- ```bash
604
- # List sessions
605
- squads sessions # Show active sessions
606
- squads sessions -v # With session details
607
- squads sessions -j # JSON output
608
-
609
- # History
610
- squads sessions history # Last 7 days
611
- squads sessions history -d 30 # Last 30 days
612
- squads sessions history -s website # Filter by squad
613
- squads sessions history -j # JSON output
614
-
615
- # Summary
616
- squads sessions summary # Auto-detect current session
617
- squads sessions summary -f data.json # From JSON file
618
- squads sessions summary -j # Output as JSON
619
-
620
- # Lifecycle (for hooks/automation)
621
- squads session start # Register new session
622
- squads session start -s engineering # Override squad detection
623
- squads session start -q # Quiet mode
624
- squads session stop # End current session
625
- squads session stop -q # Quiet mode
626
- squads session heartbeat # Update session activity
627
- squads session heartbeat -q # Quiet mode
628
-
629
- # Detection
630
- squads detect-squad # Detect current squad from cwd
631
- ```
68
+ **Memory that persists.** Agents accumulate knowledge across sessions. Learnings survive restarts, context carries forward, and any agent can search the collective memory of the organization.
632
69
 
633
- ### Progress Tracking
70
+ **Goals, not just tasks.** Set objectives at the squad level, track progress through KPIs, and get executive summaries. Squads is a business operating system, not a script runner.
634
71
 
635
- ```bash
636
- squads progress # Show active/completed tasks
637
- squads progress -v # More activity details
638
- squads progress start engineering "Fixing CI" # Register task
639
- squads progress complete abc123 # Mark task completed
640
- squads progress complete abc123 -f # Mark as failed
641
- ```
72
+ ## Supported Providers
642
73
 
643
- ### Results & KPIs
74
+ | Provider | CLI | Models |
75
+ |----------|-----|--------|
76
+ | Anthropic | `claude` | Opus, Sonnet, Haiku |
77
+ | Google | `gemini` | Gemini 2.5 Flash, Pro |
78
+ | OpenAI | `codex` | GPT-4o, o1, o3 |
79
+ | Mistral | `vibe` | Large, Medium |
80
+ | xAI | `grok` | Grok |
81
+ | Aider | `aider` | Multi-model |
82
+ | Ollama | `ollama` | Any local model |
644
83
 
645
84
  ```bash
646
- squads results # All squads, last 7 days
647
- squads results engineering # Single squad
648
- squads results -d 30 # Last 30 days
649
- squads results -v # Detailed KPIs per goal
650
- ```
85
+ # Use a specific provider for a run
86
+ squads run research --provider=google --model=gemini-2.5-flash
651
87
 
652
- ### Workers
653
-
654
- ```bash
655
- squads workers # Show Claude sessions, tasks, dev servers
656
- squads workers -v # More details
657
- squads workers -k 12345 # Kill process by PID
88
+ # Check which providers are available
89
+ squads providers
658
90
  ```
659
91
 
660
- ### Issues Management
92
+ ## Features
661
93
 
662
- ```bash
663
- # View issues
664
- squads issues # Show GitHub issues
665
- squads issues -o my-org # Different organization
666
- squads issues -r repo1,repo2 # Specific repos
667
-
668
- # Solve issues (create PRs)
669
- squads solve-issues # Solve ready-to-fix issues
670
- squads solve-issues -r hq # Target specific repo
671
- squads solve-issues -i 123 # Solve specific issue
672
- squads solve-issues -d # Dry run
673
- squads solve-issues -e # Execute with Claude CLI
674
-
675
- # Open issues (run evaluators)
676
- squads open-issues # Find new issues via evaluators
677
- squads open-issues -s website # Target squad
678
- squads open-issues -a seo-critic # Specific evaluator
679
- squads open-issues -d # Dry run
680
- squads open-issues -e # Execute with Claude CLI
681
- ```
94
+ ### Dashboard
682
95
 
683
- ### Stack Management
96
+ Full visibility into squad activity, goal progress, and git contribution metrics.
684
97
 
685
- ```bash
686
- # Setup
687
- squads stack init # Interactive setup wizard
688
-
689
- # Status
690
- squads stack status # Container health overview
691
- squads stack health # Comprehensive diagnostics
692
- squads stack health -v # Show logs for unhealthy services
693
- squads stack env # Print export commands
694
-
695
- # Control
696
- squads stack up # Start Docker containers
697
- squads stack down # Stop Docker containers
698
- squads stack logs bridge # View container logs
699
- squads stack logs postgres -n 100 # Last 100 lines
700
98
  ```
99
+ $ squads dash
701
100
 
702
- ### Tonight Mode (Autonomous Execution)
703
-
704
- Run agents autonomously overnight with safety guardrails:
705
-
706
- ```bash
707
- # Run intelligence squad overnight
708
- squads tonight intelligence
709
-
710
- # Multiple targets with cost cap
711
- squads tonight intelligence customer/outreach --cost-cap 25
712
-
713
- # Preview what would run
714
- squads tonight engineering --dry-run
715
-
716
- # Check status while running
717
- squads tonight status
101
+ squads dashboard
102
+ ● 7 active sessions across 3 squads
718
103
 
719
- # Stop all overnight agents
720
- squads tonight stop
104
+ 8/10 squads | 404 commits | use -f for PRs/issues
721
105
 
722
- # View the morning report
723
- squads tonight report
724
- ```
106
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 35% goal progress
725
107
 
726
- **Example output:**
108
+ SQUAD COMMITS PRs ISSUES GOALS PROGRESS
109
+ marketing 203 0 0/0 9/12 ━━━━━━━━
110
+ engineering 139 0 0/0 0/1 ━━━━━━━━
111
+ cli 48 0 0/0 2/3 ━━━━━━━━
727
112
 
113
+ Git Activity (30d)
114
+ Last 14d: ▁▁▁▁▁▁▁▄▆▄▆▅█▂
115
+ 404 commits | 13.5/day | 21 active days
728
116
  ```
729
- $ squads tonight intelligence customer/outreach
730
-
731
- squads tonight
732
-
733
- Config:
734
- Cost cap: $50
735
- Stop at: 07:00
736
- Max retries: 3
737
- Targets: intelligence, customer/outreach
738
117
 
739
- Launched 2 agent(s)
118
+ The `--ceo` flag produces an executive summary with P0/P1 priorities and spend tracking.
740
119
 
741
- Tonight mode active
120
+ ### Memory System
742
121
 
743
- Monitor:
744
- squads tonight status - Check progress
745
- squads tonight stop - Kill all agents
746
- tmux ls | grep tonight - List sessions
747
-
748
- Logs: .agents/outputs/tonight/
749
- ```
750
-
751
- **Safety features:**
752
- - **Cost cap** — Automatically stops when spending limit reached (default: $50)
753
- - **Time limit** — Stops at specified time (default: 7:00 AM)
754
- - **Max retries** — Limits restart attempts for crashed agents (default: 3)
755
- - **Session isolation** — Each agent runs in isolated tmux session
756
- - **Logging** — All output captured to `.agents/outputs/tonight/`
757
- - **Morning report** — Summary generated on completion
758
-
759
- **Monitoring commands:**
122
+ Agents write learnings as they work. The memory system makes that knowledge searchable and shareable across the organization.
760
123
 
761
124
  ```bash
762
- # Check current status
763
- squads tonight status
764
-
765
- # Attach to a running session
766
- tmux attach -t squads-tonight-intelligence-...
125
+ # Capture a learning from the command line
126
+ squads memory write engineering "Redis connection pooling requires min 5 connections for our load"
767
127
 
768
- # View live logs
769
- tail -f .agents/outputs/tonight/*.log
128
+ # Search all agent memory
129
+ squads memory query "deployment"
770
130
 
771
- # Stop everything immediately
772
- squads tonight stop
131
+ # View a specific squad's accumulated knowledge
132
+ squads memory read engineering
773
133
  ```
774
134
 
775
- > **Warning**: Tonight mode uses `--dangerously-skip-permissions` which bypasses
776
- > Claude's safety confirmations. Only use with trusted agent definitions. Review
777
- > your agent prompts and ensure they have appropriate scope limits before running
778
- > autonomously.
779
-
780
- ### Smart Triggers
781
-
782
- Triggers execute agents based on conditions in PostgreSQL:
135
+ ### Session Detection
783
136
 
784
- ```bash
785
- squads trigger list # View all triggers
786
- squads trigger list engineering # Filter by squad
787
- squads trigger sync # Sync SQUAD.md → Postgres
788
- squads trigger fire cost-alert # Manually fire a trigger
789
- squads trigger enable cost-alert # Enable a trigger
790
- squads trigger disable cost-alert # Disable a trigger
791
- squads trigger status # Scheduler health & stats
792
- ```
137
+ Automatically detects running AI coding sessions across your machine and maps them to squads based on working directory.
793
138
 
794
- **Trigger definition in SQUAD.md:**
795
-
796
- ```yaml
797
- triggers:
798
- - name: cost-alert
799
- agent: cost-tracker
800
- condition: |
801
- SELECT value > 100
802
- FROM latest_metrics
803
- WHERE name = 'daily_cost_usd'
804
- cooldown: 6 hours
805
- priority: 3
806
139
  ```
140
+ $ squads sessions
807
141
 
808
- ### List & Discovery
809
-
810
- ```bash
811
- squads list # List all squads and agents
812
- squads list -s # Squads only
813
- squads list -a # Agents only
142
+ 4 active sessions
143
+ claude engineering/backend ~/projects/api 12m
144
+ claude engineering/frontend ~/projects/web 3m
145
+ gemini research/analyst ~/projects/research 45m
146
+ cursor marketing/content ~/projects/site 8m
814
147
  ```
815
148
 
816
- ### Authentication (Pro & Enterprise)
149
+ Supports: Claude Code, Cursor, Aider, Gemini, GitHub Copilot, Sourcegraph Cody, Continue.
817
150
 
818
- ```bash
819
- squads login # Log in to Squads cloud
820
- squads logout # Log out
821
- squads whoami # Show current user
822
- ```
151
+ ### Autonomous Execution
823
152
 
824
- ### Updates
153
+ Schedule agents to run on their own with the local daemon.
825
154
 
826
155
  ```bash
827
- squads update # Interactive update
828
- squads update -y # Auto-confirm
829
- squads update -c # Check only, don't install
830
- ```
831
-
832
- ## Command Reference
156
+ # Start the autonomous scheduler
157
+ squads autonomous start
833
158
 
159
+ # Check what's running
160
+ squads autonomous status
834
161
  ```
835
- squads init Initialize project
836
- -t, --template <template> Project template (default)
837
-
838
- squads status [squad] Show squad status
839
- -v, --verbose Include agent details
840
-
841
- squads dash Full dashboard with goals
842
- -v, --verbose Show additional details
843
- -c, --ceo Executive summary with priorities
844
- -f, --full Include GitHub PR/issue stats (~30s)
845
-
846
- squads run <target> Run squad or agent
847
- -v, --verbose Verbose output
848
- -d, --dry-run Preview only
849
- -e, --execute Execute via Claude CLI
850
- -a, --agent <agent> Run specific agent within squad
851
- -t, --timeout <minutes> Execution timeout (default: 30)
852
- -p, --parallel Run all agents in parallel
853
- -l, --lead Lead mode: single orchestrator using Task tool
854
- -f, --foreground Run in foreground (no tmux)
855
-
856
- squads list List all squads/agents
857
- -s, --squads Squads only
858
- -a, --agents Agents only
859
-
860
- squads memory query <query> Search memory
861
- -s, --squad <squad> Filter by squad
862
- -a, --agent <agent> Filter by agent
863
- squads memory show <squad> View squad memory
864
- squads memory update <squad> <text> Add to memory
865
- -a, --agent <agent> Specific agent (default: squad-lead)
866
- -t, --type <type> Memory type: state, learnings, feedback
867
- squads memory list List all entries
868
- squads memory sync Sync from git
869
- -v, --verbose Detailed output
870
- -p, --push Push after sync
871
- --no-pull Skip pulling
872
- squads memory search <query> Search postgres conversations
873
- -l, --limit <n> Number of results (default: 10)
874
- -r, --role <role> Filter: user, assistant, thinking
875
- -i, --importance <level> Filter: low, normal, high
876
- squads memory extract Extract memories to Engram
877
- -s, --session <id> Specific session
878
- -h, --hours <n> Hours to look back (default: 24)
879
- -d, --dry-run Preview only
880
-
881
- squads goal set <squad> <goal> Set a goal
882
- -m, --metric <metrics...> Metrics to track
883
- squads goal list [squad] List goals
884
- -a, --all Include completed
885
- squads goal progress <squad> <idx> <text> Update progress
886
- squads goal complete <squad> <idx> Mark completed
887
-
888
- squads feedback add <squad> <1-5> <text> Rate execution
889
- -l, --learning <learnings...> Extract learnings
890
- squads feedback show <squad> View history
891
- -n, --limit <n> Entries to show (default: 5)
892
- squads feedback stats Summary across squads
893
-
894
- squads learn <insight> Capture a learning
895
- -s, --squad <squad> Associate with squad (default: general)
896
- -c, --category <category> Category: success, failure, pattern, tip
897
- -t, --tags <tags> Comma-separated tags
898
- --context <context> Additional context
899
- squads learnings show <squad> View squad learnings
900
- -n, --limit <n> Entries to show (default: 10)
901
- --category <category> Filter by category
902
- --tag <tag> Filter by tag
903
- squads learnings search <query> Search all learnings
904
- -n, --limit <n> Results to show (default: 10)
905
-
906
- squads sessions List active sessions
907
- -v, --verbose Session details
908
- -j, --json JSON output
909
- squads sessions history Session history
910
- -d, --days <n> Days of history (default: 7)
911
- -s, --squad <squad> Filter by squad
912
- -j, --json JSON output
913
- squads sessions summary Pretty session summary
914
- -d, --data <json> JSON data
915
- -f, --file <path> JSON file path
916
- -j, --json JSON output
917
-
918
- squads session start Register session
919
- -s, --squad <squad> Override detection
920
- -q, --quiet Suppress output
921
- squads session stop End session
922
- -q, --quiet Suppress output
923
- squads session heartbeat Update activity
924
- -q, --quiet Suppress output
925
-
926
- squads detect-squad Detect squad from cwd
927
-
928
- squads progress Show task progress
929
- -v, --verbose More details
930
- squads progress start <squad> <desc> Register task
931
- squads progress complete <id> Mark completed
932
- -f, --failed Mark as failed
933
-
934
- squads results [squad] KPI goals vs actuals
935
- -d, --days <n> Days to look back (default: 7)
936
- -v, --verbose Detailed KPIs
937
-
938
- squads workers Show active workers
939
- -v, --verbose More details
940
- -k, --kill <pid> Kill process
941
-
942
- squads context Business context for alignment
943
- -s, --squad <squad> Focus on specific squad
944
- -t, --topic <topic> Search memory for relevant context
945
- -v, --verbose Show additional details
946
- --json JSON output
947
-
948
- squads history Recent agent execution history
949
- -d, --days <n> Days to look back (default: 7)
950
- -s, --squad <squad> Filter by squad
951
- -v, --verbose Show cost and token details
952
- -j, --json JSON output
953
-
954
- squads health Quick infrastructure health check
955
- -v, --verbose Show logs for failures
956
- --json JSON output
957
-
958
- squads watch <command> [args] Live refresh any command (like Unix watch)
959
- -n, --interval <seconds> Refresh interval (default: 2)
960
-
961
- squads live Live TUI dashboard (like htop)
962
- -r, --refresh <ms> Refresh rate (default: 1000)
963
-
964
- squads top Live process table (like Unix top)
965
-
966
- squads version Show version information
967
-
968
- squads env show <squad> Squad execution environment (MCP, model, budget)
969
- --json JSON output
970
- squads env list List all squad environments
971
- --json JSON output
972
-
973
- squads cost Cost summary (today, week, by squad)
974
- -s, --squad <squad> Filter to specific squad
975
- --json JSON output
976
-
977
- squads budget <squad> Check budget status for a squad
978
- --json JSON output
979
-
980
- squads issues GitHub issues
981
- -o, --org <org> Organization (default: agents-squads)
982
- -r, --repos <repos> Comma-separated repos
983
-
984
- squads solve-issues Solve issues with PRs
985
- -r, --repo <repo> Target repo
986
- -i, --issue <number> Specific issue
987
- -d, --dry-run Preview only
988
- -e, --execute Execute with Claude
989
-
990
- squads open-issues Find new issues
991
- -s, --squad <squad> Target squad
992
- -a, --agent <agent> Evaluator agent
993
- -d, --dry-run Preview only
994
- -e, --execute Execute with Claude
995
-
996
- squads stack init Setup wizard
997
- squads stack status Container health
998
- squads stack health Full diagnostics
999
- -v, --verbose Show logs for failures
1000
- squads stack env Print exports
1001
- squads stack up Start containers
1002
- squads stack down Stop containers
1003
- squads stack logs <service> View logs
1004
- -n, --tail <lines> Lines to show (default: 50)
1005
-
1006
- squads trigger list [squad] List triggers
1007
- squads trigger sync Sync to scheduler
1008
- squads trigger fire <name> Fire trigger
1009
- squads trigger enable <name> Enable trigger
1010
- squads trigger disable <name> Disable trigger
1011
- squads trigger status Scheduler stats
1012
-
1013
- squads exec list List recent executions
1014
- -s, --squad <squad> Filter by squad
1015
- -a, --agent <agent> Filter by agent
1016
- --status <status> Filter: running, completed, failed
1017
- -n, --limit <n> Results to show (default: 20)
1018
- --json JSON output
1019
- squads exec show <id> Execution details
1020
- --json JSON output
1021
- squads exec stats Execution statistics
1022
- -s, --squad <squad> Filter by squad
1023
- --json JSON output
1024
-
1025
- squads tonight <targets...> Autonomous overnight execution
1026
- --cost-cap <usd> Max spend (default: $50)
1027
- --stop-at <time> Stop time HH:MM (default: 07:00)
1028
- --max-retries <n> Restart limit (default: 3)
1029
- -d, --dry-run Preview only
1030
- -v, --verbose Verbose output
1031
- squads tonight status Check progress
1032
- squads tonight stop Kill all agents
1033
- squads tonight report View morning report
1034
-
1035
- squads cron sync Sync agent schedules to launchd (macOS)
1036
- squads cron list [squad] List scheduled agents
1037
- squads cron status Show launchd status and next runs
1038
- squads cron enable <agent> Enable an agent's schedule
1039
- squads cron disable <agent> Disable an agent's schedule
1040
- squads cron logs [agent] Show execution logs
1041
-
1042
- squads approval send <type> Send approval request to Slack
1043
- squads approval list List pending approvals
1044
- squads approval check <id> Check approval status
1045
- squads approval cancel <id> Cancel pending approval
1046
-
1047
- squads orchestrate <squad> Run squad with lead agent orchestration
1048
- -f, --foreground Run in foreground (no tmux)
1049
-
1050
- squads skill list List uploaded skills
1051
- squads skill upload <path> Upload skill directory to Anthropic API
1052
- squads skill delete <id> Delete a skill
1053
- squads skill show <id> Show skill details
1054
- squads skill convert <agent> Convert agent.md to SKILL.md format
1055
-
1056
- squads permissions show <squad> Show permission context for a squad
1057
- squads permissions check <squad> Validate permissions before execution
1058
- -a, --agent <agent> Specify agent for context
1059
-
1060
- squads slack sync Sync squad channels with Slack
1061
- squads slack channels List Slack channels
1062
- squads slack test Test Slack connection
1063
-
1064
- squads providers Show available LLM CLI providers
1065
- --json JSON output
1066
-
1067
- squads autonomy Show autonomy score and confidence metrics
1068
- -s, --squad <squad> Filter by squad
1069
- -p, --period <period> Period: today, week, month
1070
- --json JSON output
1071
-
1072
- squads kpi show <squad> Show KPI status for a squad
1073
- squads kpi record <squad> <kpi> <value> Record KPI value
1074
- squads kpi trend <squad> <kpi> Show KPI trend over time
1075
- squads kpi insights <squad> Generate AI insights from KPIs
1076
- --json JSON output
1077
-
1078
- squads update Interactive update
1079
- -y, --yes Auto-confirm
1080
- -c, --check Check only
1081
-
1082
- squads login Log in (Pro)
1083
- squads logout Log out
1084
- squads whoami Show user
1085
- ```
1086
-
1087
- ## Claude Code Integration
1088
162
 
1089
- For comprehensive documentation on hooks and skills, see the **[Hooks and Skills Guide](https://agents-squads.com/engineering/hooks-and-skills)**.
163
+ ### Claude Code Integration
1090
164
 
1091
- ### Option 1: Session Hooks (Recommended)
1092
-
1093
- Add to `.claude/settings.json`:
165
+ Add hooks to `.claude/settings.json` so every Claude Code session starts with squad context:
1094
166
 
1095
167
  ```json
1096
168
  {
@@ -1098,185 +170,153 @@ Add to `.claude/settings.json`:
1098
170
  "SessionStart": [{
1099
171
  "hooks": [{
1100
172
  "type": "command",
1101
- "command": "squads status",
173
+ "command": "squads session start",
1102
174
  "timeout": 10
1103
175
  }]
1104
- }],
1105
- "Stop": [{
1106
- "hooks": [{
1107
- "type": "command",
1108
- "command": "squads memory sync && echo \"\\n💡 Capture learnings: squads learn \\\"<insight>\\\"\\n\"",
1109
- "timeout": 15
1110
- }]
1111
176
  }]
1112
177
  }
1113
178
  }
1114
179
  ```
1115
180
 
1116
- Now every Claude Code session:
1117
- - **Starts** with squad status injected
1118
- - **Ends** with memory synced and a prompt to capture learnings
1119
-
1120
- ### Option 2: CLAUDE.md Instructions
1121
-
1122
- ```markdown
1123
- ## Squads Workflow
181
+ ## Commands
1124
182
 
1125
- Before starting work:
1126
- 1. Run `squads status` to see current state
1127
- 2. Run `squads memory query "<topic>"` to check existing knowledge
1128
- 3. After completing work, update memory via state files
1129
- ```
183
+ | Command | Description |
184
+ |---------|-------------|
185
+ | `squads init` | Initialize squads in your project |
186
+ | `squads status [squad]` | Overview of all squads and active sessions |
187
+ | `squads run <target>` | Run a squad or specific agent |
188
+ | `squads dash [name]` | Dashboard with goals, metrics, and git activity |
189
+ | `squads env show <squad>` | View squad execution environment |
190
+ | `squads env prompt <squad> -a <agent>` | Generate agent execution prompt |
191
+ | `squads memory query <q>` | Search across all agent memory |
192
+ | `squads memory write <squad> <insight>` | Persist a learning |
193
+ | `squads memory read <squad>` | View squad memory |
194
+ | `squads goal set <squad> <goal>` | Set a squad objective |
195
+ | `squads goal list` | View all goals and progress |
196
+ | `squads exec list` | View recent execution history |
197
+ | `squads sessions` | Show active AI coding sessions |
198
+ | `squads autonomous start` | Start the local execution daemon |
199
+ | `squads providers` | List available LLM providers |
200
+ | `squads eval <target>` | Evaluate agent readiness |
201
+ | `squads cost` | Cost summary by squad and time period |
202
+ | `squads kpi show <squad>` | Track squad KPIs |
203
+ | `squads sync` | Synchronize memory state |
204
+ | `squads health` | Infrastructure health check |
205
+ | `squads update` | Check for and install updates |
206
+
207
+ Run `squads --help` for the full command reference, or `squads <command> --help` for detailed options.
1130
208
 
1131
209
  ## Project Structure
1132
210
 
211
+ After `squads init`, your project gets a `.agents/` directory:
212
+
1133
213
  ```
1134
214
  your-project/
1135
215
  ├── .agents/
1136
- │ ├── squads/ # Squad definitions
216
+ │ ├── squads/ # Squad definitions
1137
217
  │ │ ├── engineering/
1138
- │ │ │ ├── SQUAD.md # Config + goals
1139
- │ │ │ └── *.md # Agent definitions
1140
- │ │ └── research/
1141
- ├── memory/ # Persistent state
218
+ │ │ │ ├── SQUAD.md # Squad config, goals, KPIs
219
+ │ │ │ ├── code-review.md # Agent: role, model, instructions
220
+ │ │ └── backend.md # Agent: another team member
221
+ │ └── marketing/
222
+ │ │ ├── SQUAD.md
223
+ │ │ └── content.md
224
+ │ ├── memory/ # Persistent state (auto-managed)
1142
225
  │ │ ├── engineering/
1143
- │ │ └── eng-lead/
1144
- │ │ ├── state.md
1145
- │ │ │ ├── learnings.md
1146
- │ │ │ └── feedback.md
1147
- │ │ └── research/
1148
- │ ├── outputs/ # Agent outputs
1149
- │ └── sessions/
1150
- │ └── history.jsonl # Session event log
1151
- ├── .claude/
1152
- │ └── settings.json # Hooks config
1153
- └── CLAUDE.md # Project instructions
226
+ │ │ └── marketing/
227
+ └── outputs/ # Agent work products
228
+ └── CLAUDE.md # Optional: project-level AI context
1154
229
  ```
1155
230
 
1156
- ## Analytics
1157
-
1158
- Track token usage, costs, and API calls across your squads.
1159
-
1160
- ### Setup
1161
-
1162
- 1. **Configure your Claude plan:**
1163
- ```bash
1164
- export SQUADS_PLAN_TYPE=max # $200/mo flat rate
1165
- # or
1166
- export SQUADS_PLAN_TYPE=usage # pay-per-token
1167
- ```
1168
-
1169
- 2. **Connect to telemetry (optional):**
1170
- ```bash
1171
- # Self-hosted via Docker
1172
- cd docker && docker-compose up -d
231
+ Everything is plain text. Version it with git, review it in PRs, edit it in any editor.
1173
232
 
1174
- # Or configure external services
1175
- export LANGFUSE_HOST=https://your-langfuse.com
1176
- export LANGFUSE_PUBLIC_KEY=pk-...
1177
- export LANGFUSE_SECRET_KEY=sk-...
1178
- ```
233
+ ## Configuration
1179
234
 
1180
- 3. **View in dashboard:**
1181
- ```bash
1182
- squads dash
1183
- ```
235
+ ### Agent Definition
1184
236
 
1185
- ### Metrics Tracked
237
+ Each agent is a markdown file with YAML frontmatter:
1186
238
 
1187
- - Token usage (input/output/cache)
1188
- - API costs per squad/agent
1189
- - Rate limit status
1190
- - Generation counts
1191
-
1192
- ## Infrastructure
1193
-
1194
- Optional services that enhance squad capabilities.
1195
-
1196
- ### Services
239
+ ```markdown
240
+ ---
241
+ model: sonnet
242
+ provider: anthropic
243
+ effort: high
244
+ timeout: 30
245
+ ---
1197
246
 
1198
- | Service | Purpose |
1199
- |---------|---------|
1200
- | postgres | Session storage, trigger conditions |
1201
- | redis | Caching, rate limiting |
1202
- | otel | OpenTelemetry metrics pipeline |
1203
- | langfuse | Telemetry dashboard |
1204
- | bridge | Conversation capture API |
247
+ # Code Review Agent
1205
248
 
1206
- ### Self-Hosted Setup
249
+ You review pull requests for correctness, security, and style.
1207
250
 
1208
- ```bash
1209
- # Clone the infrastructure
1210
- git clone https://github.com/agents-squads/squads-infra
1211
- cd squads-infra
251
+ ## Instructions
252
+ - Check for common vulnerability patterns
253
+ - Verify test coverage for new code paths
254
+ - Flag any breaking API changes
255
+ ```
1212
256
 
1213
- # Start services
1214
- docker-compose up -d
257
+ ### Squad Definition
1215
258
 
1216
- # Configure CLI
1217
- squads stack env >> ~/.zshrc
1218
- source ~/.zshrc
259
+ `SQUAD.md` configures the team:
1219
260
 
1220
- # Verify
1221
- squads stack health
1222
- ```
261
+ ```markdown
262
+ ---
263
+ agents:
264
+ - code-review
265
+ - backend
266
+ - frontend
267
+ model: sonnet
268
+ provider: anthropic
269
+ ---
1223
270
 
1224
- ### Minimal Setup (Postgres only)
271
+ # Engineering Squad
1225
272
 
1226
- ```bash
1227
- # Just need triggers and session storage
1228
- docker run -d --name squads-postgres \
1229
- -e POSTGRES_PASSWORD=squads \
1230
- -p 5432:5432 \
1231
- postgres:16
273
+ Owns the codebase. Ships features, fixes bugs, maintains quality.
1232
274
 
1233
- export SQUADS_POSTGRES_URL=postgres://postgres:squads@localhost:5432/squads
275
+ ## Goals
276
+ - P0: Ship v2.0 release
277
+ - P1: Reduce CI build time below 3 minutes
1234
278
  ```
1235
279
 
1236
280
  ## Development
1237
281
 
1238
282
  ```bash
1239
- git clone https://github.com/agents-squads/squads-cli
283
+ git clone https://github.com/agents-squads/squads-cli.git
1240
284
  cd squads-cli
1241
285
  npm install
1242
286
  npm run build
1243
- npm link # Test globally
287
+ npm link # Makes 'squads' available globally
288
+ npm test
1244
289
  ```
1245
290
 
1246
- ### Testing
291
+ ### Tech Stack
1247
292
 
1248
- ```bash
1249
- npm test # Run tests
1250
- npm run test:watch # Watch mode
1251
- npm run test:coverage # Coverage report
1252
- ```
293
+ - **TypeScript** (strict mode) with **Commander.js** for CLI parsing
294
+ - **Vitest** for testing
295
+ - **tsup** for bundling
296
+ - Built on the [Anthropic SDK](https://github.com/anthropics/anthropic-sdk-node) with multi-provider abstraction
1253
297
 
1254
- ### Scripts
298
+ ## Contributing
1255
299
 
1256
- ```bash
1257
- npm run build # Build with tsup
1258
- npm run dev # Watch mode
1259
- npm run lint # ESLint
1260
- npm run typecheck # TypeScript check
1261
- ```
300
+ Contributions are welcome. Please open an issue first to discuss what you'd like to change.
1262
301
 
1263
- ## Documentation & Resources
302
+ 1. Fork the repository
303
+ 2. Create your branch (`git checkout -b feature/my-feature`)
304
+ 3. Commit your changes (`git commit -m 'Add my feature'`)
305
+ 4. Push to the branch (`git push origin feature/my-feature`)
306
+ 5. Open a Pull Request
1264
307
 
1265
- **Official Documentation:**
1266
- - 📖 [Documentation](https://agents-squads.com/docs) — Complete CLI reference and tutorials
1267
- - 🚀 [Getting Started](https://agents-squads.com/onboarding) — Quick setup guide
1268
- - 🏗️ [Architecture Guide](https://agents-squads.com/engineering/squads-architecture) — How squads work under the hood
1269
- - ⚡ [Hooks and Skills](https://agents-squads.com/engineering/hooks-and-skills) — Claude Code integration patterns
1270
- - 💰 [Cost Management](https://agents-squads.com/engineering/cost-management) — Budget tracking and optimization
308
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
1271
309
 
1272
- **Related Repositories:**
1273
- - [agents-squads](https://github.com/agents-squads/agents-squads) — Full framework with infrastructure
1274
- - [engram](https://github.com/agents-squads/engram) — Persistent memory for AI agents
1275
- - [squads-infra](https://github.com/agents-squads/squads-infra) — Docker infrastructure stack
310
+ ## Community
1276
311
 
1277
- **Research & Intelligence:**
1278
- - [AI Agent Research](https://agents-squads.com/research) Latest AI agent analysis
1279
- - [Enterprise AI Report](https://agents-squads.com/intelligence/enterprise-ai-agents-2025) Market intelligence
312
+ - [GitHub Issues](https://github.com/agents-squads/squads-cli/issues) -- Bug reports and feature requests
313
+ - [GitHub Discussions](https://github.com/agents-squads/squads-cli/discussions) -- Questions and ideas
314
+ - [Documentation](https://agents-squads.com/docs) -- Guides, tutorials, and API reference
315
+
316
+ ## Related Projects
317
+
318
+ - [agents-squads](https://github.com/agents-squads/agents-squads) -- The full framework
319
+ - [engram](https://github.com/agents-squads/engram) -- Persistent memory for AI agents (MCP server)
1280
320
 
1281
321
  ## License
1282
322
 
@@ -1284,4 +324,8 @@ npm run typecheck # TypeScript check
1284
324
 
1285
325
  ---
1286
326
 
1287
- Built by [Agents Squads](https://agents-squads.com) — your AI workforce.
327
+ <div align="center">
328
+
329
+ Built by [Agents Squads](https://agents-squads.com)
330
+
331
+ </div>