Skip to content

CLI Overview

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

Install the CLI from your release package or follow the installation guide.

kairos <command> [subcommand] [options]
CommandDescription
evaluateSingle-shot Substrate evaluation
observeLive telemetry TUI dashboard
traceTrace operations: export, diff, inspect, baseline, bundle, and more
scenarioScenario operations: lint, manifest management
fingerprintPrint machine fingerprint for license registration
activateInstall and validate a license file
licenseLicense operations: status

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

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