Skip to content

Reference

Exact behaviour of the tool, for looking things up rather than learning.

Page What it covers
Commands every command and flag, with its type, default and exit codes
Configuration every key of the suite file, with its default and rules
Run file format every field of the JSON file a run writes
Exit codes what 0, 1, 2, 3, 4 and 130 mean, and what produces each
JUnit test reports the XML that run --junit and compare --gate --junit write, and how to read it in CI
Concepts suites, runs, scorers, calibration, the gate and how cases are paired
API reference the Python objects, generated from the docstrings
Glossary what each term the reports use means