Watch
0
0
Fork
You've already forked hyperhive
0
hyperhive/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
iris e4cfac6926 frontend: root test and typecheck scripts, and tests for the review runs wording and the terminal drag
npm test and npm run typecheck now run in every workspace that has them (the repo root had only build and clean). New tests cover RunsTypes (labels and tones for every outcome, the classification count) and termDrag (what a drag carries and how the hover reads it). instructions.ts cannot be imported by a test under Node because of its .js specifier for unified-diff.ts, so it is not covered, and the conventions doc says so.
2026-11-20 00:28:04 +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 swarm-controller: an opt-in plain /healthz and /readyz listener a kubelet can probe 2026-11-19 12:23:17 +01:00
4-implementation hive-egress: the spoof log line says which check failed 2026-11-20 00:27:20 +01:00
5-project frontend: root test and typecheck scripts, and tests for the review runs wording and the terminal drag 2026-11-20 00:28:04 +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 add an ssh ca to bao, agent ssh certificates and a target module 2026-11-16 20:31:18 +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.