Catchpoint CLI Installation

  • 1 minute(s) read
Prev Next

Are you looking for help on Catchpoint Navigation? Click Here

Overview

The Catchpoint Command Line Interface (CLI) is a tool to interact with the Catchpoint API. You can use it to run instant tests, retrieve test results, and manage various Catchpoint resources. All logging is done via stderr to ensure that command output can be easily parsed or redirected.

Linux
To install the CLI, follow the steps below for your Linux distribution:

RHEL7 and Amazon Linux 2 Distros

  1. Add Catchpoint Repo:
curl https://repo.catchpoint.net/repo/rhel7/catchpoint.repo | sudo tee /etc/yum.repos.d/catchpoint_el7.repo
  1. Install Agent:
sudo dnf install catchpoint-cli -y

RHEL8, Oracle Linux 8 and Rocky Linux 8

  1. Add Catchpoint Repo:
curl https://repo.catchpoint.net/repo/rhel8/catchpoint_el8.repo | sudo tee /etc/yum.repos.d/catchpoint_el8.repo
  1. Install Agent:
sudo dnf install catchpoint-cli -y

RHEL 9

  1. Add Catchpoint Repo:
curl https://repo.catchpoint.net/repo/rhel9/catchpoint_el9.repo | sudo tee /etc/yum.repos.d/catchpoint_el9.repo
  1. Install Agent:
sudo dnf install catchpoint-cli -y

Ubuntu 22 and Ubuntu 24

  1. Get the repo list file from the Catchpoint repo and add it to the apt sources:
~# wget https://proddebrepo.catchpoint.net/repo/proddebrepo.list -O /etc/apt/sources.list.d/proddebrepo.list
  1. Get the public key for the Catchpoint repo and add it to the apt trusted store:
~# wget https://proddebrepo.catchpoint.net/repo/prod-key.asc -O /etc/apt/trusted.gpg.d/catchpoint_prod.asc
  1. Update the local apt and confirm it can access the Catchpoint repo:
~# apt-get update
  1. The Agent can be installed with the following command:
~# apt install -y catchpoint-cli

Docker

  1. Pull the latest image:
docker pull catchpoint/cli:stable
  1. Run the container with your API key:
docker run -e CATCHPOINT_API_TOKEN=*your token* --rm catchpoint/cli:stable

Options

      --api-token string              API token (or set the 'CATCHPOINT_API_TOKEN' environment variable)
      --config-file string            A configuration file to load commonly-used flags
  -h, --help                          help for catchpoint-cli
      --output-fields strings         Output fields to include in dot notation e.g. 'data.name,completed' (default [.])
      --output-format FormatterType   Output format [JSON, Table] (default Table)
  -v, --verbose count                 Enable verbose logging. Use -v for basic verbose, -vv for debug, -vvv for trace
      --version                       Print version and exit