docs(readme): replace deprecated autopilot example with 'squads run'#896
Conversation
The first-contact UX sim (fresh model reading only README + --help) flagged that the README features 'squads autopilot --interval 30 --budget 50' as a primary example while --help marks 'autopilot' [deprecated]. A contradiction a new user catches reads as docs lagging the CLI. Use the supported form 'squads run --interval 30 --budget 50' (run with no target = autopilot mode), which the run --help itself documents. Co-Authored-By: Claude <noreply@anthropic.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md documentation to change the command for autonomous dispatch. However, the reviewer pointed out that the proposed command squads run without a target will not trigger autonomous dispatch, but will instead list available squads and exit. The reviewer suggested using squads autonomous start instead to correctly start the local scheduling daemon.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| squads run research --parallel # squad conversation | ||
| squads run intelligence --task "Scan X" # directed run | ||
| squads autopilot --interval 30 --budget 50 # autonomous dispatch | ||
| squads run --interval 30 --budget 50 # autopilot: autonomous dispatch |
There was a problem hiding this comment.
The proposed command squads run --interval 30 --budget 50 will not trigger autopilot or autonomous dispatch. In src/commands/run.ts, when squads run is invoked without a target squad or agent, it enters the MODE 1: No target block which simply lists the available squads and exits.
To start the local scheduling daemon for autonomous execution, the correct command is squads autonomous start (or its alias squads auto start), which reads routines and schedules from SQUAD.md files.
| squads run --interval 30 --budget 50 # autopilot: autonomous dispatch | |
| squads autonomous start # autonomous dispatch |
2 participants
The first-contact UX sim (fresh model reading only README +
--help) flagged that the README featuressquads autopilot --interval 30 --budget 50as a primary example while--helpmarksautopilot[deprecated]. A contradiction a new user catches reads as docs lagging the CLI.Use the supported form
squads run --interval 30 --budget 50(run with no target = autopilot mode), whichrun --helpitself documents.One-line docs fix.
Refs #895.