Watch
0
0
Fork
You've already forked hyperhive
0

docs: finish the neutral agent names in the hivectl source and the swarmctl README

hivectl-cli.md is generated from the clap doc comment, so the example name
moves into cli.rs; the swarmctl README's create and schedule examples use
agent1/agent2 like the handbook pages.
This commit is contained in:
iris 2026-11-09 20:54:46 +01:00 • committed by mara
commit ea407823c1
2 changed files with 6 additions and 6 deletions

View file

@ -35,7 +35,7 @@ pub enum Cmd {
/// hive-wide lives at the top level instead (`list-agents`, /// hive-wide lives at the top level instead (`list-agents`,
/// `restart`/`stop`/`start` with a scope, `quota-enable`). /// `restart`/`stop`/`start` with a scope, `quota-enable`).
Agent { Agent {
/// Agent name (for example `damocles`, `iris`). /// Agent name (for example `agent1`).
name: String, name: String,
#[command(subcommand)] #[command(subcommand)]
cmd: AgentCmd, cmd: AgentCmd,

View file

@ -104,9 +104,9 @@ generates a new one the same way.
## `agent create` ## `agent create`
```console ```console
# swarmctl agent create scribe --hive alpha # swarmctl agent create agent2 --hive alpha
queued: job node 42 queued: job node 42
agent "scribe" will be deployed to hive "alpha" once the job graph runs; `swarmctl` does not wait for it agent "agent2" will be deployed to hive "alpha" once the job graph runs; `swarmctl` does not wait for it
``` ```
`POST /api/agents` on the swarm-controller, over its unix socket `POST /api/agents` on the swarm-controller, over its unix socket
@ -194,9 +194,9 @@ refused. The response body comes from `swarm-controller-api`, imported in
## `schedule` ## `schedule`
```console ```console
# swarmctl schedule add --name standup --agent scribe --body "post the standup summary" --every 1d # swarmctl schedule add --name standup --agent agent2 --body "post the standup summary" --every 1d
# swarmctl schedule list --agent scribe # swarmctl schedule list --agent agent2
# swarmctl schedule edit kqzpmwab --at 2026-10-05T09:00:00+02:00 --add-agent iris # swarmctl schedule edit kqzpmwab --at 2026-10-05T09:00:00+02:00 --add-agent agent1
# swarmctl schedule pause kqzpmwab # swarmctl schedule pause kqzpmwab
# swarmctl schedule rm kqzpmwab # swarmctl schedule rm kqzpmwab
``` ```