CLI command reference

The ktm CLI groups commands by resource. It exposes 149 commands across 28 top-level groups. Pick a group below, or use the sidebar.

Global flags

These flags apply to every command:

Flag	Type	Default	Description
`--api-key-file`	string		Path to file containing API key (alternative to KAPPTIVATE_API_KEY env var)
`-d, --debug`	boolean		Enable debug output: HTTP requests, timing, and verbose errors on stderr
`--host`	string		API host (env: KAPPTIVATE_HOST, default: app.kapptivate.com)
`--no-color`	boolean		Disable colored output (also: NO_COLOR env, TERM=dumb)
`--no-proxy`	boolean		Disable HTTP proxy from environment
`-o, --output`	string	`json`	Output format: json, table, or plain (TSV)
`-q, --quiet`	boolean		Suppress info-level log lines on stderr, only show errors
`--skip-tls`	boolean		Skip TLS certificate verification (insecure)

Commands

adb

ADB — use remote phones as if they were plugged into your machine

agents

Agents — infrastructure health, capacity, and runtime feature control

alerts

Alert definitions — persistent rules that automatically trigger incidents on the platform

artifacts

Artifacts — fetch screenshots, recordings, and other test artifacts

CI/CD test execution — run tests from JSON config files and report results

collections

Collections — hierarchical tree of tests and dashboards

dashboards

Dashboards — operator-level analytics dashboards with metric widgets

executions

Executions — campaign run results with per-test pass/fail data

incidents

Incidents — triggered alerts on the platform (OPEN, CLOSED, MANUALLY_CLOSED)

init

Scaffold an agent-ready test-authoring workspace (skills, MCP config, catalog layout)

Authenticate against Kapptivate via OAuth 2.1 + PKCE

logout

Clear the stored OAuth token (and revoke it server-side)

metrics

Metrics — query monitor KPIs, passive collector data, and device utilization from InfluxDB

monitoring-results

Monitoring results — run outcomes from scheduled monitors

monitors

Monitors — scheduled recurring executions of tests with status tracking

operators

Operators — top-level organisational entities that own products, tests, and users

products

Products — applications or services under an operator that contain tests and monitors

resources

Resources — SIMs, web agents, and smartphones available for test execution

reusables

Reusables — shared test fragments (tests with kind=2) embedded via import actions

shell

Shell — interactive live sessions on SIM cards and web agents

status

Check connectivity, authentication, and CLI version

test-campaigns

Tests campaigns — named ordered packs of tests

tests

Tests — automated test scenarios that can be executed and monitored

update

Update ktm to the latest release (or a specific version)

use

Show or switch the workspace's default product (.ktm.json)

users

Users — human users and service accounts with access to the platform

variables

Variables, groups, and variants — product-scoped configuration

whoami

Show the identity the CLI authenticates as (API key or stored OAuth token)

What's next?

Get started

Install the CLI and authenticate.

CI/CD

Run tests from your pipeline.