vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

rewrite generated CLI docs' passive voice to active

Browse source 
hive-forge and hivectl doc-comment strings for pr-create --label, diff
--full, list --label, ci-runs --branch, and several hivectl subcommand
options read as if things happened to themselves. Name the actor (hivectl,
hive-forge, or the CLI) instead, and regenerate the three docs/tools/*-cli.md
files from the rebuilt binaries.

swarmctl-cli.md needs no source change: its only passive hit is
clap-markdown's own generated boilerplate, out of scope here.
This commit is contained in:
iris 2026-09-08 14:46:52 +02:00 • committed by mara
commit 7396903994
7 changed files with 39 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/tools/hivectl-cli.md
View file

@ -113,7 +113,7 @@ Manual entry point to the same idempotent provisioning c0re runs at boot — for
Create or refresh the Forgejo account + token for `<name>`.
For an existing agent, persists the token to its state dir; for a human/other account, prints the token to stdout. Set a password to enable forge web-UI login (a random throwaway is used otherwise).
For an existing agent, persists the token to its state dir; for a human/other account, prints the token to stdout. Set a password to enable forge web-UI login (otherwise it uses a random throwaway).
**Usage:** `hivectl forge create-user [OPTIONS] <NAME>`
@ -142,7 +142,7 @@ Always prints the diff first. `--from forge` resets the local checkout to forge
###### **Options:**
* `--from <FROM>` — Which side to reconcile from. Omit to be prompted after the diff
* `--from <FROM>` — Which side to reconcile from. Omit it and hivectl prompts you after the diff
Possible values:
- `forge`:
@ -176,7 +176,7 @@ Manual entry point to the same idempotent provisioning c0re runs at boot — for
Create or refresh the matrix account + access token for `<name>`.
For an existing agent, persists the token to its state dir; for a human/other account, prints the access token to stdout. Set a password to enable matrix web-client login (a random throwaway is used otherwise).
For an existing agent, persists the token to its state dir; for a human/other account, prints the access token to stdout. Set a password to enable matrix web-client login (otherwise it uses a random throwaway).
**Usage:** `hivectl matrix create-user [OPTIONS] <NAME>`
@ -372,7 +372,7 @@ Stop and start this agent container without rebuilding config
###### **Options:**
* `--no-wait` — Return immediately after the restart DAG is queued
* `--no-wait` — Return immediately after hivectl queues the restart DAG
@ -386,7 +386,7 @@ The harness stops driving turns but keeps serving its web UI and MCP daemons, so
###### **Options:**
* `--no-wait` — Return immediately after the pause DAG is queued instead of waiting for the harness to acknowledge it
* `--no-wait` — Return immediately after hivectl queues the pause DAG instead of waiting for the harness to acknowledge it
@ -406,7 +406,7 @@ Start this EXISTING agent container. Fails immediately if `name` has no config/t
###### **Options:**
* `--paused` — Start (or leave) the agent paused: if it's currently down, the pause marker is written before the container boots, so it comes up paused instead of driving turns immediately. If it's already running, this pauses it in place and doesn't attempt a (re)start
* `--paused` — Start (or leave) the agent paused: if it's currently down, hivectl writes the pause marker before the container boots, so it comes up paused instead of driving turns immediately. If it's already running, this pauses it in place and doesn't attempt a (re)start
@ -814,8 +814,8 @@ Bare `hivectl stop` stops everything; scope flags narrow it to specific sub-agen
* `--forge` — The forge container (`hive-forge`)
* `--gateway` — The gateway (`hive-gateway`) — nginx on the host, not a container
* `--matrix` — The matrix container (`hive-matrix`)
* `--graceful` — Gracefully quiesce each agent before stopping, instead of a hard stop. Each agent gets a graceful-stop DAG on the job queue: the harness is signalled, runs one stop-checkpoint turn to flush durable `/state`, drains, then the container is stopped (bounded by a 3-min timeout that falls back to a hard stop). All drains overlap. Applies to agents only
* `--no-wait` — Return immediately after the stop DAGs are queued instead of waiting for them with live per-node progress
* `--graceful` — Gracefully quiesce each agent before stopping, instead of a hard stop. Each agent gets a graceful-stop DAG on the job queue: it signals the harness, which runs one stop-checkpoint turn to flush durable `/state` and drains, then the DAG stops the container (bounded by a 3-min timeout that falls back to a hard stop). All drains overlap. Applies to agents only
* `--no-wait` — Return immediately after hivectl queues the stop DAGs instead of waiting for them with live per-node progress
@ -835,7 +835,7 @@ Bare `hivectl start` restores the agents stopped by the last broad-scope `stop`
* `--forge` — The forge container (`hive-forge`)
* `--gateway` — The gateway (`hive-gateway`) — nginx on the host, not a container
* `--matrix` — The matrix container (`hive-matrix`)
* `--no-wait` — Return immediately after the start DAGs are queued instead of waiting for them with live per-node progress
* `--no-wait` — Return immediately after hivectl queues the start DAGs instead of waiting for them with live per-node progress