Search

Developer Portal
Developer Portal
Installing the Kodexa CLI

Installing the Kodexa CLI

Kodexa command line tools provide an easy way to work with a Kodexa platform instance from the command line. The tools are built on top of the Python SDK and provide a simple way to interact with the platform.

Installation

The Kodexa command line tools are available on PyPi and can be installed with pip:

$ pip install kodexa-cli

Usage

The Kodexa command line tools are available as a single command called kodexa. You can see the available commands by running kodexa --help:

$ kodexa --help
Usage: kodexa [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --verbose  Enable verbose output.
  --help         Show this message and exit.

Commands:
  delete          Delete the given resource (based on ref)
  deploy          Deploy a component to a Kodexa platform instance from a...
  document
  export-project
  get             List the instance of the object type
  import-project
  login           Logs into the specified platform environment using the...
  logs            Get logs for an execution
  package         Package an extension pack based on the kodexa.yml file
  platform        Get the details for the Kodexa instance we are logged into
  project         Get all the details for a specific project
  query           Query the documents in a given document store
  send-event      Send an event to an assistant
  upload          Upload the contents of a file or directory to a Kodexa...
  version

Logging into Kodexa

The first thing you need to do is log into a Kodexa platform instance. You can do this by running the login command:

$ kodexa login

You will need to provide the URL of the Kodexa platform instance you want to log into. You can also provide the email and password for the Kodexa platform instance. Once you have successfully logged in you can see the details of the Kodexa platform instance you are logged into by running the platform command:

$ kodexa platform

Your personal API token will be stored in your home directory, based on your operating system it will be:

  • 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

This file is used to authenticate you to the Kodexa platform instance. You can also provide the API token as an environment variable called KODEXA_ACCESS_TOKEN.

Additional Notes on Kodexa CLI installation

When you install a package using pip, it will by default install the package into the site-packages directory of the currently active Python environment. If you haven't activated a virtual environment, it will install to the global Python environment's site-packages directory. To ensure that the package is installed in the default path of the global Python environment, you should:

  1. Make sure you are not in a virtual environment. You can deactivate a virtual environment with the command deactivate if you are using venv, or by simply closing and reopening your terminal.
  2. Check which Python and pip you are using with the following commands:
    3. which python3
which pip3

    These commands will show you the path of the Python and pip executables that will be used. If the output points to a directory inside a virtual environment (usually a path ending with env/bin/python), you are still inside a virtual environment and you need to exit it before proceeding. If the output points to a system path (like /usr/bin/python or /usr/local/bin/pip), then you are using the system-wide Python and pip and can proceed.

  3. Once you have confirmed that you are using system-wide Python and pip, you can install the package with:

    4. pip3 install kodexa-cli

  4. After the installation completes, you can verify its location by checking the package information with:

    5. pip3 show kodexa-cli

    (myenv) ➜  ~ pip3 show kodexa-cli
Name: kodexa-cli
Version: 7.0.7426713829
Summary: Command Line Tools for Kodexa
Home-page:
Author: Austin Redenbaugh
Author-email: austin@kodexa.com
License:
Location: /Users/bluestaffordshire/myenv/lib/python3.9/site-packages
Requires: click, jinja2, kodexa, PyYAML, rich, wrapt
Required-by:
  5. This command will display information about the installation, including the location of the installed package.

    6. Remember, installing packages system-wide may require administrative privileges. If you encounter permission issues, you might need to prepend sudo to the pip install command (though this practice is generally discouraged due to security concerns). A safer alternative is to use a virtual environment or a user installation with the --user flag:

    pip install --user kodexa-cli

    A user installation will place the package in a site-packages directory under your user directory, which doesn't require administrative privileges and is safer than installing packages globally.