cli-wiring
Checklist for wiring a new Squad CLI command: route it in cli-entry.ts, add help text, and test that it is reachable
- License 许可
- MIT
- 所属仓库
- github/squad
- 最近更新
- 2026-11-15
- Stars
- ★ 3.4k
- Forks
- 520
01 前言 Front Matter
- name
- cli-wiring
- domain
- cli
- source
- team-decision
- confidence
- high
- description
- Checklist for wiring a new Squad CLI command: route it in cli-entry.ts, add help text, and test that it is reachable
03 SKILL.md 正文
Skill: CLI Command Wiring
Bug class: Commands implemented in packages/squad-cli/src/cli/commands/ but never routed in cli-entry.ts.
Checklist — Adding a New CLI Command
-
Create command file in
packages/squad-cli/src/cli/commands/<name>.ts- Export a
run<Name>(cwd, options)async function (or class with static methods for utility modules)
- Export a
-
Add routing block in
packages/squad-cli/src/cli-entry.tsinsidemain():if (cmd === '<name>') { const { run<Name> } = await import('./cli/commands/<name>.js'); // parse args, call function await run<Name>(process.cwd(), options); return; } -
Add help text in the help section of
cli-entry.ts(search forCommands:):console.log(` ${BOLD}<name>${RESET} <description>`); console.log(` Usage: <name> [flags]`); -
Verify both exist — the recurring bug is doing step 1 but missing steps 2-3.
Wiring Patterns by Command Type
| Type | Example | How to wire |
|---|---|---|
| Standard command | export.ts, build.ts |
run*() function, parse flags from args |
| Placeholder command | loop, cast (alias: hire) |
Inline in cli-entry.ts, prints pending message |
| Utility/check module | rc-tunnel.ts, copilot-bridge.ts |
Wire as diagnostic check (e.g., isDevtunnelAvailable()) |
| Subcommand of another | init-remote.ts |
Already used inside parent + standalone alias |
Common Import Pattern
import { BOLD, RESET, DIM, RED, GREEN, YELLOW } from './cli/core/output.js';
Use dynamic await import() for command modules to keep startup fast (lazy loading).
History
- #237 / PR #244: 4 commands wired (rc, copilot-bridge, init-remote, rc-tunnel). aspire, link, loop, cast (née hire) were already present.
04 同仓库更多 Skills
windows-compatibility
Cross-platform path handling and command patterns
versioning-policy
SemVer rules for Squad's stable, preview, insider, and local package versions
tiered-memory
Three-tier agent memory model (hot/cold/wiki) for context reduction per spawn
test-discipline
Design assertions that prove the actual contract and fail on realistic regressions
squad
Squad's command catalog and interactive menu. Invoke via /squad (slash command) or natural language ("squad commands", "what can squad do", "show me squad options"). Presents categorized operations (Install & Upgrade, Team Management, Issues & PRs, Plugins & Skills, Model & Cost, Sessions & State) as an interactive picker. Routes to the right squad CLI command or the Squad coordinator agent.
squad-version-check
Internals of how @bradygaster/squad-cli stamps its version, how `squad upgrade` works (what it preserves vs overwrites), and how to probe the npm registry for the latest version from a coordinator prompt.