Install the ktm CLI

ktm ships as a single self-contained binary for Linux, macOS, and Windows. Once it is on your PATH, you sign in with your browser (or an API key) and you are ready to go.

Install ktm

Run the one-liner for your platform:

curl -fsSL https://artefacts.kapptivate.com/ktm/install.sh | bash

The installer fetches the latest stable ktm, verifies its checksum, and adds it to your PATH. Set KAPPTIVATE_VERSION=1.5.0 to pin a specific version.

Prereleases ship on the beta channel. Set KAPPTIVATE_CHANNEL=beta to install the latest one:

curl -fsSL https://artefacts.kapptivate.com/ktm/install.sh | KAPPTIVATE_CHANNEL=beta bash

Confirm the install:

ktm --version

Authenticate

For interactive use, sign in with your browser (OAuth):

ktm login
ktm status

ktm login opens your browser for a secure sign-in and stores the session in your OS keychain. ktm whoami shows who is signed in, and ktm logout ends the session.

For CI and scripts, use an API key instead. ktm reads it from the KAPPTIVATE_API_KEY environment variable:

export KAPPTIVATE_API_KEY="your-key"
ktm status

When both are present, the API key takes precedence. ktm status checks connectivity, authentication, and the CLI version in one call, and names the credential actually in use. A clean result means you are ready.

In CI, store the key as a secret and expose it as KAPPTIVATE_API_KEY. Never hard-code it in a workflow file.

What's next?

Get started

Discover your slugs, list tests, and run them.

Configuration

Environment variables, output formats, and exit codes.

CI/CD

Wire ktm into your pipeline.