1. Installation

1.1. Install Python

Download and install a supported version of python for your platform.

If installing on Windows, make sure you check the option to add Python to the PATH. This will ensure that not only the python and pip binaries are on the path, but that the axonshell CLI script that comes with this package will be available on the PATH after you install it.

1.2. Install the package using pip

axonius-api-client is listed on pypi, so you can do pip install from any platform that has python installed.

$ pip install axonius_api_client

1.3. Offline installs using pip

If you need to install axonius-api-client to a system that doesn’t have access to the internet, there are a few hoops to jump through.


You will need to install the exact same version of python on both systems.

If the destination system is linux, the source system should be the exact same linux distribution, version, and build.


On Windows, each system should have should the PATH variable updated to include the Python directories:

  • C:\Program Files\Python38

  • C:\Program Files\Python38\Scripts

On the source system that does have internet access, use the following command to download all of the requirements as wheel packages:

$ pip download -d d:\axonshell_pkg axonius-api-client --only-binary

Copy the contents of d:axonshell_pkg to the destination server, and then on the destination server run:

$ pip install --no-index --find-links d:\axonshell_pkg --target d:\axonshell axonius-api-client

1.4. Install the package Using pipenv

pipenv makes it easy to create virtual environments for python projects.

$ pipenv install axonius_api_client

1.5. Download the entire repository using git

This is really only for those who wish to contribute to this project, although you can install the package after cloning the repository using python setup.py install.

$ git clone git://github.com/Axonius/axonius_api_client.git

1.6. Browse the repository on GitHub

The master branch will always be the most recent stable version.