CLI overview

ktm is the Kapptivate command-line interface for running tests in CI, managing resources, and querying the platform from your terminal.

ktm is the Kapptivate command-line interface. It runs tests in CI/CD pipelines, manages tests, monitors, variables, and collections, and queries the platform API, all from your terminal. Every command returns JSON by default, so it composes cleanly with jq and scripts.

Highlights

  • JSON-first output, with table and plain (TSV) formats when you want them
  • A single self-contained binary, no runtime dependencies
  • Built for CI: stable exit codes, JUnit XML, and native GitHub Actions annotations
  • The same API key as the MCP server and the web app

A quick taste

# Discover what you can access
ktm operators list
ktm products list --operator my-operator

# List tests for a product, as a table
ktm tests list --operator my-operator --product my-operator~my-product -o table

Authentication

ktm reads your API key from the KAPPTIVATE_API_KEY environment variable. Every command except local validation needs it. See Configuration for the details.

What's next?

Installation

Get the binary onto your PATH and authenticate.

Get started

A five-minute tour: discover, list, and run.

Command reference

Every command, flag, and argument.

CI/CD

Run tests from your pipeline.

Last updated on