DEVELOPER RESOURCES
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.

Installation methods

You can use any of the following methods to install Pipeline CLI.

Homebrew

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

brew tap calyptia/tap
brew install calyptia

These commands always fetch the latest version of Pipeline CLI.

Curl

To install Pipeline CLI using curl, run the following command, which is the same for both Zsh and Bash:

curl -sSfl https://raw.githubusercontent.com/calyptia/cli/main/install.sh | bash

This command always fetches the latest version of Pipeline CLI.

Direct download

To install Pipeline CLI by downloading its files directly:

  1. Go to the Pipeline CLI release page (opens in a new tab).
  2. Locate the latest release artifact and download the .tar.gz archive that corresponds to your operating system and architecture.
  3. Extract the Pipeline CLI binary from the archive that you downloaded.
  4. Run the executable file to install Pipeline CLI.

Alternatively, you can download the Pipeline CLI source code from its release page and compile it yourself.

Set an API token

After you've installed Pipeline CLI, you must generate an API token to authenticate with Chronosphere, and then set that token in Pipeline CLI.

  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. Run the following command in Pipeline CLI:

    calyptia config set_token KEY

    Replace KEY with the value of the API key you generated 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.

View command list

To view a full list of available commands and flags, run:

calyptia help

You can also prepend calyptia help to a specific command to view more information about that command.

Pipeline CLIChronosphere API