Skip to content

CLI Overview

The kairos CLI is the primary interface for Substrate evaluation, trace management, scenario operations, policy validation, and license management.

Build the CLI from the kairos-engine workspace:

Terminal window
# Standard CLI
cargo build -p kairos-cli --profile release-native
# CLI with the observe TUI dashboard
cargo build -p kairos-cli --features tui --profile release-native

The binary is placed at target/release-native/kairos. Add it to your PATH or install it to a standard location.

kairos <command> [subcommand] [options]
CommandDescription
evaluateSingle-shot Substrate evaluation
observeLive telemetry TUI dashboard (requires tui feature)
traceTrace operations: export, diff, inspect, baseline, bundle, and more
scenarioScenario operations: lint, manifest management
eventsEvent script operations: lint, inspect, diff
policyDeployment policy operations: validate, inspect
hitlHITL coordinator and operator operations
fingerprintPrint machine fingerprint for license registration
activateInstall and validate a license file
licenseLicense operations: status
backtestBacktest operations: score traces against expected outcomes

Many commands accept --format with two options:

FormatDescription
jsonJSON output (default)
tableHuman-readable table format
CodeMeaning
0Success
1Error (details in stderr)

Commands that accept file input (evaluate, trace diff, etc.) read from stdin when the file path is omitted. This enables piping:

Terminal window
cat request.json | kairos evaluate --config artifact.json --policy policy.json

Print the machine fingerprint for license registration.

Terminal window
kairos fingerprint # Plain text output
kairos fingerprint --json # JSON output

Install and validate a license file.

Terminal window
kairos activate --license /path/to/license.key
kairos activate --license /path/to/license.key --target /opt/kairos/license.key
FlagRequiredDescription
--licenseYesPath to the .key file from Ananke Labs
--targetNoInstall location (default: ~/.kairos/license.key)

Display the current license status.

Terminal window
kairos license status
kairos license status --json
kairos license status --license /opt/kairos/license.key
FlagRequiredDescription
--licenseNoOverride license file path
--jsonNoOutput as JSON

Validate a deployment policy file.

Terminal window
kairos policy validate policy.json

Checks JSON schema conformance, base policy signature, override constraints, and HITL configuration.

Show the resolved deployment policy configuration.

Terminal window
kairos policy inspect policy.json

Displays the effective policy after applying operator overrides to the base policy.

Lint a scenario manifest for errors.

Terminal window
kairos scenario lint manifest.json

Scenario manifest operations: show, validate, diff, pack.

Terminal window
kairos scenario manifest show # Show embedded manifest
kairos scenario manifest show --manifest custom.json
kairos scenario manifest validate manifest.json
kairos scenario manifest diff a.json b.json
kairos scenario manifest pack create manifest.json --output archive.tar
kairos scenario manifest pack validate archive.tar
kairos scenario manifest pack diff a.tar b.tar

Lint an EDMS event script for errors.

Terminal window
kairos events lint events.json

Inspect an event script and print summary.

Terminal window
kairos events inspect events.json
kairos events inspect events.json --format table

Diff two event scripts.

Terminal window
kairos events diff a.json b.json