vox-cli-contracts API Reference (generated)
vox-cli-contracts
Section titled “vox-cli-contracts”Crate: vox-cli-contracts · Version: 0.6.0 · Target: Library (lib.rs)
Trait seam between vox-cli (provides impls) and vox-cli-ci (consumes them), plus shared check-manifest types. Sync, no tokio — keep the floor low.
Crate Overview
Section titled “Crate Overview”Trait seam that inverts vox-cli’s CI coupling: vox-cli implements these traits
(VoxCliProviders) and vox-cli-ci consumes them, so the CI subsystem can move out
without depending back on vox-cli. Also home to the shared check-manifest types.
Keep this crate’s code sync — it uses no async runtime directly, so it stays a
cheap leaf to compile. (The cargo tree -i tokio graph is not empty because the
workspace-hack feature-unification crate pulls tokio into every member’s tree; that
is a graph artifact, not a real dependency of this crate’s own compilation.)
Workspace Dependencies
Section titled “Workspace Dependencies”| Dependency | Kind |
|---|---|
vox-bounded-fs | Normal |
vox-config | Normal |
vox-jsonschema-util | Normal |
Public API Surface
Section titled “Public API Surface”Modules
Section titled “Modules”| Module | Description |
|---|---|
scientia_ledger_contract | Finding-candidate / novelty-bundle schema validation (vox scientia + the ci scientia-ledger gate). Lives here because it is shared by a non-ci command and ci. |
Structs
Section titled “Structs”| Struct | Description |
|---|---|
CheckManifest | Top-level structure of contracts/ci/check-targets.v1.yaml. |
CheckEntry | One quality-gate entry in the manifest. |
Traits
Section titled “Traits”| Trait | Description |
|---|---|
CheckProvider | Audit seam: enumerate contracts/ci/check-targets.v1.yaml into policy entries. Replaces ci’s direct crate::commands::audit::CheckManifest deserialization. |
GateStatusWriter | Policy seam: write gate-run status (VCS identity + results). ran_at stays caller-supplied — the single non-deterministic input, kept out of the impl. |
TerminalPolicyValidator | Runtime seam: terminal-policy validation for vox ci. The check_terminal primitives stay in vox-cli behind this impl; the orchestration moves to vox-cli-ci. |