CLI Overview
The kairos CLI is the primary interface for Substrate evaluation, trace management, scenario operations, and license management.
Installation
Section titled “Installation”Install the CLI from your release package or follow the installation guide.
Command Structure
Section titled “Command Structure”kairos <command> [subcommand] [options]Top-Level Commands
Section titled “Top-Level Commands”| Command | Description |
|---|---|
evaluate | Single-shot Substrate evaluation |
observe | Live telemetry TUI dashboard |
trace | Trace operations: export, diff, inspect, baseline, bundle, and more |
scenario | Scenario operations: lint, manifest management |
fingerprint | Print machine fingerprint for license registration |
activate | Install and validate a license file |
license | License operations: status |
Global Conventions
Section titled “Global Conventions”Output Formats
Section titled “Output Formats”Many commands accept --format with two options:
| Format | Description |
|---|---|
json | JSON output (default) |
table | Human-readable table format |
Exit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
0 | Success |
1 | Error (details in stderr) |
stdin Support
Section titled “stdin Support”Commands that accept file input (evaluate, trace diff, etc.) read from stdin when the file path is omitted. This enables piping:
cat request.json | kairos evaluate --config artifact.json --policy policy.jsonLicense Commands
Section titled “License Commands”kairos fingerprint
Section titled “kairos fingerprint”Print the machine fingerprint for license registration.
kairos fingerprint # Plain text outputkairos fingerprint --json # JSON outputkairos activate
Section titled “kairos activate”Install and validate a license file.
kairos activate --license /path/to/license.keykairos activate --license /path/to/license.key --target /opt/kairos/license.key| Flag | Required | Description |
|---|---|---|
--license | Yes | Path to the .key file from Ananke Labs |
--target | No | Install location (default: ~/.kairos/license.key) |
kairos license status
Section titled “kairos license status”Display the current license status.
kairos license statuskairos license status --jsonkairos license status --license /opt/kairos/license.key| Flag | Required | Description |
|---|---|---|
--license | No | Override license file path |
--json | No | Output as JSON |
Scenario Commands
Section titled “Scenario Commands”kairos scenario lint
Section titled “kairos scenario lint”Lint a scenario manifest for errors.
kairos scenario lint manifest.jsonkairos scenario manifest
Section titled “kairos scenario manifest”Scenario manifest operations: show, validate, diff, pack.
kairos scenario manifest show # Show embedded manifestkairos scenario manifest show --manifest custom.jsonkairos scenario manifest validate manifest.jsonkairos scenario manifest diff a.json b.jsonkairos scenario manifest pack create manifest.json --output archive.tarkairos scenario manifest pack validate archive.tarkairos scenario manifest pack diff a.tar b.tar