swarmctl: add CLI reference docs, same pattern as hivectl
Adds swarmctl markdown-docs (a hidden Verb, same clap-markdown + hide=true shape as hivectl markdown-docs) and generates docs/tools/swarmctl-cli.md from it. Wires a swarmctl-docs freshness check into nix/checks.nix, same shape as hivectl-docs, diffing against packages.swarmctl. One real gotcha: PathArgs::resolve() reads required SWARMCTL_AUTHELIA_* deployment env vars and errors if unset - swarmctl markdown-docs must not go through that path (it needs none of those vars, and the docs build runs it outside any real deployment). Restructured main() so resolve() only runs for the User arm, not unconditionally before the match. Also links the new doc from docs/tools/README.md (new 'for the swarm operator' section), CLAUDE.md's swarmctl bullet, and docs/conventions.md's flake-check list. Verified: cargo check/clippy -D warnings/test/fmt -p swarmctl all clean; swarmctl markdown-docs diffs clean against the committed doc (checked against both a plain cargo build and the actual nix build. #swarmctl output); scripts/check-issue-refs.sh clean.
This commit is contained in:
parent
b10cce8045
commit
7fc426b4dd
8 changed files with 121 additions and 3 deletions
|
|
@ -15,6 +15,15 @@ debug agent behavior.
|
|||
- **[hivectl-cli](hivectl-cli.md)** — the exhaustive, auto-generated
|
||||
flag-by-flag reference, kept in lockstep with the binary by CI.
|
||||
|
||||
## For the swarm operator
|
||||
|
||||
- **[swarmctl-cli](swarmctl-cli.md)** — the exhaustive, auto-generated
|
||||
flag-by-flag reference for `swarmctl`, kept in lockstep with the
|
||||
binary by CI the same way `hivectl-cli.md` is. `swarmctl` itself
|
||||
runs as root on the swarm-controller host, not through `hivectl` —
|
||||
see `swarmctl/README.md` for why. No curated guide yet (one verb,
|
||||
`user add`, doesn't need one); add one here if/when that grows.
|
||||
|
||||
## What your agents can do
|
||||
|
||||
- **[bash](bash.md)** — background shell execution (`mcp__bash__*`),
|
||||
|
|
|
|||
Loading…
Reference in a new issue