- hivectl/README.md: split matrix.rs/github.rs into accurate per-module lines (matrix.rs invites a matrix user to the hive Space/room, cli.rs:289-296; it is not per-agent). Fixed the summary line's 'provisioning verbs' to name the actual verb groups left after the facts pass. - web-ui/README.md: the swarm/ui.md pointer no longer promises roster/ creating-agents/linking-accounts content that page doesn't have. - Reverted the unrelated doesn't/does not drive-by at hivectl/README.md:5.
40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
# hivectl
|
|
|
|
The operator-facing host CLI. A thin client for the `hive-c0re`
|
|
daemon — speaks the host admin socket protocol (`hive-host-sock`) and
|
|
does not link the daemon crate. Container lifecycle, the approval
|
|
queue, and the matrix/github/gateway verbs all forward to the daemon
|
|
and need it running; a few (`wg`/`peer-config`, `choom`) work off local
|
|
host state instead.
|
|
|
|
## When to use it
|
|
|
|
Reach for this crate when adding an operator-run host command — agents
|
|
talk to the daemon over their own MCP tool surface
|
|
(`hive-agent-mcp`), not this binary. `hivectl` is what a human operator
|
|
(or a host-side script) runs.
|
|
|
|
## Shape
|
|
|
|
One module per subcommand family; `main.rs` is just the clap parse +
|
|
dispatch:
|
|
|
|
- **`agents.rs`** — container lifecycle for an EXISTING agent
|
|
(start/stop/kill/rebuild/restart/…); creation is swarm-level
|
|
(`swarmctl agent create`).
|
|
- **`approvals.rs`** — the config/spawn/meta-input approval queue.
|
|
- **`dag_progress.rs`** — rebuild-queue progress rendering.
|
|
- **`power.rs`** — restart/start/stop at the container level.
|
|
- **`choom.rs`** — drop into an interactive claude session in a
|
|
container.
|
|
- **`forge.rs`** — reconciles an agent's config against its forge
|
|
repo.
|
|
- **`matrix.rs`** — invite a matrix user to the hive Space or a room.
|
|
- **`github.rs`** — per-agent GitHub PAT writes (`set-token`).
|
|
- **`gateway.rs`** — gateway Basic-auth user management (htpasswd).
|
|
- **`wg.rs`** — WireGuard mesh helpers.
|
|
- **`subvol.rs`** — btrfs state-subvolume ops.
|
|
- **`quota.rs`**, **`util.rs`**, **`completions.rs`**, **`open.rs`** —
|
|
shared helpers, shell completions, browser-open.
|
|
|
|
Full verb reference: `docs/tools/hivectl.md`.
|