Watch
0
0
Fork
You've already forked hyperhive
0
hyperhive/hive-c0re/README.md
iris 6739bb903d docs: sort the top-level directories into five sections by what the reader wants
Every docs directory moves under 1-getting-started, 2-handbook,
4-implementation or 5-project; the options reference (section 3) comes from
the website and has no directory here. trust-boundary stays whole under the
handbook for now. web-ui, swarm and tools split between handbook and
implementation, and the command-line references move to
2-handbook/reference. Links, path references in code and nix, and the docs
index follow the moves; no page content changes.
2026-11-06 18:46:57 +01:00

53 lines
2.4 KiB
Markdown

# hive-c0re
The unprivileged host daemon (runs as `hive-core`). Owns the sqlite
broker, the reminder queue, the generic job-DAG
queue, container lifecycle, gateway vhost wiring, forge/matrix config
reconciliation, per-container stats, and the axum operator dashboard.
Largest crate in the workspace — bin-only, no separate lib.
## When to use it
Host-level, cross-container orchestration: spawning/rebuilding/
destroying agent containers, dashboard-visible
state, wiring each agent's gateway vhost and reconciling its forge
config-repo access and matrix room membership. The accounts themselves
are swarm-controller's (`docs/2-handbook/integrations/forge.md`). Agent-side
behavior (turn loop, MCP tools) lives in `hive-agent`/`hive-agent-mcp`
instead — this daemon only talks to agents over the socket wire types
in `hive-sh4re`.
## Shape
Cohesive clusters live in directory submodules, each re-exported at
the crate root (`crate::broker::…` keeps resolving regardless of which
subdirectory a module actually lives in). One line each — read the
module's own `//!` doc-comment for real detail, don't expect this file
to track it:
- **`dashboard/`** — the operator dashboard (containers,
schedules, logs, topology).
- **`job_queue/`** — the job-DAG queue + desired-state reconciliation
(`docs/4-implementation/scheduler/coordinator.md`).
- **`lifecycle/`** — `nixos-container` lifecycle + per-agent config
flake generation.
- **`stores/`** — sqlite-backed stores (broker, queues, audit, power).
- **`workers/`** — background sweeps (crash watch,
autoupdate, knowledge sync).
- **`agent_config/`** — per-agent registries (permissions,
resource limits, topology).
- **`stats/`** — dashboard metrics aggregation + OTEL export.
- **`socket_server/`** — the unix-socket request server for the
per-agent sockets.
- **`forge/`** — optional Forgejo wiring (`docs/2-handbook/integrations/forge.md`).
- **`coordinator.rs`** — top-level wiring for `serve`.
- **`agent_set.rs`** — the files that
follow the agent set (topology, gateway map). **`meta.rs`** — the commit
that removes the legacy permission seed files. **`migrate.rs`** —
schema/state migrations.
- **`matrix.rs`**, **`gateway_nginx.rs`**, **`priv_client.rs`** —
matrix provisioning, gateway vhosts, and the `hive-priv` client
respectively.
See the top-level `AGENTS.md`/`docs/` index for the full reading-path
map.