0e84fe8bc4
The handbook's sections were agent-lifecycle, integrations, swarm, tools, trust-boundary and web-ui, which do not follow how the system is built, so a reader could not tell which layer a page is about. Its pages now sit in swarm/, hives/ and agents/, with the accounts an agent can hold outside the system in external-accounts/. - swarm/: forge, matrix and the knowledge repo join the swarm pages, and so does the swarmctl reference. - hives/: the dashboard, hivectl and its reference, and the operator/agent boundary, with a README that takes over the old web-ui and tools pages. - agents/: the roster, persistence, config changes, the agent's own web page (was web-ui/agent) and the security model, with a README. - external-accounts/: GitHub and GitLab. Pages are moved whole; none is split yet. Every reference follows: relative links in the docs, `docs/2-handbook/...` paths in code comments, the nix checks that regenerate the CLI references and the ignore list, and docs/README.md, whose handbook section is now by layer.
33 lines
1.3 KiB
Markdown
33 lines
1.3 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 and the
|
|
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`).
|
|
- **`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.
|
|
- **`wg.rs`** — WireGuard mesh helpers.
|
|
- **`subvol.rs`** — btrfs state-subvolume ops.
|
|
- **`quota.rs`**, **`util.rs`**, **`completions.rs`** — shared helpers
|
|
and shell completions.
|
|
|
|
Full verb reference: `docs/2-handbook/hives/hivectl.md`.
|