squads-cli 0.2.0 → 0.4.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.
package/README.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  **Organize, run, and track autonomous AI agents.** Built for Claude Code.
8
8
 
9
+ ![squads dashboard](./assets/dashboard.png)
10
+
9
11
  ```
10
12
  $ squads status
11
13
 
@@ -65,10 +67,26 @@ squads memory query "authentication"
65
67
  squads goal set engineering "Ship v2.0 by Friday"
66
68
  ```
67
69
 
70
+ **Expected output after `squads init`:**
71
+
72
+ ```
73
+ squads init
74
+
75
+ ✓ Created .agents/squads/ directory
76
+ ✓ Created example squad: engineering
77
+ ✓ Created .agents/memory/ directory
78
+
79
+ Next steps:
80
+ $ squads status See your new squad
81
+ $ squads dash Full dashboard view
82
+ ```
83
+
68
84
  ## Features
69
85
 
70
86
  ### Dashboard
71
87
 
88
+ View comprehensive metrics across all squads:
89
+
72
90
  ```
73
91
  $ squads dash
74
92
 
@@ -93,6 +111,29 @@ $ squads dash
93
111
  404 commits │ 13.5/day │ 21 active days
94
112
  ```
95
113
 
114
+ **CEO Mode** provides an executive summary:
115
+
116
+ ```
117
+ $ squads dash --ceo
118
+
119
+ squads CEO Report
120
+ 2026-01-05
121
+
122
+ ┌─────────────────────────────────────┐
123
+ │ METRIC VALUE │
124
+ ├─────────────────────────────────────┤
125
+ │ Active Squads 8/10 │
126
+ │ P0 Goals 3 │
127
+ │ P1 Goals 5 │
128
+ │ Blockers 2 │
129
+ │ Daily Spend $12.50 / $50 │
130
+ └─────────────────────────────────────┘
131
+
132
+ P0 Priorities (revenue/launch critical)
133
+ ✗ customer Generate first consulting revenue
134
+ ✗ website Launch public website
135
+ ```
136
+
96
137
  ### Memory Search
97
138
 
98
139
  ```
@@ -154,6 +195,16 @@ $ squads stack health
154
195
  ● 8/8 services healthy
155
196
  ```
156
197
 
198
+ **Valid services for `squads stack logs`:**
199
+ - `postgres` - PostgreSQL database
200
+ - `redis` - Redis cache
201
+ - `neo4j` - Graph database
202
+ - `bridge` - Conversation capture API
203
+ - `langfuse` - Telemetry dashboard
204
+ - `mem0` - Memory extraction
205
+ - `engram` - Memory MCP server
206
+ - `otel` - OpenTelemetry collector
207
+
157
208
  ### Auto-Update
158
209
 
159
210
  ```
@@ -210,6 +261,20 @@ claude-sonnet-4
210
261
 
211
262
  ### Memory = Cross-Session State
212
263
 
264
+ Memory files are stored at `.agents/memory/<squad>/<agent>/<type>.md`:
265
+
266
+ ```
267
+ .agents/memory/
268
+ ├── engineering/
269
+ │ └── eng-lead/
270
+ │ ├── state.md # Current state
271
+ │ ├── learnings.md # Accumulated insights
272
+ │ └── feedback.md # Execution feedback
273
+ └── research/
274
+ └── analyst/
275
+ └── state.md
276
+ ```
277
+
213
278
  ```bash
214
279
  # Agents accumulate knowledge
215
280
  squads memory show engineering
@@ -220,67 +285,422 @@ squads memory show engineering
220
285
  squads memory query "performance"
