Installation

OpsRampCLI can be installed via Python pip, or as a docker container.

Install via Python pip

OpsRampCLI requires python 3.12 or higher. It’s strongly recommended that you run it inside a python venv to ensure no conflicts with other python programs occur on your machine.

Create a python virtual environment and activate it:

mkdir opsrampcli
cd opsrampcli
python3 -m venv .venv
source .venv/bin/activate

Upgrade pip to ensure installation works correctly:

python -m pip install -U pip

Install the opsrampcli package:

pip install opsrampcli

If the install worked properly, you should be able to run the command (opcli) and view the usage help:

$ opcli -h

Install as a Docker container

To make the opcli command immediately available interactively:

docker run -it --entrypoint /bin/bash mfriedho/opsrampcli:latest

The next step is to set up the API credentials you’ll use to connect to OpsRamp.