Browse docs

Reference Documentation

This section provides detailed technical reference documentation for InvarLock's configuration, CLI, APIs, guards, and supporting infrastructure.

Quick Navigation

DocumentPurposeAudience
CLI ReferenceCommand-line interface and optionsAll users
Tier Policy Tuning CLI (Calibration)Tier policy sweep harnessesOperators recalibrating thresholds
Configuration SchemaYAML config structure and precedenceCLI users
GuardsSafety check configuration and evidenceUsers tuning guards
Model AdaptersAdapter selection and capabilitiesCLI and API users
Public ContractsStable public contracts for reports, verification, and policy artifactsTool authors, reviewers
DatasetsDataset providers and pairingCLI users
reportsv1 schema, telemetry, and HTML exportOperators, tool authors
ArchitectureSystem layers, data flow, and dependenciesBuilders, reviewers
Tier Policy CatalogGuard threshold explanationsOperators auditing policies
Environment VariablesRuntime toggles and flagsOperators
API GuideProgrammatic interfacePython developers
ObservabilityMonitoring and telemetryOperators

By Task

Running Evaluations

  1. CLI Reference — evaluate, verify, run commands
  2. Configuration Schema — YAML presets and profiles
  3. Datasets — Provider configuration
  4. Model Adapters — Adapter selection
  5. Public Contracts — Machine-readable trust contracts

Understanding reports

  1. reports — v1 schema, telemetry, and HTML export
  2. Artifact Layout — File organization

Tuning Guards

  1. Guards — Configuration and evidence
  2. Tier Policy Catalog — Threshold rationale
  3. Tier Policy Tuning CLI (Calibration) — Sweep harnesses for recalibrating thresholds
  4. GPU/MPS-First Guards — Design decisions

Programming Against InvarLock

  1. API Guide — CoreRunner.execute and helpers
  2. Programmatic Quickstart — Minimal examples
  3. Architecture — System layers and data flow
  4. Public Contracts — Evidence and policy contract surfaces
  5. Observability — Monitoring infrastructure

Operations

  1. Environment Variables — Runtime configuration
  2. Artifact Layout — Evidence retention
  3. Observability — Health checking and telemetry