221
286
  ```
222
287
 
288
+ ### Goals with Metrics
289
+
290
+ Goals can include optional metric annotations for tracking KPIs:
291
+
292
+ ```bash
293
+ # Set a goal with metrics
294
+ squads goal set finance "Reduce monthly costs by 20%" --metric "cost_usd" --metric "savings_pct"
295
+
296
+ # View goals with progress
297
+ squads goal list
298
+
299
+ finance
300
+ ● [1] Reduce monthly costs by 20%
301
+ └ Current: $450/mo, target: $400/mo
302
+ ```
303
+
304
+ ### Learning Extraction
305
+
306
+ Extract learnings from recent conversations and store in Engram:
307
+
308
+ ```bash
309
+ # Extract memories from last 24 hours
310
+ squads memory extract
311
+
312
+ # Preview without storing
313
+ squads memory extract --dry-run
314
+
315
+ # Extract from specific time window
316
+ squads memory extract --hours 48
317
+ ```
318
+
223
319
  ## Commands
224
320
 
321
+ ### Initialization
322
+
323
+ ```bash
324
+ squads init # Initialize project with default template
325
+ squads init -t minimal # Use minimal template
326
+ ```
327
+
225
328
  ### Status & Dashboard
226
329
 
227
330
  ```bash
228
- squads status # All squads overview
229
- squads status engineering # Single squad details
230
- squads status -v # Verbose with agent list
231
- squads dash # Full dashboard with goals
331
+ squads status # All squads overview
332
+ squads status engineering # Single squad details
333
+ squads status -v # Verbose with agent list
334
+
335
+ squads dash # Full dashboard with goals (fast mode)
336
+ squads dash -f # Include GitHub PR/issue stats (~30s slower)
337
+ squads dash --ceo # Executive summary with priorities and blockers
338
+ squads dash -v # Additional details
232
339
  ```
233
340
 
234
341
  ### Running Agents
235
342
 
236
343
  ```bash
237
- squads run engineering # Run the whole squad
238
- squads run engineering/ci-optimizer # Run specific agent
239
- squads run engineering --dry-run # Preview what would run
344
+ squads run engineering # Run the whole squad
345
+ squads run engineering/ci-optimizer # Run specific agent (slash notation)
346
+ squads run engineering -a ci-optimizer # Run specific agent (flag notation)
347
+ squads run engineering --dry-run # Preview what would run
348
+ squads run engineering --execute # Execute via Claude CLI
349
+ squads run engineering --parallel # Run all agents in parallel
350
+ squads run engineering --lead # Lead mode: single orchestrator with Task agents
351
+ squads run engineering --foreground # Run in foreground (no tmux)
352
+ squads run engineering --timeout 60 # Set timeout in minutes (default: 30)
240
353
  ```
241
354
 
242
355
  ### Memory Management
243
356
 
244
357
  ```bash
245
- squads memory query "deployment" # Semantic search
246
- squads memory show research # View squad memory
247
- squads memory list # List all entries
248
- squads memory sync # Sync from git remote
358
+ # Query (semantic search across markdown files)
359
+ squads memory query "deployment" # Search all memory
360
+ squads memory query "auth" -s website # Filter by squad
361
+ squads memory query "cache" -a lead # Filter by agent
362
+
363
+ # View
364
+ squads memory show research # View squad memory
365
+ squads memory list # List all entries
366
+
367
+ # Update
368
+ squads memory update cli "Fixed telemetry bug" # Add to learnings
369
+ squads memory update cli "State: ready" -t state # Update state
370
+ squads memory update cli "Good" -a cli-lead -t feedback # Add feedback
371
+
372
+ # Sync (git-based)
373
+ squads memory sync # Pull remote, process commits
374
+ squads memory sync -v # Verbose output
375
+ squads memory sync -p # Push local changes after sync
376
+ squads memory sync --no-pull # Skip pulling from remote
377
+
378
+ # Search (postgres via squads-bridge)
379
+ squads memory search "authentication" # Search stored conversations
380
+ squads memory search "error" -l 20 # Limit results
381
+ squads memory search "api" -r user # Filter by role (user/assistant/thinking)
382
+ squads memory search "bug" -i high # Filter by importance (low/normal/high)
383
+
384
+ # Extract (conversations → Engram memories)
385
+ squads memory extract # Extract from last 24h
386
+ squads memory extract -h 48 # Extract from last 48h
387
+ squads memory extract -s abc123 # Extract specific session
388
+ squads memory extract -d # Dry run (preview only)
249
389
  ```
250
390
 
251
391
  ### Goal Tracking
252
392
 
253
393
  ```bash
