Skip to main content
The Kodexa CLI provides tools for packaging resources and deploying them to the platform. This page explains how to package and deploy components.

​
Packaging Resources

The package command allows you to package resources (extension packs, models, etc.) for deployment: 
kodexa package [--path PATH] [--output OUTPUT] [--version VERSION] [options] [FILES]
By default, this looks for a kodexa.yml file in the current directory.

​
Packaging an Extension Pack

To package an extension pack: 
kodexa package --path /path/to/extension --output /path/to/output --version 1.0.0

​
Packaging with Helm Charts

For Kubernetes deployment, add the --helm flag: 
kodexa package --path /path/to/extension --output /path/to/output --version 1.0.0 --helm

​
Package Options

  • --path: Path to folder containing kodexa.yml (defaults to current directory)
  • --output: Path to the output folder (defaults to dist under current)
  • --version: Version number for the package
  • --package-name: Name of the package (for models)
  • --helm: Generate a Helm chart
  • --repository: Repository to use (defaults to kodexa)

​
Deploying Components

The deploy command allows you to deploy components to a Kodexa platform instance: 
kodexa deploy [--org ORG] [--update] [--version VERSION] [FILES]

​
Deploying a Packaged Component

To deploy a packaged component: 
kodexa deploy /path/to/component.json

​
Updating Existing Components

To update an existing component: 
kodexa deploy /path/to/component.json --update

​
Deploying to a Specific Organization

To deploy to a specific organization: 
kodexa deploy /path/to/component.json --org organization-slug

​
Deployment Options

  • --org: Organization slug to deploy to
  • --update: Update existing components
  • --version: Override version for component
  • --overlay: JSON/YAML file to overlay metadata
  • --slug: Override slug for component

​
Examples

​
Package an extension pack

kodexa package --path /path/to/extension --version 1.0.0

​
Package a model with Helm

kodexa package --path /path/to/model --version 1.0.0 --helm --package-name my-model

​
Deploy a component

kodexa deploy /path/to/component.json

​
Deploy multiple components

kodexa deploy /path/to/component1.json /path/to/component2.json

​
Update an existing component

kodexa deploy /path/to/component.json --update

​
Deploy with version override

kodexa deploy /path/to/component.json --version 2.0.0

​
Deploy to a specific organization

kodexa deploy /path/to/component.json --org my-organization