CLI commands
Every command of the kaloko CLI with what it does. Run them with npx kaloko <command> in a project that has the package installed. npx kaloko help prints the same list with every option.
Options that work everywhere: --run <id|dir> (or KALOKO_RUN) picks the run, --config <file> the config file, and KALOKO_AGENT=<name> labels what an agent writes.
Set up a project
| Command | What it does |
|---|---|
kaloko init | Creates kaloko.config.yml, installs the skill for Claude Code or Codex (--agent), detects the framework, dev server, languages and main routes, drafts a first scenario; --docs=off|changelog|full sets up the changelog and the docs folders |
kaloko login | Signs this machine in through the browser and saves a token (at most 30 days) to ~/.config/kaloko/.env; --print prints it instead |
kaloko doctor | Checks Node, Chrome, the config, environments, browser ports, the token, the evaluator key and app tools; --fix asks macOS for capture permissions |
kaloko draft <url…> | Drafts a first plan and a read-only scenario for public pages, with the seo, a11y, perf and console packs |
kaloko validate <file…> | Checks scenarios against the schema and their references; --coverage compares the criteria with the acceptance plan |
kaloko scenarios | Lists the scenarios the config matches |
kaloko ci github|gitlab | Writes a workflow that walks what each pull request affects on its preview deployment and comments on it |
kaloko ci github --release | Writes a workflow that records every release your release tool publishes |
kaloko ci preview-url | In CI: finds the preview URL, the pull request and its base |
Walk and capture
| Command | What it does |
|---|---|
kaloko start | Creates a run of --scenario on --env and makes it current; --locales, --viewports, --browsers, --color-schemes, --devices and more choose what to capture |
kaloko walk | Runs the Playwright steps and captures them, then evaluates; --affected, --record, --heal, --stability N, --concurrency N, --ephemeral |
kaloko capture --step <id> | Captures the current page for a step; --crop attaches an element, --image imports a screen taken by another tool |
kaloko open --step <id> | Opens the step's URL in the shared browser |
kaloko mail --step <id> | Captures an e-mail from the environment's mailbox, or a saved message with --file |
kaloko browser start|stop|status | One shared browser per environment that agents, scripts and people drive |
kaloko browser install | Downloads the browser engines (--browsers chromium,webkit,firefox) |
kaloko devices | Lists the device presets you can use as viewports |
kaloko session reset | Starts as a new visitor: clears cookies and storage in the shared browser |
kaloko auth save | A person signs in once (SSO, MFA) and the walk reuses the session; kaloko auth list shows saved sessions |
kaloko affected | Says which steps the changed files reach, and why |
kaloko import <path> | Lays out screenshots, Playwright reports, traces or a walkthrough as a run |
kaloko status | Shows what the current run has captured |
Results and review
| Command | What it does |
|---|---|
kaloko evaluate | Runs the deterministic checks and the semantic evaluator for all captures; --recheck after a scenario change |
kaloko build | Writes run.json and the local preview |
kaloko preview | Builds the preview and prints its path |
kaloko share | Uploads the run to kaloko.app; --pr comments on the pull request or merge request |
kaloko review | What a person still has to decide on a shared run, and the review-mode link |
kaloko feedback | Open comments from reviewers, returned steps first |
kaloko comment | Comments, replies, resolves and reopens feedback from the terminal |
kaloko compare | A text diff of two runs: statuses, verdicts, scores and evidence |
kaloko stability | Finds regions that change on every run; --apply adds them to the scenario, --pull brings in regions drawn on kaloko.app |
kaloko calibrate | Compares the semantic evaluator with human labels and suggests thresholds |
kaloko signoff <run-id> | Downloads the signed acceptance record of an accepted run; --verify <file> checks one without a token |
kaloko video export | Turns the run's recordings into one video; kaloko video list, trace and tools show recordings, traces and tools |
kaloko screens | Searches the newest screenshot of every step across your flows |
kaloko inbox | Your notifications on kaloko.app |
Shared runs
| Command | What it does |
|---|---|
kaloko projects | Projects of the organization |
kaloko runs | Shared runs, the newest per scenario; --all lists every run |
kaloko trash <run-id…> | Moves runs to the trash; kaloko restore <run-id> brings one back |
kaloko prune | Keeps the newest runs per scenario and environment and lists the rest for the trash; --yes moves them |
kaloko keep <run-id> | A kept run never expires and is never pruned; --off releases it |
kaloko archive <scenario-id> | Hides a retired scenario from the list; its runs stay |
kaloko public | Makes a shared run readable without signing in |
kaloko export | Downloads a shared run as a zip; --scenario the newest capture of every step; --format the docs and changelog |
Jira, Linear and hosted runs
| Command | What it does |
|---|---|
kaloko issue create | An issue in Jira or Linear from a returned step or a failing criterion; kaloko issue list shows them |
kaloko schedule add | Kaloko opens the pages of a read-only scenario every day or week and shares the run |
kaloko schedule list|run|pause|resume|remove | Manages the schedules |
kaloko schedule export github | A GitHub Actions workflow that walks the scenario on a schedule with the full CLI |
Products, changelog and docs
| Command | What it does |
|---|---|
kaloko products sync | Puts the products of the config on Kaloko without recording a release |
kaloko products list | The products you read on Kaloko, and those of the config that are not there yet |
kaloko changelog draft | Writes the Unreleased entry from merged pull requests and changed screens; --apply writes it into CHANGELOG.md |
kaloko release [<version>] | Records a release with its changelog entry, pictures and docs |
kaloko docs publish | Sends the docs folder to Kaloko as the docs of a version |
kaloko docs check | Broken references, stale sections, missing translations and changelog items without a picture; exits 1 on errors |
kaloko export --format <f> | The docs and changelog as Markdown, Docusaurus, VitePress, MkDocs, HTML, PDF or JSON |
Design
| Command | What it does |
|---|---|
kaloko sync | Exchanges design revisions with the shared draft (--pull, --push) |
kaloko design lint | Checks the design folder against the portable HTML rules |
kaloko design import figma | Turns Figma frames into design steps and variables into tokens |
kaloko history | Versions of the flow and revisions of a step |
kaloko spec [step] | What to build for an approved design step: elements, styles mapped to tokens, states |
kaloko drift [step] | How the implementation differs from the approved design; exits 1 while it differs |
kaloko reference | Shows or sets the design reference and the baseline |
kaloko tokens pull|push|check|validate | The project's design tokens (DTCG) |
kaloko branch list|create|merge | Branches of the design draft |
kaloko help prints all of this with every option.