254
- squads goal set finance "Cut costs 20%" # Set goal
255
- squads goal list # View all goals
256
- squads goal progress finance 1 75 # Update progress
257
- squads goal complete finance 1 # Mark done
394
+ squads goal set finance "Cut costs 20%" # Set goal
395
+ squads goal set finance "Track API usage" -m "api_calls" -m "cost_usd" # With metrics
396
+ squads goal list # View all active goals
397
+ squads goal list -a # Include completed goals
398
+ squads goal list finance # View goals for one squad
399
+ squads goal progress finance 1 "Reduced to $400/mo" # Update progress (index, text)
400
+ squads goal complete finance 1 # Mark done (by index)
258
401
  ```
259
402
 
260
403
  ### Feedback Loop
261
404
 
262
405
  ```bash
263
- squads feedback add research 4 "Good analysis" # Rate 1-5
264
- squads feedback show research # View history
265
- squads feedback stats # Summary
406
+ squads feedback add research 4 "Good analysis" # Rate 1-5 with comment
407
+ squads feedback add cli 5 "Excellent" -l "Cache key insight" # With learning
408
+ squads feedback show research # View history
409
+ squads feedback show research -n 10 # Show more entries
410
+ squads feedback stats # Summary across all squads
411
+ ```
412
+
413
+ ### Session Management
414
+
415
+ ```bash
416
+ # List sessions
417
+ squads sessions # Show active sessions
418
+ squads sessions -v # With session details
419
+ squads sessions -j # JSON output
420
+
421
+ # History
422
+ squads sessions history # Last 7 days
423
+ squads sessions history -d 30 # Last 30 days
424
+ squads sessions history -s website # Filter by squad
425
+ squads sessions history -j # JSON output
426
+
427
+ # Summary
428
+ squads sessions summary # Auto-detect current session
429
+ squads sessions summary -f data.json # From JSON file
430
+ squads sessions summary -j # Output as JSON
431
+
432
+ # Lifecycle (for hooks/automation)
433
+ squads session start # Register new session
434
+ squads session start -s engineering # Override squad detection
435
+ squads session start -q # Quiet mode
436
+ squads session stop # End current session
437
+ squads session stop -q # Quiet mode
438
+ squads session heartbeat # Update session activity
439
+ squads session heartbeat -q # Quiet mode
440
+
441
+ # Detection
442
+ squads detect-squad # Detect current squad from cwd
443
+ ```
444
+
445
+ ### Progress Tracking
446
+
447
+ ```bash
448
+ squads progress # Show active/completed tasks
449
+ squads progress -v # More activity details
450
+ squads progress start engineering "Fixing CI" # Register task
451
+ squads progress complete abc123 # Mark task completed
452
+ squads progress complete abc123 -f # Mark as failed
453
+ ```
454
+
455
+ ### Results & KPIs
456
+
457
+ ```bash
458
+ squads results # All squads, last 7 days
459
+ squads results engineering # Single squad
460
+ squads results -d 30 # Last 30 days
461
+ squads results -v # Detailed KPIs per goal
462
+ ```
463
+
464
+ ### Workers
465
+
466
+ ```bash
467
+ squads workers # Show Claude sessions, tasks, dev servers
468
+ squads workers -v # More details
469
+ squads workers -k 12345 # Kill process by PID
470
+ ```
471
+
472
+ ### Issues Management
473
+
474
+ ```bash
475
+ # View issues
476
+ squads issues # Show GitHub issues
477
+ squads issues -o my-org # Different organization
478
+ squads issues -r repo1,repo2 # Specific repos
479
+
480
+ # Solve issues (create PRs)
481
+ squads solve-issues # Solve ready-to-fix issues
482
+ squads solve-issues -r hq # Target specific repo
483
+ squads solve-issues -i 123 # Solve specific issue
484
+ squads solve-issues -d # Dry run
485
+ squads solve-issues -e # Execute with Claude CLI
486
+
487
+ # Open issues (run evaluators)
488
+ squads open-issues # Find new issues via evaluators
489
+ squads open-issues -s website # Target squad
490
+ squads open-issues -a seo-critic # Specific evaluator
491
+ squads open-issues -d # Dry run
492
+ squads open-issues -e # Execute with Claude CLI
266
493
  ```
267
494
 
268
495
  ### Stack Management
269
496
 
270
497
  ```bash
