CastlesDocs
Getting startedDocumentation preview

Get the source

Use Node.js 22 or newer and Corepack. The operator package pins pnpm 10.32.1. There is no published install command in this repository; start from its source checkout.

Shell
git clone https://github.com/OpenCoven/coven-castles.git
cd coven-castles
corepack pnpm install --frozen-lockfile

The documentation describes source revision ecd360702e0d. Newer source may change the contract; consult its README and tests when using another revision.

Run the offline checks

Shell
corepack pnpm test
corepack pnpm typecheck

The test suite uses synthetic inputs and needs no provider credentials or IP networking. A passing suite is offline evidence. Runtime denial of networking depends on the Node version; see the source README for the permission-model test limits.

Replay a ready fixture

Shell
corepack pnpm check --fixture fixtures/preflight/cases/ready.json

Use JSON when consuming the result in a tool:

Shell
corepack pnpm check --json --fixture fixtures/preflight/cases/ready.json

Do not gate on status alone. Live readiness requires status: "ready" and evidence: "live-provider"; the current package cannot produce that combination.

Exercise a refusal

Shell
corepack pnpm check --json --fixture fixtures/preflight/cases/public-exposure.json

Expected exit code: 1. The public-exposure case is incompatible with the private sandbox profile. Castles reports the finding and makes no repair.

More synthetic cases cover missing IDs, owner and generation mismatch, unavailable providers, stopped sandboxes and ambiguous lookups. Read the fixture guide before adding cases.

Before attempting a live check

Configuration is documented under Binding configuration, but configuring a target does not enable live inspection. Without a fixture, the current CLI has no live client. A valid configured binding reports unavailable with upstream_seam_missing.

Wait for an accepted canonical inspection capability and a separately authorized live window. The qualification page describes the remaining gates.

Search only Coven Castles documentation.