Expand description
TOML-based embedding engine configuration for khive.
Loads .khive/config.toml (or --config / KHIVE_CONFIG) and exposes an
[[engines]] array for arbitrary-N embedding engine registration. Falls back
to KHIVE_EMBEDDING_MODEL env vars when no config file is present.
Structs§
- Actor
Config - Actor configuration — the default namespace / identity for this khive instance.
- Backend
Config - Configuration for a named storage backend.
- Brain
Section Config [brain]read policy resolved by the serving process.- Display
Section Config [display]section inkhive.toml— the timezone khive anchors date-only input to (ADR-169 Implementation step 1).- Engine
Config - Configuration for a single embedding engine.
- Exec
Limits Config [exec.limits]: per-run resource limits applied to the sandboxed child and inherited by its descendants (setrlimitbefore exec).- Exec
Section Config [exec]section (ADR-181): where runs materialize, what they may read, which caller environment keys pass through, which executable paths theneverlist matches, and the output caps, wall-clock defaults and resource limits.nevermatches paths, not a program’s capabilities (ADR-181 A9).- Gate
Section Config - Built-in caller-enrollment policy configured by
[gate]. - GitWrite
Actor Config - GitWrite
Entry Config - One
[[git_write.allowed]]entry: a repo this operator has declared trusted for khive-mediated git writes, plus the branches on it a write verb (git.commit/git.branch/git.update_ref/git.push) may target. - GitWrite
Repository Config - GitWrite
Section Config [git_write]section — the closed repo/branch allowlist consulted bykhive-pack-git’s write verbs at the handler level (ADR-108 Amendment), independent of Gate policy. Absent or emptyallowedis the fail-closed default: the write verbs report themselves unavailable rather than defaulting open.- Khive
Config - Top-level khive configuration loaded from
khive.tomlorconfig.toml. - Pack
Config - Per-pack backend assignment.
- Runtime
Section Config [runtime]section inkhive.toml.- Storage
Section Config [storage]section inkhive.toml. Holds storage-layer config not already covered by[[backends]](ADR-028).- WebAllowlist
Entry - One
[[web.allowlist]]entry: an exclusive host the operator has opted into reachability forweb.fetch/web.search. Presence of ANY entry makes the allowlist exclusive (ADR-175 A1.2.3); absence leaves the public internet reachable subject to the other egress rules. Matched by exact, normalized (lowercase, trailing-dot-stripped) host equality only — no suffix wildcarding, unlike[[web.credentials]].hosts(A1.2.6). - WebCeilings
- Effective operator bounds shared by file validation and programmatic web dispatch.
- WebCredential
Config - One
[[web.credentials]]entry: a named secret, read from the process environment at request time (never accepted as a verb argument), bound to the set of hosts it may be presented to. Eachhostsentry is either an exact IP-literal address (matched exactly, never as a suffix) or a hostname suffix (example.commatchesexample.comand any*.example.comat a DNS label boundary) — ADR-175 A1.2.6. - WebFixture
Result - One canned result inside a
kind = "fixture"[[web.search_providers]]entry — deterministic, non-networked search results (demos, offline corpora, and the fixture arm ofweb.search’s own test suite). - WebSection
Config [web]section (ADR-175 Amendment 1, ADR-191 D3): operator policy forweb.fetchandweb.search— ceilings, the address allowlist, credential host-set bindings, and configured search providers.
Enums§
- Backend
Kind - Storage backend kind.
- Blob
Config [storage.blob]section: a closedbackend = "fs" | "s3"selector.- Config
Error - Errors produced while loading or validating a
KhiveConfig. - WebSearch
Provider Config - One
[[web.search_providers]]entry (ADR-175 A1.3). The provider is operator configuration;web.search’sproviderargument only selects among entries declared here byname. Closed, tagged onkind.
Functions§
- config_
from_ env - Build an in-memory
KhiveConfigfrom the legacy env-var path.