Skip to content

Installation

This guide walks you through the installation of the exls CLI, the main command-line interface for interacting with the exalsius platform.

Prerequisites

Before installing the CLI, ensure the following requirements are met:

Python Version

The exalsius CLI requires Python 3.12 or newer.

Virtual Environment Recommended

It's best practice to install the CLI in a dedicated virtual environment to avoid dependency conflicts. For example: 

python -m venv .venv
source .venv/bin/activate

Installation

You can install the CLI using either pip or uv (a modern, faster Python package installer).

pip install git+https://github.com/exalsius/exalsius-cli.git@main

uv pip install git+https://github.com/exalsius/exalsius-cli.git@main

Verification

Once the installation is complete, verify that the CLI is installed correctly:

exls --help

You should see the command's usage information, which confirms a successful installation.

exls CLI help output

Troubleshooting exls not found

If the exls command isn't found, ensure that your Python bin or Scripts directory is included in your system's PATH.

Updating the CLI

To update the CLI to the latest version, you can reinstall it from the main branch.

pip install --upgrade --force-reinstall git+https://github.com/exalsius/exalsius-cli.git@main

uv pip install --upgrade --force-reinstall git+https://github.com/exalsius/exalsius-cli.git@main

Troubleshooting

If you encounter any issues:

  • Ensure your Python environment uses Python 3.12+.
  • Verify that pip is up to date: pip install --upgrade pip.
  • If you've installed exls in multiple virtual environments, make sure you're using the correct one.
  • If problems persist, please open an issue on the exalsius CLI GitHub repository or join our Discord to get in touch with us.

Next Steps

Now that the CLI is installed, you are ready to get started.

Continue to the User Guide to learn about the concepts of exalsius.