Skip to main content

Reference

Reference documentation for everything the framework exposes: commands, formats, tools, the project file and the exchange format. It is generated from the code and from the format and tool schemas. The navbar's Reference menu lists the same set.

Interactive references​

Generated from the live registries and schemas:

  • kapi CLI commands: every kapi command, with runnable examples.
  • Format reference: every format reader/writer and its configurable parameters. Each card is tagged built-in (the native engine) or plugin (added by an installed engine plugin).
  • Tool reference: every processing tool and its inputs and outputs, grouped by category and tagged by source the same way.
  • Check reference: every check kapi check runs over source content, with the rule ids its findings carry and what fixes each.

Each entry also has its own static, indexable page (see the note below).

Configuration & integration​

  • Project file: the kapi.yaml recipe format, its fields, and how kapi discovers a project.
  • KBF format: the Kapi Bundle Format, the JSON exchange serialization of the content model: spec, examples, an XLIFF comparison, and an interactive lab and conformance suite.
  • Prompt reference: every prompt kapi sends to a language model, generated from the builders the binary uses.
  • MCP server: the kapi MCP tools exposed to AI assistants.
  • Scripting & JSON contract: structured --json results, the error envelope, exit codes, and NDJSON progress events.

What kapi is measured against​

Every measurement kapi publishes is indexed at Tests and evals: what each one covers, what it does not, the corpus behind it and the date it was last run. The index is generated from the suites themselves, so it lists the planned evals beside the built ones.

note

Every command, format, and tool also has its own static, indexable page under /reference/commands/<id>, /reference/formats/<id>, and /reference/tools/<id>, generated from the same data and linked from each card in the grids above. These per-entry pages are the canonical, shareable URLs; the grids remain the browse index.