271
- squads stack status # Container health
272
- squads stack up # Start Docker stack
273
- squads stack down # Stop Docker stack
274
- squads stack health # Comprehensive diagnostics
275
- squads stack logs bridge # View container logs
498
+ # Setup
499
+ squads stack init # Interactive setup wizard
500
+
501
+ # Status
502
+ squads stack status # Container health overview
503
+ squads stack health # Comprehensive diagnostics
504
+ squads stack health -v # Show logs for unhealthy services
505
+ squads stack env # Print export commands
506
+
507
+ # Control
508
+ squads stack up # Start Docker containers
509
+ squads stack down # Stop Docker containers
510
+ squads stack logs bridge # View container logs
511
+ squads stack logs postgres -n 100 # Last 100 lines
512
+ ```
513
+
514
+ ### Smart Triggers
515
+
516
+ Triggers execute agents based on conditions in PostgreSQL:
517
+
518
+ ```bash
519
+ squads trigger list # View all triggers
520
+ squads trigger list engineering # Filter by squad
521
+ squads trigger sync # Sync SQUAD.md → Postgres
522
+ squads trigger fire cost-alert # Manually fire a trigger
523
+ squads trigger enable cost-alert # Enable a trigger
524
+ squads trigger disable cost-alert # Disable a trigger
525
+ squads trigger status # Scheduler health & stats
526
+ ```
527
+
528
+ **Trigger definition in SQUAD.md:**
529
+
530
+ ```yaml
531
+ triggers:
532
+ - name: cost-alert
533
+ agent: cost-tracker
534
+ condition: |
535
+ SELECT value > 100
536
+ FROM latest_metrics
537
+ WHERE name = 'daily_cost_usd'
538
+ cooldown: 6 hours
539
+ priority: 3
540
+ ```
541
+
542
+ ### List & Discovery
543
+
544
+ ```bash
545
+ squads list # List all squads and agents
546
+ squads list -s # Squads only
547
+ squads list -a # Agents only
548
+ ```
549
+
550
+ ### Authentication (Pro & Enterprise)
551
+
552
+ ```bash
553
+ squads login # Log in to Squads cloud
554
+ squads logout # Log out
555
+ squads whoami # Show current user
276
556
  ```
277
557
 
278
558
  ### Updates
279
559
 
280
560
  ```bash
