Watch
0
0
Fork
You've already forked hyperhive
0
hyperhive/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-21 21:40:56 +01:00
..
1-getting-started hive: install container@.service on every hive, so agents created with nixos-container can start 2026-11-19 14:41:58 +01:00
2-handbook hive ui: the dashboard wears the swarm UI's chrome, and its own header, tab strip and menu mounts go 2026-11-21 10:47:37 +01:00
4-implementation swarm-controller: config repos require the swarm-builder status and default to fast-forward-only merges 2026-11-21 21:40:56 +01:00
5-project frontend: one time wording for the swarm UI and the dashboard, and no HTML strings in the dashboard's busy buttons 2026-11-20 17:02:32 +01:00
examples/semi-spread swarm-stt: the deploy module (deploy.stt.*, sandboxed container, store leaf, queue grants) and its docs 2026-11-12 12:18:32 +01:00
README.md docs: the repo's own CI checks move from the CI runner page to the project process docs 2026-11-20 02:15:46 +01:00

hyperhive docs

Depth reference for hyperhive — the substrate, not the pitch (that's the top-level README / website). Every page here stands alone; pick the one matching your task rather than reading top to bottom. The docs sit in five sections, by what the reader wants:

  1. Getting started: what hyperhive is, and how to bring one up.
  2. Handbook: running and using a hive and a swarm.
  3. Options reference: every NixOS option.
  4. Implementation: how it works inside.
  5. Project: how the project itself works.

1. Getting started

2. Handbook

Using and operating hyperhive, in the three layers that make it up, plus the accounts an agent can hold outside it. Some pages here still carry implementation detail next to the operator content; sorting those out is later work.

Swarm

The services that exist once per swarm. Start at 2-handbook/swarm/.

Hives

The host a hive runs on and the operator's tools for it. Start at 2-handbook/hives/.

Agents

One agent: its entry in the agent list, state, config and page. Start at 2-handbook/agents/.

External accounts

Accounts outside the swarm that an agent can hold. Start at 2-handbook/external-accounts/.

3. Options reference

The autogenerated NixOS options reference (every services.hyperhive.* / hyperhive.* option, host and agent) lives on the website, built from the module declarations: the options site. Nothing of it sits in this tree.

4. Implementation

Agent tools

Agent state

Turn loop, scheduler, CI, observability

Networking

Swarm services

Trust boundary mechanics

Web UI internals

  • How's the dashboard built, and how does the terminal render? → shape, css-vars, terminal-rendering.
  • What does each swarm UI page show, down to its endpoints? → swarm-ui.
  • What's on each tab of the hive dashboard? → dashboard.
  • What does an agent's own web server serve, in full? → agent-page.

Crate reference

  • What does a specific Rust crate do, on its own terms? → 4-implementation/crates/ — every workspace crate's own README.md, one level up from source; the crate itself is still the source of truth, this is just a walkable mirror.

5. Project

How the project itself works: processes, conventions, design guides.