Skip to main content

Install and Configure Harness CLI

Welcome to the Harness CLI Documentation!

Harness CLI serves as your gateway to frictionless interaction with the intelligent Harness Platform directly through the command-line interface, providing you with a powerful and efficient means to manage Harness and its diverse set of resources.

This documentation section will serve as your compass, guiding you through the installation, configuration, and upgrade of the Harness CLI utility.

Installing Harness CLI

You can install harness CLI utility on Linux, MacOS, or Windows in order to interact with Harness Platform from a command-line interface.

Installing the CLI on Linux

  1. Download and extract the Harness CLI binary.
curl -LO https://github.com/harness/harness-cli/releases/download/v0.0.13-alpha/harness-v0.0.13-alpha-linux-arm64.tar.gz
tar -xvf harness-v0.0.13-alpha-darwin-amd64.tar.gz
  1. Add the binary path to the system $PATH variable
echo 'export PATH="$(pwd):$PATH"' >> ~/.bash_profile
source ~/.bash_profile
  1. After you install the CLI, it is available using the harness command. To verify run:
harness --version

Configuring Harness CLI

  1. Obtain Harness API Token. You can follow the steps outlined in the Harness documentation's guide on how to create a personal API token.

  2. Retrieve your Account ID by navigating within the Harness UI to ACCOUNT SETTINGS > Overview > Account Id.

  3. Login to Harness from CLI.

    harness login --api-key HARNESS_API_TOKEN --account-id HARNESS_ACCOUNT_ID

    Note: Replace HARNESS_API_TOKEN with the Harness API Token obtained in the previous step, and HARNESS_ACCOUNT_ID with your specific Account Id.

  1. Upon successful login, you will be greeted with the confirmation message Login successfully done. Yay!.

Harness Login