281
- squads update # Interactive update
282
- squads update -y # Auto-confirm
283
- squads update -c # Check only
561
+ squads update # Interactive update
562
+ squads update -y # Auto-confirm
563
+ squads update -c # Check only, don't install
564
+ ```
565
+
566
+ ## Command Reference
567
+
568
+ ```
569
+ squads init Initialize project
570
+ -t, --template <template> Project template (default)
571
+
572
+ squads status [squad] Show squad status
573
+ -v, --verbose Include agent details
574
+
575
+ squads dash Full dashboard with goals
576
+ -v, --verbose Show additional details
577
+ -c, --ceo Executive summary with priorities
578
+ -f, --full Include GitHub PR/issue stats (~30s)
579
+
580
+ squads run <target> Run squad or agent
581
+ -v, --verbose Verbose output
582
+ -d, --dry-run Preview only
583
+ -e, --execute Execute via Claude CLI
584
+ -a, --agent <agent> Run specific agent within squad
585
+ -t, --timeout <minutes> Execution timeout (default: 30)
586
+ -p, --parallel Run all agents in parallel
587
+ -l, --lead Lead mode: single orchestrator using Task tool
588
+ -f, --foreground Run in foreground (no tmux)
589
+
590
+ squads list List all squads/agents
591
+ -s, --squads Squads only
592
+ -a, --agents Agents only
593
+
594
+ squads memory query <query> Search memory
595
+ -s, --squad <squad> Filter by squad
596
+ -a, --agent <agent> Filter by agent
597
+ squads memory show <squad> View squad memory
598
+ squads memory update <squad> <text> Add to memory
599
+ -a, --agent <agent> Specific agent (default: squad-lead)
600
+ -t, --type <type> Memory type: state, learnings, feedback
601
+ squads memory list List all entries
602
+ squads memory sync Sync from git
603
+ -v, --verbose Detailed output
604
+ -p, --push Push after sync
605
+ --no-pull Skip pulling
606
+ squads memory search <query> Search postgres conversations
607
+ -l, --limit <n> Number of results (default: 10)
608
+ -r, --role <role> Filter: user, assistant, thinking
609
+ -i, --importance <level> Filter: low, normal, high
610
+ squads memory extract Extract memories to Engram
611
+ -s, --session <id> Specific session
612
+ -h, --hours <n> Hours to look back (default: 24)
613
+ -d, --dry-run Preview only
614
+
615
+ squads goal set <squad> <goal> Set a goal
616
+ -m, --metric <metrics...> Metrics to track
617
+ squads goal list [squad] List goals
618
+ -a, --all Include completed
619
+ squads goal progress <squad> <idx> <text> Update progress
620
+ squads goal complete <squad> <idx> Mark completed
621
+
622
+ squads feedback add <squad> <1-5> <text> Rate execution
623
+ -l, --learning <learnings...> Extract learnings
624
+ squads feedback show <squad> View history
625
+ -n, --limit <n> Entries to show (default: 5)
626
+ squads feedback stats Summary across squads
627
+
628
+ squads sessions List active sessions
629
+ -v, --verbose Session details
630
+ -j, --json JSON output
631
+ squads sessions history Session history
632
+ -d, --days <n> Days of history (default: 7)
633
+ -s, --squad <squad> Filter by squad
634
+ -j, --json JSON output
635
+ squads sessions summary Pretty session summary
636
+ -d, --data <json> JSON data
637
+ -f, --file <path> JSON file path
638
+ -j, --json JSON output
639
+
640
+ squads session start Register session
641
+ -s, --squad <squad> Override detection
642
+ -q, --quiet Suppress output
643
+ squads session stop End session
644
+ -q, --quiet Suppress output
645
+ squads session heartbeat Update activity
646
+ -q, --quiet Suppress output
647
+
648
+ squads detect-squad Detect squad from cwd
649
+
650
+ squads progress Show task progress
651
+ -v, --verbose More details
652
+ squads progress start <squad> <desc> Register task
653
+ squads progress complete <id> Mark completed
654
+ -f, --failed Mark as failed
655
+
656
+ squads results [squad] KPI goals vs actuals
657
+ -d, --days <n> Days to look back (default: 7)
658
+ -v, --verbose Detailed KPIs
659
+
660
+ squads workers Show active workers
661
+ -v, --verbose More details
662
+ -k, --kill <pid> Kill process
663
+
664
+ squads issues GitHub issues
665
+ -o, --org <org> Organization (default: agents-squads)
666
+ -r, --repos <repos> Comma-separated repos
667
+
668
+ squads solve-issues Solve issues with PRs
669
+ -r, --repo <repo> Target repo
670
+ -i, --issue <number> Specific issue
671
+ -d, --dry-run Preview only
672
+ -e, --execute Execute with Claude
673
+
674
+ squads open-issues Find new issues
675
+ -s, --squad <squad> Target squad
676
+ -a, --agent <agent> Evaluator agent
677
+ -d, --dry-run Preview only
678
+ -e, --execute Execute with Claude
679
+
680
+ squads stack init Setup wizard
681
+ squads stack status Container health
682
+ squads stack health Full diagnostics
683
+ -v, --verbose Show logs for failures
684
+ squads stack env Print exports
685
+ squads stack up Start containers
686
+ squads stack down Stop containers
687
+ squads stack logs <service> View logs
688
+ -n, --tail <lines> Lines to show (default: 50)
689
+
690
+ squads trigger list [squad] List triggers
691
+ squads trigger sync Sync to scheduler
692
+ squads trigger fire <name> Fire trigger
693
+ squads trigger enable <name> Enable trigger
694
+ squads trigger disable <name> Disable trigger
695
+ squads trigger status Scheduler stats
696
+
697
+ squads update Interactive update
698
+ -y, --yes Auto-confirm
699
+ -c, --check Check only
700
+
701
+ squads login Log in (Pro)
702
+ squads logout Log out
703
+ squads whoami Show user
284
704
  ```
285
705
 
286
706
  ## Claude Code Integration
@@ -328,61 +748,19 @@ your-project/
328
748
  │ │ └── research/
329
749
  │ ├── memory/ # Persistent state
330
750
  │ │ ├── engineering/
331
- │ │ │ └── state.md
751
+ │ │ │ └── eng-lead/
752
+ │ │ │ ├── state.md
753
+ │ │ │ ├── learnings.md
754
+ │ │ │ └── feedback.md
332
755
  │ │ └── research/
333
- └── outputs/ # Agent outputs
756
+ ├── outputs/ # Agent outputs
757
+ │ └── sessions/
758
+ │ └── history.jsonl # Session event log
334
759
  ├── .claude/
335
760
  │ └── settings.json # Hooks config
336
761
  └── CLAUDE.md # Project instructions
337
762
  ```
