​
Kodexa CLI Quick Start Guide

This guide will help you get started with the Kodexa command line tools, which provide an easy way to interact with a Kodexa platform instance.

​
Installation

Install the Kodexa CLI using pip:

pip install kodexa-cli

​
Installation Notes

  • Ensure you’re not in a virtual environment if you want a system-wide installation
  • Verify your Python and pip with which python3 and which pip3
  • For a user-specific installation (no admin rights needed), use: 
    pip install --user kodexa-cli

​
Authentication

​
Logging In

kodexa login

You’ll need to provide:

  • URL of the Kodexa platform instance
  • Your email and password

​
Verify Connection

Check your connection to the platform:

kodexa platform

​
API Token Storage

Your API token is stored 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

Alternatively, use the environment variable KODEXA_ACCESS_TOKEN

​
Common Commands

View all available commands:

kodexa --help

Frequently used commands:

  • kodexa get - List resources
  • kodexa deploy - Deploy components
  • kodexa upload - Upload files/directories
  • kodexa query - Query document stores
  • kodexa delete - Remove resources

​
Getting Help

Add the -v or --verbose flag to any command for detailed output:

kodexa [command] -v

For help with specific commands:

kodexa [command] --help