Watch
0
0
Fork
You've already forked hyperhive
0

docs: use neutral placeholder agent names in examples

The setup page's first-agent example named the agent iris, and a user
copied it verbatim. Use <name> there, with a line saying the name is free
to choose, and agent1/agent2 in the hivectl, schedule and label examples.
This commit is contained in:
iris 2026-11-09 20:42:51 +01:00 • committed by mara
commit da071e3fa9
2 changed files with 17 additions and 17 deletions

View file

@ -89,7 +89,7 @@ Everything here targets a single named agent (`hivectl agent foo restart`, `hive
###### **Arguments:**
* `<NAME>` — Agent name (for example `damocles`, `iris`)
* `<NAME>` — Agent name (for example `agent1`)

View file

@ -31,9 +31,9 @@ the name onto the parent command, so none of the verbs below repeat it.
```bash
hivectl list-agents # roster: every agent's status + technical state
hivectl list-agents --json # same data as raw JSON rows (for scripting)
hivectl agent iris restart # stop + start the `iris` container (no rebuild)
hivectl agent iris pause # park iris's turn loop, leave the container running
hivectl agent iris resume # let it drive turns again, draining what queued up
hivectl agent agent1 restart # stop + start the `agent1` container (no rebuild)
hivectl agent agent1 pause # park agent1's turn loop, leave the container running
hivectl agent agent1 resume # let it drive turns again, draining what queued up
```
`list-agents` prints a padded table with one row per managed agent —
@ -94,8 +94,8 @@ therefore names the grant it wants, instead of reporting a permission
problem with the state dir.
```bash
hivectl agent iris choom # fresh blank Claude session in iris's container
hivectl agent iris choom --resume <session-id> # rejoin a prior session by id
hivectl agent agent1 choom # fresh blank Claude session in agent1's container
hivectl agent agent1 choom --resume <session-id> # rejoin a prior session by id
```
Bare `choom` starts a fresh blank session. `--resume <value>` passes
@ -137,7 +137,7 @@ lands in a faithful copy of the agent's environment:
Follow an agent's live turn/tool-call event stream from the CLI:
```bash
hivectl agent iris watch # tail iris's live events; Ctrl-C to stop
hivectl agent agent1 watch # tail agent1's live events; Ctrl-C to stop
```
Dials the same unix socket the gateway's nginx `proxy_pass`es through