Skip to content

Reference Documentation

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

Quick Navigation

Document Purpose Audience
CLI Reference Command-line interface and options All users
Tier Policy Tuning CLI (Calibration) Tier policy sweep harnesses Operators recalibrating thresholds
Configuration Schema YAML config structure and precedence CLI users
Guards Safety check configuration and evidence Users tuning guards
Model Adapters Adapter selection and capabilities CLI and API users
Model Family Catalog Authoritative support inventory and backlog Reviewers, tool authors
Public Contracts Stable public contracts for reports, verification, and policy artifacts Tool authors, reviewers
Datasets Dataset providers and pairing CLI users
reports v1 schema, telemetry, and HTML export Operators, tool authors
Architecture System layers, data flow, and dependencies Builders, reviewers
Tier Policy Catalog Guard threshold explanations Operators auditing policies
Environment Variables Runtime toggles and flags Operators
API Guide Programmatic interface Python developers
Observability Monitoring and telemetry Operators

By Task

Running Evaluations

  1. CLI Reference — evaluate, verify, report, and advanced
  2. Configuration Schema — YAML presets and profiles
  3. Datasets — Provider configuration
  4. Model Adapters — Adapter selection
  5. Model Family Catalog — Support inventory and backlog
  6. 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 — Advanced/non-stable Python integration surface
  2. Programmatic Quickstart — Minimal examples
  3. Architecture — System layers and data flow
  4. Model Family Catalog — Support inventory and backlog
  5. Public Contracts — Evidence and policy contract surfaces
  6. Observability — Monitoring infrastructure

Operations

  1. Environment Variables — Runtime configuration
  2. Artifact Layout — Evidence retention
  3. Observability — Health checking and telemetry
  4. CLI Reference — Advanced namespaces such as evidence-pack, policy, and plugins