The Kodexa CLI is a Python-based tool that can be easily installed using pip. This page walks you through the installation process for different systems.

​
Prerequisites

  • Python 3.11 or higher
  • pip (Python package installer)

​
Standard Installation

Install the Kodexa CLI using pip:

pip install kodexa-cli

Verify the installation by checking the version:

kodexa version

​
Installation Options

​
User-specific Installation

If you don’t have administrator privileges, you can install the CLI for your user only:

pip install --user kodexa-cli

​
Virtual Environment Installation

For isolated environments, you can install within a virtual environment:

# Create a virtual environment
python -m venv kodexa-env

# Activate the environment (Linux/macOS)
source kodexa-env/bin/activate

# Activate the environment (Windows)
kodexa-env\Scripts\activate

# Install the CLI
pip install kodexa-cli

​
Installation Location

When installed, the package is placed in the site-packages directory of your Python environment:

pip show kodexa-cli

The above command will display the location and other information about the installed package.

​
Global Configuration

The Kodexa CLI stores configuration files in:

  • macOS: ~/Library/Application Support/kodexa-cli
  • Linux: ~/.local/share/kodexa-cli
  • Windows: C:\Documents and Settings\{User}\Application Data\Local Settings\kodexa\kodexa-cli or C:\Documents and Settings\{User}\Application Data\kodexa\kodexa-cli

​
Troubleshooting Installation

If you encounter any issues during installation:

  1. Ensure you have the latest version of pip: pip install --upgrade pip
  2. Check Python compatibility: python --version
  3. Look for error messages during installation and search for solutions
  4. Try installing with verbose output: pip install -v kodexa-cli