Installation Options
KDX CLI is distributed through multiple package managers and as direct binary downloads for maximum flexibility.Homebrew (macOS/Linux) - Recommended
The easiest way to install and keep KDX CLI up to date on macOS and Linux.Updating via Homebrew
Pre-release Builds (Homebrew)
To try the latest development build before it’s officially released, installkdx-dev. It installs as a separate binary so it can coexist with the stable kdx:
Scoop (Windows)
For Windows users, Scoop provides a simple package management experience.Updating via Scoop
Pre-release Builds (Scoop)
To try the latest development build on Windows, installkdx-dev. It installs as a separate binary so it can coexist with the stable kdx:
Docker
Run KDX CLI in a container without installing binaries on your system.When using Docker, mount
~/.kodexa to persist your profile configuration across container runs.Linux Packages
Debian/Ubuntu (.deb)
Red Hat/Fedora (.rpm)
Direct Binary Download
Download pre-built binaries from the GitHub releases page, or use the commands below to automatically fetch the latest version.Linux AMD64
macOS AMD64 (Intel)
macOS ARM64 (M1/M2/M3)
Windows (PowerShell)
Go Install (Development)
For Go developers who want the latest development version:Build from Source (Advanced)
Clone and build from source for custom modifications or contributions.Verifying Your Installation
After installation, verify that KDX CLI is working correctly:Shell Completion (Optional)
Enable shell completions for a better command-line experience:Bash
Zsh
Fish
PowerShell
Upgrading KDX CLI
Package Manager Upgrades
If you installed via Homebrew or Scoop, use their update commands:Manual Upgrades
For binary installations, download the latest version and replace the existing binary:Troubleshooting
Command Not Found
Ifkdx is not found after installation:
Permission Denied
On Unix-like systems, ensure the binary is executable:Version Mismatch
Clear the OpenAPI cache if you’re experiencing issues after upgrading:Next Steps
Quick Start
Configure your first profile and start using KDX CLI
Configuration
Learn about profiles and credential management
