Installation
The CLI requires
- Python 3.7 or greater
- The pip package manager
Install
Python and pip command names
python
and pip
must be available on your PATH. If alternative commands such as python3
are required, update the commands appropriately.
To install from Nexus, run pip install
with the appropriate credentials.
pip install --extra-index-url https://nexus.dl.kx.com/repository/kxi-pypi-public/simple/ kxicli
To install a specific version, run:
KXI_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==$KXI_CLI_VERSION
You can see available versions on Nexus.
Once installed, kxi
is available for you to execute.
If the installation fails, running pip
with the --verbose
option provides more information.
pip install --verbose --extra-index-url https://nexus.dl.kx.com/repository/kxi-pypi-public/simple/ kxicli==$KXI_CLI_VERSION
Upgrade
To upgrade the CLI, use the --upgrade
option with 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
Uninstall
To uninstall the CLI, run:
pip uninstall kxicli