# Command-Line Help for `hivectl` This document contains the help content for the `hivectl` command-line program. **Command Overview:** * [`hivectl`↴](#hivectl) * [`hivectl forge`↴](#hivectl-forge) * [`hivectl forge create-user`↴](#hivectl-forge-create-user) * [`hivectl forge reconcile-config`↴](#hivectl-forge-reconcile-config) * [`hivectl matrix`↴](#hivectl-matrix) * [`hivectl matrix create-user`↴](#hivectl-matrix-create-user) * [`hivectl matrix sync-admin`↴](#hivectl-matrix-sync-admin) * [`hivectl matrix promote-user`↴](#hivectl-matrix-promote-user) * [`hivectl matrix reset-password`↴](#hivectl-matrix-reset-password) * [`hivectl matrix invite`↴](#hivectl-matrix-invite) * [`hivectl github`↴](#hivectl-github) * [`hivectl github set-token`↴](#hivectl-github-set-token) * [`hivectl gateway`↴](#hivectl-gateway) * [`hivectl gateway create-user`↴](#hivectl-gateway-create-user) * [`hivectl gateway delete-user`↴](#hivectl-gateway-delete-user) * [`hivectl gateway list-users`↴](#hivectl-gateway-list-users) * [`hivectl agent`↴](#hivectl-agent) * [`hivectl agent restart`↴](#hivectl-agent-restart) * [`hivectl agent pause`↴](#hivectl-agent-pause) * [`hivectl agent resume`↴](#hivectl-agent-resume) * [`hivectl agent spawn`↴](#hivectl-agent-spawn) * [`hivectl agent request-spawn`↴](#hivectl-agent-request-spawn) * [`hivectl agent kill`↴](#hivectl-agent-kill) * [`hivectl agent destroy`↴](#hivectl-agent-destroy) * [`hivectl agent rebuild`↴](#hivectl-agent-rebuild) * [`hivectl agent set-parent`↴](#hivectl-agent-set-parent) * [`hivectl agent set-limits`↴](#hivectl-agent-set-limits) * [`hivectl agent choom`↴](#hivectl-agent-choom) * [`hivectl agent watch`↴](#hivectl-agent-watch) * [`hivectl agent quota`↴](#hivectl-agent-quota) * [`hivectl agent quota show`↴](#hivectl-agent-quota-show) * [`hivectl agent quota set`↴](#hivectl-agent-quota-set) * [`hivectl agent subvol`↴](#hivectl-agent-subvol) * [`hivectl agent subvol upgrade`↴](#hivectl-agent-subvol-upgrade) * [`hivectl agent subvol snapshot`↴](#hivectl-agent-subvol-snapshot) * [`hivectl agent subvol snapshot create`↴](#hivectl-agent-subvol-snapshot-create) * [`hivectl agent subvol snapshot delete`↴](#hivectl-agent-subvol-snapshot-delete) * [`hivectl agent subvol snapshot send`↴](#hivectl-agent-subvol-snapshot-send) * [`hivectl agent subvol snapshot push`↴](#hivectl-agent-subvol-snapshot-push) * [`hivectl list-agents`↴](#hivectl-list-agents) * [`hivectl quota-enable`↴](#hivectl-quota-enable) * [`hivectl approvals`↴](#hivectl-approvals) * [`hivectl approvals pending`↴](#hivectl-approvals-pending) * [`hivectl approvals approve`↴](#hivectl-approvals-approve) * [`hivectl approvals deny`↴](#hivectl-approvals-deny) * [`hivectl wg`↴](#hivectl-wg) * [`hivectl wg init`↴](#hivectl-wg-init) * [`hivectl wg peer`↴](#hivectl-wg-peer) * [`hivectl wg status`↴](#hivectl-wg-status) * [`hivectl peer-config`↴](#hivectl-peer-config) * [`hivectl stop`↴](#hivectl-stop) * [`hivectl start`↴](#hivectl-start) * [`hivectl restart`↴](#hivectl-restart) * [`hivectl open`↴](#hivectl-open) * [`hivectl completions`↴](#hivectl-completions) ## `hivectl` Sibling to the `hive-c0re` daemon binary. Covers host-side admin operations that don't go through the broker — manual user provisioning on the bundled forge + matrix containers, plus future recovery / debugging verbs. **Usage:** `hivectl [OPTIONS] ` ###### **Subcommands:** * `forge` — Forgejo user provisioning * `matrix` — matrix-tuwunel user provisioning * `github` — GitHub account provisioning * `gateway` — Gateway htpasswd user management * `agent` — Lifecycle actions on ONE managed agent container. Needs the hive-c0re daemon running * `list-agents` — Show all managed agents with their status and technical state * `quota-enable` — Enable btrfs qgroup accounting on the agent-state filesystem * `approvals` — Operator approval queue: list, approve, or deny pending requests * `wg` — WireGuard inter-hive mesh setup helpers * `peer-config` — Generate the federation peer-config block for THIS hive * `stop` — Stop containers hive-wide in one operator action * `start` — Start containers hive-wide — the inverse of `hivectl stop` * `restart` — Restart containers hive-wide — `stop` then `start` over one scope * `open` — Print (and best-effort open in a browser) a hive web surface URL * `completions` — Generate a shell completion script for `hivectl` and print it to stdout ###### **Options:** * `--socket ` — Path to the hive-c0re host admin socket, used by the daemon-assisted verbs (`agent`, `list-agents`, `stop`, `start`). Global: accepted before or after the subcommand. Verbs that don't talk to the daemon ignore it Default value: `/run/hyperhive/host.sock` ## `hivectl forge` Forgejo user provisioning. Manual entry point to the same idempotent provisioning c0re runs at boot — for recovery, ad-hoc reprovisioning, or fixing one agent without bouncing the daemon. **Usage:** `hivectl forge ` ###### **Subcommands:** * `create-user` — Create or refresh the Forgejo account + token for `` * `reconcile-config` — Show + reconcile the divergence between an agent's local applied config checkout and its forge `agent-configs/` main ## `hivectl forge create-user` Create or refresh the Forgejo account + token for ``. For an existing agent, persists the token to its state dir; for a human/other account, prints the token to stdout. Set a password to enable forge web-UI login (a random throwaway is used otherwise). **Usage:** `hivectl forge create-user [OPTIONS] ` ###### **Arguments:** * `` — Forgejo username. For agents: the container/agent name (`` in `h-`; manager uses the literal `manager`). For humans: any forgejo username — `mara`, `damocles`, etc ###### **Options:** * `--password ` — Set the account password to this string instead of a random throwaway. Use this for operator accounts that need to log into the forge web UI. Mutually exclusive with `--password-stdin`. WARNING: the password is visible in shell history + process listings; prefer `--password-stdin` for anything sensitive * `--password-stdin` — Read the password from stdin (single line, trailing newline stripped) instead of an inline flag. Mutually exclusive with `--password` ## `hivectl forge reconcile-config` Show + reconcile the divergence between an agent's local applied config checkout and its forge `agent-configs/` main. Always prints the diff first. `--from forge` resets the local checkout to forge main (effective on the next deploy); `--from local` is not supported yet. With no `--from`, prompts for the direction. **Usage:** `hivectl forge reconcile-config [OPTIONS] ` ###### **Arguments:** * `` — Agent whose config branches to reconcile ###### **Options:** * `--from ` — Which side to reconcile from. Omit to be prompted after the diff Possible values: - `forge`: Reset the local applied checkout to forge main - `local`: Advance forge main from local — not supported yet * `--verbose` — Include the full diff (not just `--stat`) in the report ## `hivectl matrix` matrix-tuwunel user provisioning. Manual entry point to the same idempotent provisioning c0re runs at boot — for re-registering an agent the boot sweep skipped, or after wiping a token file. **Usage:** `hivectl matrix ` ###### **Subcommands:** * `create-user` — Create or refresh the matrix account + access token for `` * `sync-admin` — Provision (or re-provision) the hive system admin matrix account * `promote-user` — Promote a matrix user to homeserver admin * `reset-password` — Reset a matrix user's password via the admin API * `invite` — Invite a matrix user to the hive Space, or a specific room with `--room`. Idempotent ## `hivectl matrix create-user` Create or refresh the matrix account + access token for ``. For an existing agent, persists the token to its state dir; for a human/other account, prints the access token to stdout. Set a password to enable matrix web-client login (a random throwaway is used otherwise). **Usage:** `hivectl matrix create-user [OPTIONS] ` ###### **Arguments:** * `` — Matrix localpart. For agents: the container/agent name. For humans: any matrix localpart — `mara`, `damocles`, etc ###### **Options:** * `--password ` — Set the account password to this string instead of a random throwaway. Use this for operator accounts that need to log into matrix web clients via `m.login.password`. Mutually exclusive with `--password-stdin`. WARNING: the password is visible in shell history + process listings; prefer `--password-stdin` for anything sensitive * `--password-stdin` — Read the password from stdin (single line, trailing newline stripped) instead of an inline flag. Mutually exclusive with `--password` ## `hivectl matrix sync-admin` Provision (or re-provision) the hive system admin matrix account. Runs automatically on startup; run manually to recover a missing admin token. **Usage:** `hivectl matrix sync-admin` ## `hivectl matrix promote-user` Promote a matrix user to homeserver admin **Usage:** `hivectl matrix promote-user ` ###### **Arguments:** * `` — Matrix localpart of the user to promote (e.g. `argus`) ## `hivectl matrix reset-password` Reset a matrix user's password via the admin API. Persists the new password so a later `create-user` can re-login. **Usage:** `hivectl matrix reset-password ` ###### **Arguments:** * `` — Matrix localpart of the account to reset (e.g. `argus`) ## `hivectl matrix invite` Invite a matrix user to the hive Space, or a specific room with `--room`. Idempotent **Usage:** `hivectl matrix invite [OPTIONS] ` ###### **Arguments:** * `` — User to invite: a full id (`@mara:server`) or a bare localpart (qualified with the homeserver's `server_name`) ###### **Options:** * `--room ` — Target room id (`!abc:server`) or alias (`#name:server`). Omit to invite to the hive Space ## `hivectl github` GitHub account provisioning. Store an operator-supplied personal access token (PAT) for an agent so its `gh` and git can authenticate. No account is created — the PAT is for an existing GitHub account. **Usage:** `hivectl github ` ###### **Subcommands:** * `set-token` — Store a GitHub PAT for `` so its `gh` and git can authenticate ## `hivectl github set-token` Store a GitHub PAT for `` so its `gh` and git can authenticate. Prefer `--token-stdin` — an inline `--token` is visible in shell history. **Usage:** `hivectl github set-token [OPTIONS] ` ###### **Arguments:** * `` — Logical agent name (the container/agent name) ###### **Options:** * `--token ` — The PAT value inline. Mutually exclusive with `--token-stdin` * `--token-stdin` — Read the PAT from stdin (trailing newline stripped). Mutually exclusive with `--token` ## `hivectl gateway` Gateway htpasswd user management. Add, remove, or list users for the gateway's HTTP Basic auth. **Usage:** `hivectl gateway ` ###### **Subcommands:** * `create-user` — Add a user or update an existing user's password in the gateway htpasswd * `delete-user` — Remove a user from the gateway htpasswd * `list-users` — List all gateway htpasswd usernames, one per line ## `hivectl gateway create-user` Add a user or update an existing user's password in the gateway htpasswd. Use `--password-stdin` to keep the password out of shell history. **Usage:** `hivectl gateway create-user [OPTIONS] ` ###### **Arguments:** * `` — Username to add or update ###### **Options:** * `--password ` — Set the password inline. WARNING: visible in shell history and process listings — prefer `--password-stdin` for sensitive input. Mutually exclusive with `--password-stdin` * `--password-stdin` — Read the password from stdin (single line, trailing newline stripped). Mutually exclusive with `--password` ## `hivectl gateway delete-user` Remove a user from the gateway htpasswd **Usage:** `hivectl gateway delete-user ` ###### **Arguments:** * `` — Username to remove ## `hivectl gateway list-users` List all gateway htpasswd usernames, one per line **Usage:** `hivectl gateway list-users` ## `hivectl agent` Lifecycle actions on ONE managed agent container. Needs the hive-c0re daemon running. Everything here targets a single named agent (`hivectl agent foo restart`, `hivectl agent foo choom`, …) — anything that acts hive-wide lives at the top level instead (`list-agents`, `restart`/`stop`/`start` with a scope, `quota-enable`). **Usage:** `hivectl agent ` ###### **Subcommands:** * `restart` — Stop and start this agent container without rebuilding config * `pause` — Park this agent's turn loop, leaving the container running * `resume` — Resume this paused agent — it drains whatever queued up while parked * `spawn` — Spawn this agent container directly, bypassing the approval queue * `request-spawn` — Queue a spawn request for operator approval * `kill` — Stop this managed container (graceful) * `destroy` — Tear down this sub-agent container, keeping its state by default. No undo * `rebuild` — Apply pending config to this managed container * `set-parent` — Move this agent in the topology tree — under a new parent, or to root * `set-limits` — Declare this agent's CPU/memory limits, overriding the hive-wide defaults * `choom` — Open an interactive Claude session inside this agent's container * `watch` — Follow this agent's live turn/tool-call event stream from the CLI * `quota` — This agent's disk accounting + optional quota via btrfs qgroups * `subvol` — btrfs subvolume management for this agent's state dir ###### **Arguments:** * `` — Agent name (e.g. `damocles`, `iris`) ## `hivectl agent restart` Stop and start this agent container without rebuilding config **Usage:** `hivectl agent restart [OPTIONS]` ###### **Options:** * `--no-wait` — Return immediately after the restart DAG is queued ## `hivectl agent pause` Park this agent's turn loop, leaving the container running. The harness stops driving turns but keeps serving its web UI and MCP daemons, so the container, its mounts and its warm caches stay up while it burns no tokens. Inbox messages queue unacked and the backlog drains on `resume`. Sticky: it survives a restart, and pausing a stopped agent makes it come up paused. **Usage:** `hivectl agent pause` ## `hivectl agent resume` Resume this paused agent — it drains whatever queued up while parked **Usage:** `hivectl agent resume` ## `hivectl agent spawn` Spawn this agent container directly, bypassing the approval queue. Operator-on-the-host only; use `request-spawn` for an approval-gated spawn. **Usage:** `hivectl agent spawn` ## `hivectl agent request-spawn` Queue a spawn request for operator approval **Usage:** `hivectl agent request-spawn` ## `hivectl agent kill` Stop this managed container (graceful) **Usage:** `hivectl agent kill` ## `hivectl agent destroy` Tear down this sub-agent container, keeping its state by default. No undo **Usage:** `hivectl agent destroy [OPTIONS]` ###### **Options:** * `--purge` — Also wipe the agent's state dirs (config + creds + notes) ## `hivectl agent rebuild` Apply pending config to this managed container **Usage:** `hivectl agent rebuild` ## `hivectl agent set-parent` Move this agent in the topology tree — under a new parent, or to root **Usage:** `hivectl agent set-parent [OPTIONS]` ###### **Options:** * `--parent ` — New parent agent name. Mutually exclusive with `--root` * `--root` — Promote this agent to root (no parent) ## `hivectl agent set-limits` Declare this agent's CPU/memory limits, overriding the hive-wide defaults. Replaces the agent's whole override entry rather than merging into it: any limit you don't pass returns to the hive-wide default. To change one and keep the other, pass both. Disk is a separate resource with its own group — see `quota`. **Usage:** `hivectl agent set-limits [OPTIONS]` ###### **Options:** * `--cpu-quota ` — systemd `CPUQuota=` value, e.g. `400%` (100% = one full core) * `--memory-max ` — systemd `MemoryMax=` value, e.g. `8G`, `50%`, or `infinity` * `--reset` — Drop all overrides — the agent returns to the hive-wide defaults. Required to clear limits, so that a `set-limits` with a forgotten value can't silently reset the agent ## `hivectl agent choom` Open an interactive Claude session inside this agent's container. A fresh session by default, or resume a prior one. Requires root and a running container. **Usage:** `hivectl agent choom [OPTIONS]` ###### **Options:** * `--resume ` — Resume a prior claude session by its session id, passed through as `claude --resume ` (claude's `--continue` takes no value — it resumes the cwd's latest session, which is the harness's, so choom never uses it; this flag matches the claude flag it maps to). Omit for a fresh blank session. A value is required when the flag is given ## `hivectl agent watch` Follow this agent's live turn/tool-call event stream from the CLI. Prints one compact line per event as they happen. `Ctrl-C` to stop. Requires the agent to be running. **Usage:** `hivectl agent watch` ## `hivectl agent quota` This agent's disk accounting + optional quota via btrfs qgroups. Needs `hivectl quota-enable` run once hive-wide first. No-op on non-btrfs hosts. **Usage:** `hivectl agent quota ` ###### **Subcommands:** * `show` — Report this agent's disk usage from btrfs qgroups * `set` — Set or clear this agent's disk-usage quota ## `hivectl agent quota show` Report this agent's disk usage from btrfs qgroups **Usage:** `hivectl agent quota show` ## `hivectl agent quota set` Set or clear this agent's disk-usage quota **Usage:** `hivectl agent quota set ` ###### **Arguments:** * `` — Size cap (`5G`, `500M`, `1073741824`) or `none` to clear ## `hivectl agent subvol` btrfs subvolume management for this agent's state dir. Upgrade an existing plain-dir agent's state into a btrfs subvolume so it gains snapshots and per-subvol usage/quota. **Usage:** `hivectl agent subvol ` ###### **Subcommands:** * `upgrade` — Convert a plain-dir agent state root into a btrfs subvolume in place, so it gains snapshots and per-subvol usage/quota * `snapshot` — Read-only snapshots of this agent's state subvolume ## `hivectl agent subvol upgrade` Convert a plain-dir agent state root into a btrfs subvolume in place, so it gains snapshots and per-subvol usage/quota. Bounces the agent to migrate its state, so it requires `--yes`. **Usage:** `hivectl agent subvol upgrade [OPTIONS]` ###### **Options:** * `--yes` — Confirm: this stops the agent, migrates its state dir, and restarts it. Required — the command refuses without it ## `hivectl agent subvol snapshot` Read-only snapshots of this agent's state subvolume **Usage:** `hivectl agent subvol snapshot ` ###### **Subcommands:** * `create` — Create a read-only snapshot (agent must already be a subvolume) * `delete` — Delete a snapshot created by `subvol snapshot create` * `send` — Export a snapshot to a local file via `btrfs send` — the local-file half of the inter-hive migration transport (`push` is the network half). Also useful standalone as a point-in-time backup: a full send with no `--parent` produces a self-contained archive of the snapshot * `push` — Stream a snapshot to the swarm's snapshot store over the WireGuard mesh — the network half of the migration transport ## `hivectl agent subvol snapshot create` Create a read-only snapshot (agent must already be a subvolume) **Usage:** `hivectl agent subvol snapshot create --label