338
763
 
339
- ## Command Reference
340
-
341
- ```
342
- squads status [squad] Show squad status
343
- -v, --verbose Include agent details
344
-
345
- squads dash Full dashboard with goals
346
- -f, --full Include PRs and issues
347
-
348
- squads run <target> Run squad or agent
349
- -v, --verbose Verbose output
350
- -d, --dry-run Preview only
351
- -e, --execute Execute via Claude CLI
352
-
353
- squads list List all squads/agents
354
- -s, --squads Squads only
355
- -a, --agents Agents only
356
-
357
- squads memory query <q> Search memory
358
- -s, --squad <squad> Filter by squad
359
- squads memory show <squad> View squad memory
360
- squads memory list List all entries
361
- squads memory sync Sync from git remote
362
-
363
- squads goal set <squad> <goal>
364
- squads goal list [squad]
365
- squads goal progress <squad> <idx> <pct>
366
- squads goal complete <squad> <idx>
367
-
368
- squads feedback add <squad> <rating> <text>
369
- squads feedback show <squad>
370
- squads feedback stats
371
-
372
- squads stack status Container health
373
- squads stack up Start Docker stack
374
- squads stack down Stop Docker stack
375
- squads stack health Comprehensive diagnostics
376
- squads stack logs <service> View container logs
377
-
378
- squads update Interactive update
379
- -y, --yes Auto-confirm
380
- -c, --check Check only
381
-
382
- squads init Initialize project
383
- squads login/logout/whoami Authentication (Pro)
384
- ```
385
-
386
764
  ## Development
387
765
 
388
766
  ```bash
@@ -393,6 +771,23 @@ npm run build
393
771
  npm link # Test globally
394
772
  ```
395
773
 
774
+ ### Testing
775
+
776
+ ```bash
777
+ npm test # Run tests
778
+ npm run test:watch # Watch mode
779
+ npm run test:coverage # Coverage report
780
+ ```
781
+
782
+ ### Scripts
783
+
784
+ ```bash
785
+ npm run build # Build with tsup
786
+ npm run dev # Watch mode
787
+ npm run lint # ESLint
788
+ npm run typecheck # TypeScript check
789
+ ```
790
+
396
791
  ## Related
397
792
 
398
793
  - [agents-squads](https://github.com/agents-squads/agents-squads) — Full framework with infrastructure
@@ -0,0 +1,12 @@
1
+ #!/usr/bin/env node
2
+ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
3
+ get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
4
+ }) : x)(function(x) {
5
+ if (typeof require !== "undefined") return require.apply(this, arguments);
6
+ throw Error('Dynamic require of "' + x + '" is not supported');
7
+ });
8
+
9
+ export {
10
+ __require
11
+ };
12
+ //# sourceMappingURL=chunk-7OCVIDC7.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}