Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

KDX CLI workflows connecting profiles, API discovery, validation, and GitOps sync

​
What KDX Does

kdx is the command-line interface for the Kodexa Platform. It is used for four jobs:
  • Operate platform resources with get, describe, apply, delete, validate, and run.
  • Manage GitOps metadata with kdx sync pull, kdx sync push, and kdx sync deploy.
  • Inspect documents locally with kdx document against KDDB files.
  • Run focused operational commands for projects, stores, document families, knowledge item attachments, and organization secrets.
The CLI is intentionally API-aware. It discovers resource types and operations from the Kodexa OpenAPI specification for the environment you are connected to, then layers stable commands on top for common workflows.

​
Current Mental Model

Use kdx to manage the resources that make a Kodexa project work:
AreaCLI surfaceUse it for
Resource discoverykdx api-resourcesSee which resource types and schemes your platform exposes
Resource operationskdx get, kdx describe, kdx apply, kdx deleteRead and change individual platform resources
Dynamic operationskdx runCall resource-specific API operations discovered from OpenAPI
GitOps metadatakdx syncPull, review, push, and deploy version-controlled metadata
Activity projectskdx project, kdx store, kdx document-familyCreate projects, upload documents, watch processing, export results
Knowledgekdx knowledgeUpload and download knowledge item attachments
Secretskdx secretManage write-only organization secrets without echoing values
Local KDDB inspectionkdx documentInspect document text, nodes, tags, data objects, exceptions, and native files

​
Key Capabilities

Activity-Ready Metadata

Version Activity Plans, task templates, task statuses, data definitions, data forms, modules, Service Bridges, project templates, and project bindings.

Schema-Aware Apply

Validate YAML against the live API schema and use kdx apply -f as the standard create-or-update path.

OpenAPI Operation Access

Discover specialized API operations with kdx run <resource> and execute them with typed path, query, and body parameters.

Document Inspection

Work with KDDB files locally: text, selectors, nodes, data objects, exceptions, metadata, native files, and delta binaries.

Operational Workflows

Upload documents, watch document-family progress, export extracted data, attach knowledge assets, and manage secrets.

Deep Command Reference

See the current non-legacy command groups, arguments, flags, outputs, and recommended use cases.

​
Who Uses It

  • Solution developers use kdx to inspect resources, download KDDB files, test document output, and iterate on metadata.
  • Platform engineers use kdx sync to move Activity-centered configuration through development, staging, and production.
  • Project administrators use focused commands to create projects from templates, upload documents, watch processing, and export results.
  • Automation teams use JSON/YAML output, kdx run, and CI/CD sync reports to integrate Kodexa into scripts and deployment pipelines.

​
Important Conventions

  • Use current resource names in new metadata: data-definition, activity-plan, task-template, task-status, data-form, service-bridge, module, and project-template.
  • Use kdx apply -f for declarative create-or-update. There is no general kdx create command.
  • Use kdx project create only for the project-template workflow.
  • Use profiles for interactive CLI work and sync environments for GitOps deployments.
  • Treat kdx run as an escape hatch for resource-specific API operations that are not covered by stable top-level commands.

​
Start Here

Install

Install or update the CLI.

Quick Start

Authenticate, discover resources, and run the first useful commands.

Profiles & Configuration

Manage profiles, command overrides, and sync environment credentials.

Sync & GitOps

Put Kodexa metadata under version control.