mara/hyperhive
mara/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity

docs: use neutral placeholder agent names in examples

Browse source 
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
5 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/2-handbook/hives/hivectl-cli.md
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`)

12
docs/2-handbook/hives/hivectl.md
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

2
docs/2-handbook/swarm/README.md
View file

@ -561,7 +561,7 @@ same third hive, such as a stale endpoint.
is names only. Set it only for a hive addressed by something else. This
hive's own `services.hyperhive.domain` comes from its entry; it drives
`HYPERHIVE_HIVE_DOMAIN` in every container so agents can form qualified
labels (`iris@firsthive.myswarm.example`). Setting `services.hyperhive.domain`
labels (`agent1@firsthive.myswarm.example`). Setting `services.hyperhive.domain`
directly overrides the directory entry, with a deprecation warning: the
option is local to this host while every host shares the directory, so a
value written only here is invisible to the rest of the swarm.

8
docs/2-handbook/swarm/schedules.md
View file

@ -13,15 +13,15 @@ sets itself, it uses `remind`, which stays inside its container.
## Managing them
```console
# swarmctl schedule add --name standup --agent scribe --agent iris \
# swarmctl schedule add --name standup --agent agent2 --agent agent1 \
--body "post the standup summary" --at 2026-10-05T09:00:00+02:00 --every 1d
added schedule kqzpmwab
kqzpmwab "standup" every 1d from 2026-10-05T07:00:00Z next 2026-10-05T07:00:00Z agents: iris, scribe | post the standup summary
kqzpmwab "standup" every 1d from 2026-10-05T07:00:00Z next 2026-10-05T07:00:00Z agents: agent1, agent2 | post the standup summary
# swarmctl schedule list
# swarmctl schedule list --agent scribe
# swarmctl schedule list --agent agent2
# swarmctl schedule edit kqzpmwab --body "post the standup summary to the team room"
# swarmctl schedule edit kqzpmwab --add-agent atlas --remove-agent iris
# swarmctl schedule edit kqzpmwab --add-agent agent3 --remove-agent agent1
# swarmctl schedule pause kqzpmwab
# swarmctl schedule resume kqzpmwab
# swarmctl schedule rm kqzpmwab

2
docs/2-handbook/swarm/ui.md
View file

@ -804,7 +804,7 @@ controller refuses IP addresses, other wildcards, ports and paths, and a name
the proxy already allows every agent (the base list). The dialog shows the
refusal's reason under the box and leaves what you typed. Adding does a
`POST /api/egress/allowed-domains` and removing a `DELETE` of the same path,
each with `{"domain": "github.com", "agent": "atlas"}` (leave out `agent` for
each with `{"domain": "github.com", "agent": "agent1"}` (leave out `agent` for
a swarm-wide entry); both answer the whole list, and `GET` reads it. Adding
an entry that exists changes nothing.