Skip to content

Installation

The application is primarily distributed with pip, but other installation methods are available.

Install Zabbix CLI

It is highly recommended to install the package with pipx to avoid conflicts with other Python packages on your system.

pip install pipx
pipx install git+https://github.com/unioslo/zabbix-cli.git@master

This will install zabbix-cli in an isolated environment and make it available on your system path.

Note

We are in the process of acquiring the unmaintained PyPI package name zabbixcli, which will allow us to publish this package on PyPI under the name zabbix-cli. Until then, the package is only available on GitHub.

Multiple installed versions

pipx supports installing multiple versions of the same package by giving each installation a custom suffix. For example, if we have an existing installation of Zabbix CLI, and we wish to install a newer version of Zabbix CLI without shadowing or overwriting the existing installation, we can do so:

pipx install zabbix-cli>=3.0.0 --suffix @v3

This installs Zabbix CLI >= 3.0.0 with the suffix @v3, and we can run it with:

zabbix-cli@v3

and the existing installation can be run as usual:

zabbix-cli

If you prefer to install the package with pip, you can do so with the following command:

pip install git+https://github.com/unioslo/zabbix-cli.git@master

This will install zabbix-cli in your user environment.

You can install zabbix-cli with Homebrew:

brew install zabbix-cli

Warning

The Homebrew package is not maintained by the author of zabbix-cli. It may be outdated or contain bugs. For the most up to date version, follow the installation instructions for pipx.

We build binaries with PyInstaller for each tagged release of Zabbix-cli. You can download the latest release from the GitHub releases page.

Depending on your platform, you might need to make the binary executable:

# Rename and move the binary to a location in your PATH
mv zabbix-cli-ubuntu-22.04-3.12 /usr/local/bin/zabbix-cli

# Make it executable
chmod +x /usr/local/bin/zabbix-cli

Upgrade Zabbix CLI

The upgrade process depends on the chosen installation method.

pipx upgrade zabbix-cli

pip install --upgrade zabbix-cli

brew upgrade zabbix-cli