Early Access - Coming 2026The KDX CLI is currently in early access and under active development. Features, commands, and configuration may change before general availability. We welcome your feedback as we refine this tool.
What is KDX CLI?
kdx is a modern, kubectl-style command-line interface for the Kodexa AI Platform. It provides a powerful and familiar interface for developers, DevOps engineers, and platform administrators to manage Kodexa resources directly from the terminal.
Unlike traditional CLIs, kdx dynamically discovers available resources and operations from your platform’s OpenAPI specification, ensuring it always stays in sync with your Kodexa environment.
Key Capabilities
Dynamic Resource Discovery
Automatically discovers resources from your platform’s OpenAPI spec with on-demand cache refresh
Profile Management
Profile-aware authentication stored in
~/.kodexa/config.yaml with seamless profile switchingSchema Validation
Schema-aware validation for create, apply, and plugin commands to catch errors early
GitOps Sync
Metadata synchronization with offline validation for feature types and instances
Multiple Output Modes
Interactive tview table, JSON, and YAML outputs for any workflow
Extensible Plugins
Plugin architecture for resource-specific workflows like workspace exec and store reindex
Who Should Use KDX CLI?
The KDX CLI is designed for:- Developers building applications on the Kodexa platform who need quick resource access
- DevOps Engineers managing multi-environment deployments with GitOps workflows
- Platform Administrators performing operational tasks like reindexing stores or checking workspace status
- Automation Engineers scripting Kodexa operations in CI/CD pipelines
Why KDX CLI?
Kubectl-Style Interface
If you’re familiar withkubectl, you’ll feel right at home. The CLI follows established patterns with commands like get, describe, create, apply, and delete.
Stay in Sync
Becausekdx reads your platform’s OpenAPI specification, it automatically adapts to new resource types and operations as your platform evolves.
Catch Errors Early
Request validation happens before API calls, providing immediate feedback on malformed YAML or missing required fields.GitOps Ready
Built-in metadata sync commands enable version-controlled infrastructure and promote-to-production workflows across environments.What’s Next?
Installation
Install KDX CLI on your platform
Quick Start
Get started with your first commands
Configuration
Set up profiles and manage credentials
Resource Operations
Learn core CRUD operations
Roadmap & Feedback
The KDX CLI is evolving rapidly. We’re working toward general availability in 2026 with:- Additional plugin support for more resource types
- Enhanced interactive UI features
- Expanded GitOps capabilities
- Improved error messages and validation
