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:
parent
c1d3b29710
commit
da071e3fa9
6 changed files with 17 additions and 17 deletions
|
|
@ -144,18 +144,18 @@ an agent's config arrive as PRs you merge. → [`2-handbook/agents/agent-roster.
|
||||||
To create an agent yourself instead, use the swarm UI, or:
|
To create an agent yourself instead, use the swarm UI, or:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
swarmctl agent create iris --hive firsthive
|
swarmctl agent create <name> --hive firsthive
|
||||||
```
|
```
|
||||||
|
|
||||||
The controller provisions iris's identity, forge user and config repo
|
The name is yours to choose; it has no meaning to the swarm. The controller provisions the agent's identity, forge user and config repo
|
||||||
(`agent-configs/iris`, from the default template), then has the hive build
|
(`agent-configs/<name>`, from the default template), then has the hive build
|
||||||
and start the container. The hive builds from a copy of hyperhive on the swarm's own forge: the
|
and start the container. The hive builds from a copy of hyperhive on the swarm's own forge: the
|
||||||
controller mirrors it there as `hyperhive/hyperhive` on a fresh swarm, so the
|
controller mirrors it there as `hyperhive/hyperhive` on a fresh swarm, so the
|
||||||
first agent needs no extra step (see
|
first agent needs no extra step (see
|
||||||
[`nixos.md`](nixos.md#the-hyperhive-mirror)). It returns once the scheduler queues the job — watch the
|
[`nixos.md`](nixos.md#the-hyperhive-mirror)). It returns once the scheduler queues the job — watch the
|
||||||
swarm UI's job view for progress.
|
swarm UI's job view for progress.
|
||||||
|
|
||||||
Later config changes are PRs on `agent-configs/iris`; you merge them on the
|
Later config changes are PRs on `agent-configs/<name>`; you merge them on the
|
||||||
forge, and the merge deploys them. →
|
forge, and the merge deploys them. →
|
||||||
[`2-handbook/agents/config-changes.md`](../2-handbook/agents/config-changes.md#config-changes)
|
[`2-handbook/agents/config-changes.md`](../2-handbook/agents/config-changes.md#config-changes)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -89,7 +89,7 @@ Everything here targets a single named agent (`hivectl agent foo restart`, `hive
|
||||||
|
|
||||||
###### **Arguments:**
|
###### **Arguments:**
|
||||||
|
|
||||||
* `<NAME>` — Agent name (for example `damocles`, `iris`)
|
* `<NAME>` — Agent name (for example `agent1`)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -31,9 +31,9 @@ the name onto the parent command, so none of the verbs below repeat it.
|
||||||
```bash
|
```bash
|
||||||
hivectl list-agents # roster: every agent's status + technical state
|
hivectl list-agents # roster: every agent's status + technical state
|
||||||
hivectl list-agents --json # same data as raw JSON rows (for scripting)
|
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 agent1 restart # stop + start the `agent1` container (no rebuild)
|
||||||
hivectl agent iris pause # park iris's turn loop, leave the container running
|
hivectl agent agent1 pause # park agent1's turn loop, leave the container running
|
||||||
hivectl agent iris resume # let it drive turns again, draining what queued up
|
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 —
|
`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.
|
problem with the state dir.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hivectl agent iris choom # fresh blank Claude session in iris's container
|
hivectl agent agent1 choom # fresh blank Claude session in agent1's container
|
||||||
hivectl agent iris choom --resume <session-id> # rejoin a prior session by id
|
hivectl agent agent1 choom --resume <session-id> # rejoin a prior session by id
|
||||||
```
|
```
|
||||||
|
|
||||||
Bare `choom` starts a fresh blank session. `--resume <value>` passes
|
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:
|
Follow an agent's live turn/tool-call event stream from the CLI:
|
||||||
|
|
||||||
```bash
|
```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
|
Dials the same unix socket the gateway's nginx `proxy_pass`es through
|
||||||
|
|
|
||||||
|
|
@ -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
|
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
|
hive's own `services.hyperhive.domain` comes from its entry; it drives
|
||||||
`HYPERHIVE_HIVE_DOMAIN` in every container so agents can form qualified
|
`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
|
directly overrides the directory entry, with a deprecation warning: the
|
||||||
option is local to this host while every host shares the directory, so a
|
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.
|
value written only here is invisible to the rest of the swarm.
|
||||||
|
|
|
||||||
|
|
@ -13,15 +13,15 @@ sets itself, it uses `remind`, which stays inside its container.
|
||||||
## Managing them
|
## Managing them
|
||||||
|
|
||||||
```console
|
```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
|
--body "post the standup summary" --at 2026-10-05T09:00:00+02:00 --every 1d
|
||||||
added schedule kqzpmwab
|
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
|
||||||
# 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 --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 pause kqzpmwab
|
||||||
# swarmctl schedule resume kqzpmwab
|
# swarmctl schedule resume kqzpmwab
|
||||||
# swarmctl schedule rm kqzpmwab
|
# swarmctl schedule rm kqzpmwab
|
||||||
|
|
|
||||||
|
|
@ -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
|
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
|
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,
|
`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
|
a swarm-wide entry); both answer the whole list, and `GET` reads it. Adding
|
||||||
an entry that exists changes nothing.
|
an entry that exists changes nothing.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue