Command-Line Help for hivectl
This document contains the help content for the hivectl command-line program.
Command Overview:
hivectl↴hivectl forge↴hivectl forge create-user↴hivectl forge reconcile-config↴hivectl matrix↴hivectl matrix create-user↴hivectl matrix sync-admin↴hivectl matrix promote-user↴hivectl matrix reset-password↴hivectl matrix invite↴hivectl github↴hivectl github set-token↴hivectl gateway↴hivectl gateway create-user↴hivectl gateway delete-user↴hivectl gateway list-users↴hivectl agent↴hivectl agent restart↴hivectl agent pause↴hivectl agent resume↴hivectl agent start↴hivectl agent create↴hivectl agent request-create↴hivectl agent stop↴hivectl agent kill↴hivectl agent destroy↴hivectl agent rebuild↴hivectl agent set-parent↴hivectl agent set-limits↴hivectl agent choom↴hivectl agent watch↴hivectl agent quota↴hivectl agent quota show↴hivectl agent quota set↴hivectl agent subvol↴hivectl agent subvol upgrade↴hivectl agent subvol snapshot↴hivectl agent subvol snapshot create↴hivectl agent subvol snapshot delete↴hivectl agent subvol snapshot send↴hivectl agent subvol snapshot push↴hivectl list-agents↴hivectl quota-enable↴hivectl approvals↴hivectl approvals pending↴hivectl approvals approve↴hivectl approvals deny↴hivectl wg↴hivectl wg init↴hivectl wg peer↴hivectl wg status↴hivectl peer-config↴hivectl stop↴hivectl start↴hivectl restart↴hivectl open↴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] <COMMAND>
Subcommands:
forge— Forgejo user provisioningmatrix— matrix-tuwunel user provisioninggithub— GitHub account provisioninggateway— Gateway htpasswd user managementagent— Lifecycle actions on ONE managed agent container. Needs the hive-c0re daemon runninglist-agents— Show all managed agents with their status and technical statequota-enable— Enable btrfs qgroup accounting on the agent-state filesystemapprovals— Operator approval queue: list, approve, or deny pending requestswg— WireGuard inter-hive mesh setup helperspeer-config— Generate the federation peer-config block for THIS hivestop— Stop containers hive-wide in one operator actionstart— Start containers hive-wide — the inverse ofhivectl stoprestart— Restart containers hive-wide —stopthenstartover one scopeopen— Print (and best-effort open in a browser) a hive web surface URLcompletions— Generate a shell completion script forhivectland print it to stdout
Options:
-
--socket <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 itDefault 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 <COMMAND>
Subcommands:
create-user— Create or refresh the Forgejo account + token for<name>reconcile-config— Show + reconcile the divergence between an agent's local applied config checkout and its forgeagent-configs/<agent>main
hivectl forge create-user
Create or refresh the Forgejo account + token for <name>.
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] <NAME>
Arguments:
<NAME>— Forgejo username. For agents: the container/agent name (<n>inh-<n>; manager uses the literalmanager). For humans: any forgejo username —mara,damocles, etc
Options:
--password <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-stdinfor 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/<agent> 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] <AGENT>
Arguments:
<AGENT>— Agent whose config branches to reconcile
Options:
-
--from <FROM>— Which side to reconcile from. Omit to be prompted after the diffPossible values:
forge: Reset the local applied checkout to forge mainlocal: 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 <COMMAND>
Subcommands:
create-user— Create or refresh the matrix account + access token for<name>sync-admin— Provision (or re-provision) the hive system admin matrix accountpromote-user— Promote a matrix user to homeserver adminreset-password— Reset a matrix user's password via the admin APIinvite— 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 <name>.
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] <NAME>
Arguments:
<NAME>— Matrix localpart. For agents: the container/agent name. For humans: any matrix localpart —mara,damocles, etc
Options:
--password <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 viam.login.password. Mutually exclusive with--password-stdin. WARNING: the password is visible in shell history + process listings; prefer--password-stdinfor 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 <NAME>
Arguments:
<NAME>— 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 <NAME>
Arguments:
<NAME>— 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] <USER>
Arguments:
<USER>— User to invite: a full id (@mara:server) or a bare localpart (qualified with the homeserver'sserver_name)
Options:
--room <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 <COMMAND>
Subcommands:
set-token— Store a GitHub PAT for<agent>so itsghand git can authenticate
hivectl github set-token
Store a GitHub PAT for <agent> so its gh and git can authenticate.
Prefer --token-stdin — an inline --token is visible in shell history.
Usage: hivectl github set-token [OPTIONS] <AGENT>
Arguments:
<AGENT>— Logical agent name (the container/agent name)
Options:
--token <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 <COMMAND>
Subcommands:
create-user— Add a user or update an existing user's password in the gateway htpasswddelete-user— Remove a user from the gateway htpasswdlist-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] <USERNAME>
Arguments:
<USERNAME>— Username to add or update
Options:
--password <PASSWORD>— Set the password inline. WARNING: visible in shell history and process listings — prefer--password-stdinfor 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 <USERNAME>
Arguments:
<USERNAME>— 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 <NAME> <COMMAND>
Subcommands:
restart— Stop and start this agent container without rebuilding configpause— Park this agent's turn loop, leaving the container runningresume— Resume this paused agent — it drains whatever queued up while parkedstart— Start this EXISTING agent container. Fails immediately ifnamehas no config/topology entry at all — it never attempts first-time creation. Usecreatefor thatcreate— Create this agent container from scratch (full first-time provisioning), bypassing the approval queuerequest-create— Queue a first-creation request for operator approvalstop— Gracefully stop this agent container: signal → drain → reconcile. Never escalates to a hard kill — usekillfor thatkill— Hard-stop this managed containerdestroy— Tear down this sub-agent container, keeping its state by default. No undorebuild— Apply pending config to this managed containerset-parent— Move this agent in the topology tree — under a new parent, or to rootset-limits— Declare this agent's CPU/memory limits, overriding the hive-wide defaultschoom— Open an interactive Claude session inside this agent's containerwatch— Follow this agent's live turn/tool-call event stream from the CLIquota— This agent's disk accounting + optional quota via btrfs qgroupssubvol— btrfs subvolume management for this agent's state dir
Arguments:
<NAME>— 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 [OPTIONS]
Options:
--no-wait— Return immediately after the pause DAG is queued instead of waiting for the harness to acknowledge it
hivectl agent resume
Resume this paused agent — it drains whatever queued up while parked
Usage: hivectl agent resume
hivectl agent start
Start this EXISTING agent container. Fails immediately if name has no config/topology entry at all — it never attempts first-time creation. Use create for that
Usage: hivectl agent start [OPTIONS]
Options:
--paused— Start (or leave) the agent paused: if it's currently down, the pause marker is written before the container boots, so it comes up paused instead of driving turns immediately. If it's already running, this pauses it in place and does not attempt a (re)start
hivectl agent create
Create this agent container from scratch (full first-time provisioning), bypassing the approval queue.
Operator-on-the-host only; use request-create for an approval-gated creation.
Usage: hivectl agent create
hivectl agent request-create
Queue a first-creation request for operator approval
Usage: hivectl agent request-create
hivectl agent stop
Gracefully stop this agent container: signal → drain → reconcile. Never escalates to a hard kill — use kill for that
Usage: hivectl agent stop
hivectl agent kill
Hard-stop this managed container
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 <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 <CPU_QUOTA>— systemdCPUQuota=value, e.g.400%(100% = one full core)--memory-max <MEMORY_MAX>— systemdMemoryMax=value, e.g.8G,50%, orinfinity--reset— Drop all overrides — the agent returns to the hive-wide defaults. Required to clear limits, so that aset-limitswith 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 <SESSION>— Resume a prior claude session by its session id, passed through asclaude --resume <value>(claude's--continuetakes 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 <COMMAND>
Subcommands:
show— Report this agent's disk usage from btrfs qgroupsset— 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 <SIZE>
Arguments:
<SIZE>— Size cap (5G,500M,1073741824) ornoneto 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 <COMMAND>
Subcommands:
upgrade— Convert a plain-dir agent state root into a btrfs subvolume in place, so it gains snapshots and per-subvol usage/quotasnapshot— 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 <COMMAND>
Subcommands:
create— Create a read-only snapshot (agent must already be a subvolume)delete— Delete a snapshot created bysubvol snapshot createsend— Export a snapshot to a local file viabtrfs send— the local-file half of the inter-hive migration transport (pushis the network half). Also useful standalone as a point-in-time backup: a full send with no--parentproduces a self-contained archive of the snapshotpush— 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 <LABEL>
Options:
--label <LABEL>— Snapshot label. Mandatory, and must start withhive-— the prefix doubles as an allow-list hive-priv checks so only hivectl-issued snapshot names can reach thebtrfs subvolume snapshotshellout
hivectl agent subvol snapshot delete
Delete a snapshot created by subvol snapshot create
Usage: hivectl agent subvol snapshot delete <LABEL>
Arguments:
<LABEL>— Snapshot label passed tosubvol snapshot create --label
hivectl agent subvol snapshot 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
Usage: hivectl agent subvol snapshot send [OPTIONS] --dest <DEST> <LABEL>
Arguments:
<LABEL>— Snapshot label passed tosubvol snapshot create --label
Options:
--parent <PARENT>— Optional parent snapshot label for an incremental send (btrfs send -p) — must be an existing, older snapshot of the same agent. Omit for a full send--dest <DEST>— Destination filename (not a path) under the migrate-staging dir. Refused if it already exists
hivectl agent subvol snapshot push
Stream a snapshot to the swarm's snapshot store over the WireGuard mesh — the network half of the migration transport.
Nothing is staged locally: btrfs send writes straight into the connection, so a multi-gigabyte agent needs no scratch space on this host. The mesh is the authentication (cryptokey routing binds the sender's address to its key), so there is no credential to pass here.
There is no destination argument: a swarm has one store, read from services.hyperhive.swarm.snapshotStore.
Usage: hivectl agent subvol snapshot push [OPTIONS] <LABEL>
Arguments:
<LABEL>— Snapshot label passed tosubvol snapshot create --label
Options:
--parent <PARENT>— Optional parent snapshot label for an incremental send (btrfs send -p) — must be an existing, older snapshot of the same agent, and must already be present on the receiver. Omit for a full send
hivectl list-agents
Show all managed agents with their status and technical state.
Global — not scoped to one agent, so it lives at the top level rather than under hivectl agent <name>. Needs the hive-c0re daemon running.
Usage: hivectl list-agents [OPTIONS]
Options:
--json— Emit the raw JSON rows instead of the padded table (for scripting). The table is the default human-readable shape
hivectl quota-enable
Enable btrfs qgroup accounting on the agent-state filesystem.
Global one-shot toggle (not per-agent), hence top-level rather than under hivectl agent <name>. Idempotent — safe to re-run. Once enabled, hivectl agent <name> quota show/quota set work.
Usage: hivectl quota-enable
hivectl approvals
Operator approval queue: list, approve, or deny pending requests.
Needs the hive-c0re daemon running.
Usage: hivectl approvals <COMMAND>
Subcommands:
pending— List pending approval requests submitted by agentsapprove— Approve a pending request by id; the action runs immediatelydeny— Deny a pending request by id
hivectl approvals pending
List pending approval requests submitted by agents
Usage: hivectl approvals pending
hivectl approvals approve
Approve a pending request by id; the action runs immediately
Usage: hivectl approvals approve <ID>
Arguments:
<ID>— Approval id (fromhivectl approvals pending)
hivectl approvals deny
Deny a pending request by id
Usage: hivectl approvals deny <ID>
Arguments:
<ID>— Approval id
hivectl wg
WireGuard inter-hive mesh setup helpers.
Generate this hive's mesh key and print the nix to enable the mesh, add a peer, or inspect live interface state.
Usage: hivectl wg <COMMAND>
Subcommands:
init— Generate this hive's WireGuard key (if absent) and print its public key plus the nix to enable the meshpeer— Print the nix to add a peer hive to the meshstatus— Show the live mesh interface state
hivectl wg init
Generate this hive's WireGuard key (if absent) and print its public key plus the nix to enable the mesh
Usage: hivectl wg init [OPTIONS]
Options:
--address <ADDRESS>— This hive's mesh address (e.g.10.42.0.1/32) to bake into the printed snippet. Omit to get a placeholder you fill in
hivectl wg peer
Print the nix to add a peer hive to the mesh
Usage: hivectl wg peer [OPTIONS] --pubkey <PUBKEY> --address <ADDRESS> <DOMAIN>
Arguments:
<DOMAIN>— Peer hive's DNS domain (itsswarm.hivesentry'sdomain)
Options:
--pubkey <PUBKEY>— Peer's WireGuard public key (from itshivectl wg init)--address <ADDRESS>— Peer's mesh address (e.g.10.42.0.2/32)--endpoint <ENDPOINT>— Peer'shost:portendpoint (omit for a peer that only dials out, e.g. one behind NAT — it must set an endpoint pointing back here)
hivectl wg status
Show the live mesh interface state
Usage: hivectl wg status
hivectl peer-config
Generate the federation peer-config block for THIS hive.
Prints the nix a peer operator pastes into their swarm config to trust and reach this hive.
Usage: hivectl peer-config [OPTIONS]
Options:
--wg-address <WG_ADDRESS>— This hive's WireGuard mesh address (e.g.10.42.0.1/32), emitted aswireguardAddress. Omit when not running the mesh--wg-endpoint <WG_ENDPOINT>— This hive's public WireGuard endpoint (host:port), emitted aswireguardEndpoint. Omit when peers dial in / no mesh
hivectl stop
Stop containers hive-wide in one operator action.
Bare hivectl stop stops everything; scope flags narrow it to specific sub-agents or infra containers.
Usage: hivectl stop [OPTIONS]
Options:
--agents— All sub-agent containers--agent <NAME>— A specific sub-agent by name. Repeatable:--agent a --agent b--ci— The CI runner container (hive-ci)--forge— The forge container (hive-forge)--gateway— The gateway (hive-gateway) — nginx on the host, not a container--matrix— The matrix container (hive-matrix)--graceful— Gracefully quiesce each agent before stopping, instead of a hard stop. Each agent gets a graceful-stop DAG on the job queue: the harness is signalled, runs one stop-checkpoint turn to flush durable/state, drains, then the container is stopped (bounded by a 3-min timeout that falls back to a hard stop). All drains overlap. Applies to agents only--no-wait— Return immediately after the stop DAGs are queued instead of waiting for them with live per-node progress
hivectl start
Start containers hive-wide — the inverse of hivectl stop.
Bare hivectl start restores the agents stopped by the last broad-scope stop (or starts everything if none); scope flags narrow it.
Usage: hivectl start [OPTIONS]
Options:
--agents— All sub-agent containers--agent <NAME>— A specific sub-agent by name. Repeatable:--agent a --agent b--ci— The CI runner container (hive-ci)--forge— The forge container (hive-forge)--gateway— The gateway (hive-gateway) — nginx on the host, not a container--matrix— The matrix container (hive-matrix)--no-wait— Return immediately after the start DAGs are queued instead of waiting for them with live per-node progress
hivectl restart
Restart containers hive-wide — stop then start over one scope.
Bare hivectl restart restarts everything; scope flags narrow it.
Usage: hivectl restart [OPTIONS]
Options:
--agents— All sub-agent containers--agent <NAME>— A specific sub-agent by name. Repeatable:--agent a --agent b--ci— The CI runner container (hive-ci)--forge— The forge container (hive-forge)--gateway— The gateway (hive-gateway) — nginx on the host, not a container--matrix— The matrix container (hive-matrix)--graceful— Gracefully quiesce each agent on the stop half (seestop --graceful). Applies to agents only
hivectl open
Print (and best-effort open in a browser) a hive web surface URL.
Resolves the URL from the running daemon so custom forge / matrix domains work. Bare hivectl open opens the operator dashboard.
Usage: hivectl open [TARGET]
Arguments:
-
<TARGET>— Which surface to open. Defaults to the operator dashboardDefault value:
homePossible values:
home: The operator dashboard (https://<domain>/)forge: The forge (Forgejo) web UImatrix: The matrix GUI (fluffychat)
hivectl completions
Generate a shell completion script for hivectl and print it to stdout.
Supports bash, zsh, fish, elvish, and powershell. The NixOS module already installs the zsh script system-wide; this is for ad-hoc or other-shell use.
Usage: hivectl completions <SHELL>
Arguments:
-
<SHELL>— Shell to emit completions forPossible values:
bash,elvish,fish,powershell,zsh
This document was generated automatically by
clap-markdown.