TOOLS
Pipeline CLI
Install

Install Pipeline CLI

Pipeline CLI is compatible with Linux, macOS, and Windows for both arm64 and x86_64 architectures. Use one of the following methods to install Pipeline CLI:

MethodLinuxmacOSWindows
Homebrew
curl
Direct download

If you used the install-core.sh script to install a Core Operator on Linux, the script installed Pipeline CLI for you. You don't need to install it again.

Download and install Pipeline CLI

Select from the following methods to download and install the latest version of Pipeline CLI.

To install Pipeline CLI using Homebrew, run the following commands:

brew tap calyptia/tap
brew install calyptia

These commands fetch the latest version of Pipeline CLI.

Authentication

To use Pipeline CLI, you must generate an API token to authenticate with Telemetry Pipeline, and then set that token in Pipeline CLI.

API tokens are tied to specific projects within Telemetry Pipeline, and only one API token can be active in your Pipeline CLI session at time.

Generate an API token

Follow these steps to generate an API token in Telemetry Pipeline:

  1. Sign in to the Telemetry Pipeline web interface (opens in a new tab).
  2. In the navigation menu, select Settings.
  3. In the Generate API key section, enter a name for your new API key, and then click Generate.
  4. If you have multiple projects in Telemetry Pipeline, repeat these steps for each project.

Set an API token

Only one API token can be active in your Pipeline CLI session at a time, and each API token is tied to a specific project, which means that setting an API token also determines which project is active. If you have multiple Telemetry Pipeline projects, you can switch between them by repeating these steps as needed.

  1. Copy the value of the API token you generated for that project.

  2. Run the following command in Pipeline CLI:

    calyptia config set_token TOKEN

    Replace TOKEN with the value of the API token you copied in the previous step.

Update Pipeline CLI

To update Pipeline CLI, use any of the previous methods to run the Pipeline CLI installation process again. If you use the direct download method, be sure to download the release artifact for the latest version of Pipeline CLI.

Pipeline CLIChronosphere API