The Kodexa CLI (Command Line Interface) provides a powerful way to interact with the Kodexa platform directly from your terminal. It enables you to manage components, work with documents, handle profiles, deploy resources, and perform many other operations without using the web interface.

This quick start guide will walk you through the essential capabilities of the Kodexa CLI, from installation to performing common operations. By the end, you’ll be able to efficiently interact with your Kodexa environment through the command line.

​
What Can You Do with the Kodexa CLI?

  • Configure and manage components in your Kodexa Platform installation
  • Upload, download, query, and manipulate documents
  • Manage connection profiles for different Kodexa platform instances
  • Package and deploy resources (extension packs, models, etc.) to the platform
  • Export and import projects between environments
  • Send events to assistants
  • Generate documentation for components

​
In This Guide