vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
hyperhive/docs/tools
History
Repository files (latest commit first)
Filename Latest commit message Latest commit date
atlas cc2503d9c7 treefmt: a generated CLI doc is the generator's, not prettier's 
docs/tools/swarmctl-cli.md is rendered by `swarmctl markdown-docs`, and
nix/checks.nix's swarmctl-docs-fresh check diffs the committed copy
against fresh binary output. Enabling prettier on markdown rewrote its
list bullets and footer indentation, which no regeneration can settle:
formatting it fails the freshness check, not formatting it fails
treefmt. .prettierignore already carried hivectl-cli.md for exactly
this reason; swarmctl's doc was added later and the entry was not.

Restore the file to its generated bytes, list it alongside hivectl's,
and state the invariant where the next CLI doc gets added.
2026-09-02 15:25:07 +02:00
..
bash.md treefmt: apply prettier 2026-09-02 15:25:07 +02:00
forge.md hive-forge: lint stale-branches reports each branch's merge outcome 2026-08-28 21:44:19 +02:00
hivectl-cli.md hive-c0re/hivectl/hive-agent: pause as a job-queue DAG node (closes #3056) 2026-08-11 23:47:09 +02:00
hivectl.md treefmt: apply prettier 2026-09-02 15:25:07 +02:00
lifecycle.md treefmt: apply prettier 2026-09-02 15:25:07 +02:00
matrix.md docs: restructure into topic subdirectories, collapse duplicated index 2026-09-02 01:55:37 +02:00
README.md treefmt: apply prettier 2026-09-02 15:25:07 +02:00
scheduling.md docs: restructure into topic subdirectories, collapse duplicated index 2026-09-02 01:55:37 +02:00
swarmctl-cli.md treefmt: a generated CLI doc is the generator's, not prettier's 2026-09-02 15:25:07 +02:00

README.md

Tools

hivectl is your tool — the operator's own host CLI. Everything else here documents the tool surface your agents get inside their containers (the MCP tools an agent's own claude session can call). You never call these directly, but they're the reference for what an agent can actually do — useful when you're trying to understand or debug agent behavior.

For the operator

  • hivectl — the curated guide: provisioning forge and matrix accounts, gateway htpasswd management, container lifecycle shortcuts, interactive agent shell access.
  • hivectl-cli — the exhaustive, auto-generated flag-by-flag reference, kept in lockstep with the binary by CI.

For the swarm operator

  • swarmctl-cli — the exhaustive, auto-generated flag-by-flag reference for swarmctl, kept in lockstep with the binary by CI the same way hivectl-cli.md is. swarmctl itself runs as root on the swarm-controller host, not through hivectl — see swarmctl/README.md for why. No curated guide yet (one verb, user add, doesn't need one); add one here if/when that grows.

What your agents can do

  • bash — background shell execution (mcp__bash__*), available on every agent unconditionally.
  • forge — the hive-forge Forgejo CLI every agent has for issues, PRs, and comments. Not an MCP tool — a binary agents shell out to instead of ad-hoc curl.
  • lifecycle — kill/start/restart/update for an agent's own direct children, plus the approval-gated config-change tools.
  • matrix — the matrix MCP tool surface (mcp__matrix__*) for agents with a matrix account, multiple accounts per agent, and declaring extra MCP servers generally.
  • scheduling — scheduled prompts (operator approval required) and the diagnostics tools (get_logs, get_host_journal).