Skip to content

Command Line Interface

kodexa

Usage:

kodexa [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--verbose, -v integer range (0 and above) Enable verbose output. 0
--help boolean Show this message and exit. False

Subcommands

  • delete:
  • deploy:
  • export-project:
  • get:
  • import-project:
  • login: Logs into the specified platform environment using the email address and password provided,
  • logs:
  • mkdocs:
  • package:
  • platform:
  • project:
  • query:
  • send-event:
  • upload:
  • version:

delete

Delete the given resource (based on ref)

object_type is the type of object to delete (e.g. 'project', 'assistant', 'store') ref is the ref of the object to delete

Usage:

kodexa delete [OPTIONS] OBJECT_TYPE REF

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--help boolean Show this message and exit. False

deploy

Deploy a component to a Kodexa platform instance from a file or stdin

Usage:

kodexa deploy [OPTIONS]

Options:

Name Type Description Default
--org text The slug for the organization to deploy to None
--slug text Override the slug for component (only works for a single component) None
--version text Override the version for component (only works for a single component) None
--file text The path to the file containing the object to apply None
--update / --no-update boolean The path to the file containing the object to apply False
--url text The URL to the Kodexa server None
--token text Access token None
--format text The format to input if from stdin (json, yaml) None
--overlay text A JSON or YAML file that will overlay the metadata None
--help boolean Show this message and exit. False

export-project

Export a project, and associated resources to a local zip file

project_id is the id of the project to export

Usage:

kodexa export-project [OPTIONS] PROJECT_ID

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--output text The path to export to None
--help boolean Show this message and exit. False

get

List the instances of the component or entity type

object_type is the type of object to list (component, document, execution, etc.) ref is the reference to the object

Usage:

kodexa get [OPTIONS] OBJECT_TYPE [REF]

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--query text Limit the results using a query *
--path text JQ path to content you want None
--format text The format to output (json, yaml) None
--page integer Page number 1
--pageSize integer Page size 10
--sort text Sort by (ie. startDate:desc) None
--help boolean Show this message and exit. False

import-project

Import a project, and associated resources from a local zip file

org_slug is the slug of the organization to import into path is the path to the zip file

Usage:

kodexa import-project [OPTIONS] ORG_SLUG PATH

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--help boolean Show this message and exit. False

login

Logs into the specified platform environment using the email address and password provided, then downloads and stores the personal access token (PAT) of the user.

Once successfully logged in, calls to remote actions, pipelines, and workflows will be made to the platform that was set via this login function and will use the stored PAT for authentication.

Usage:

kodexa login [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

logs

Get the logs for a specific execution

execution_id is the id of the execution to get the logs for

Usage:

kodexa logs [OPTIONS] EXECUTION_ID

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--help boolean Show this message and exit. False

mkdocs

Generate mkdocs documentation for components

file_pattern is the pattern to use to find the kodexa.yml files (default is **/kodexa.yml)

Usage:

kodexa mkdocs [OPTIONS] [FILES]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

package

Package an extension pack based on the kodexa.yml file

Usage:

kodexa package [OPTIONS]

Options:

Name Type Description Default
--path text Path to folder container kodexa.yml (defaults to current) /home/runner/work/docs.kodexa.com/docs.kodexa.com
--output text Path to the output folder (defaults to dist under current) /home/runner/work/docs.kodexa.com/docs.kodexa.com/dist
--version text Version number (defaults to 1.0.0) None
--help boolean Show this message and exit. False

platform

Get the details for the Kodexa instance we are logged into

Usage:

kodexa platform [OPTIONS]

Options:

Name Type Description Default
--python / --no-python boolean Print out the header for a Python file False
--help boolean Show this message and exit. False

project

Get details for a specific project.

project_id is the ID of the project to get details for.

Usage:

kodexa project [OPTIONS] PROJECT_ID

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--help boolean Show this message and exit. False

query

Query the documents in a given document store

ref is the reference to the document store query is the query to run

Usage:

kodexa query [OPTIONS] REF [QUERY]

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--download / --no-download boolean Download the KDDB for the latest in the family False
--download-native / --no-download-native boolean Download the native file for the family False
--page integer Page number 1
--pageSize integer Page size 10
--sort text Sort by ie. name:asc None
--help boolean Show this message and exit. False

send-event

Send an event to an assistant

project_id is the id of the project to send the event to assistant_id is the id of the assistant to send the event to

Usage:

kodexa send-event [OPTIONS] PROJECT_ID ASSISTANT_ID

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--file text The path to the file containing the event to send None
--format text The format to use if from stdin (json, yaml) None
--help boolean Show this message and exit. False

upload

Upload a file to the Kodexa platform.

ref is the reference to the document store to upload to. path is the path to the file to upload.

Usage:

kodexa upload [OPTIONS] REF PATH

Options:

Name Type Description Default
--url text The URL to the Kodexa server None
--token text Access token None
--help boolean Show this message and exit. False

version

Get the version of the CLI

Usage:

kodexa version [OPTIONS]

Options:

Name Type Description Default
--help boolean Show this message and exit. False