Skip to content

Pre-release. v0.1 is not out yet, so there is nothing to install and no public source to clone — the quickstart builds from a checkout.

Reference

Two kinds of page live here, and the difference matters more than it usually does.

Copies. The contract is a document in the control plane’s own repository, next to the code that implements it. This site renders a copy taken at a pinned commit and never edits the prose. Each copy says at the top which commit it came from.

  • The v0.1 API surface — discovery, registration, exchange, the claim set, refresh, revocation, the audit record, the errors, and what a tool server must do.
  • The admin API — the agent registry, the kill switches and the audit query.
  • The conformance suite — the adversarial tests that run against a live instance.

Written here. Things with no home in the control plane’s repository, because they are the shape of an answer rather than part of the contract:

A copy of a specification is a specification that can be wrong without anybody noticing, so it is generated and checked rather than pasted:

  1. sync/onbe-docs.json pins one commit of the control plane repository and records the SHA-256 of each source file and of the page generated from it.
  2. pnpm sync regenerates the pages from that commit. It adds frontmatter and the note at the top of each page; the prose below is copied byte for byte, and the source’s own title becomes the page title so the article has one h1 rather than two.
  3. pnpm sync:check runs in CI. It fails if a generated page has been edited here, and — when it can reach the source — if the pinned commit no longer holds what was synced.

The pin moves by hand. A specification that changed under the site without anybody reading the diff is the failure mode worth designing against, and one command with a diff to review is a cheaper defence than a robot that opens pull requests nobody reads.

There is no OpenAPI document yet, and no generated client. The contract is small enough to read in one sitting, and v0.1 is not released, so a generated artefact would pin an interface that is still moving. When it stops moving, that is the thing to add.

OnbePre-release. v0.1 is not out yet.

© 2026 Onbe