Skip to content

Overview

The CLI provides features to perform operations such as (but not limited to):

  • Installation setup
  • Enrolling/removing clients
  • Querying data
  • Creating and deleting assemblies

The CLI makes use of the Python Kubernetes client to allow it to run easily outside and inside of a Kubernetes cluster.

Requirements

The CLI requires

  • Python 3.6 or greater
  • Python pip package manager

Install

Note

It is assumed python and pip commands are available as is and on the path. If alternative commands such as python3 are required, update the commands appropriately

To install from Nexus, execute pip install with the appropriate credentials.

pip install --extra-index-url https://https://nexus.dl.kx.com/repository/kxi-pypi-public/simple/ kxicli

To install a specific version, use

cli_version=x.y.z # replace with the version you want to install
pip install --extra-index-url https://nexus.dl.kx.com/repository/kxi-pypi-public/simple/ kxicli==$cli_version

Available versions can be viewed on Nexus

Once installed, kxi will now be available for you to execute.

kxi --version
kxi, version 0.9.0 from /home/kx-user/.local/lib/python3.8/site-packages/kxicli (Python 3.8)

For a full reference guide to the CLI see here

Upgrade

To upgrade the CLI, use the --upgrade option for pip install

# pass the '--upgrade' flag to pip
pip install --upgrade --extra-index-url https://nexus.dl.kx.com/repository/kxi-pypi-public/simple/ kxicli