CLI

The command-line interface for TopK.

Command-line interface for TopK.

Installation

brew tap topk-io/topk
brew install topk

Authentication

To authenticate, run:

topk login

Alternatively, you can set TOPK_API_KEY environment variable and skip the topk login command.

export TOPK_API_KEY=<your-api-key>

Commands

login

To authenticate, run:

topk login

Alternatively, you can set TOPK_API_KEY environment variable and skip the topk login command.

export TOPK_API_KEY=<your-api-key>

logout

Remove saved credentials:

topk logout

Global flags

These flags are accepted by every command:

--output

Options:

• text (default)
• json

Output results as NDJSON — one JSON object per line, compatible with jq.

--api-key

API key to use for this invocation. Overrides the TOPK_API_KEY environment variable and the key saved via topk login.

Updating the CLI

To update CLI to the latest version, run:

brew update
brew upgrade topk