Skip to content

Reference

Lookup material. Nothing in this tab tells you how to do anything — go to Use capa for that. This is where you come when you already know what you're trying to do and need to check a name, a code, a format, or a variable.

  •   Glossary

    Plain-English definitions of every term capa's docs use as a keyword: bundle, channel, procedure, profile, conductor, worker, bridge, saturation deadline.

  •   File formats

    Every on-disk format capa reads or writes — YAML, TOML, Parquet, SQLite, JSON, MKV, CSQ — with a pointer to the schema doc for each.

  •   Environment variables

    Runtime knobs capa honors via the process environment — debug toggles, probe activation, storage roots, hardware overrides.

  •   Exit codes

    What each non-zero exit from capa run, capa validate, and the other CLI verbs means, and what to do about it.

  •   Changelog

    Per-release notes — runtime protocol revisions, breaking config changes, bundle schema migrations.

A few cross-cutting references live in their own tabs because they're more useful next to their context: