Skip to content

Installation

kmp-cli is compiled as a high-performance native binary using Kotlin/Native, meaning it starts instantaneously without JVM warmup overhead.


Package Managers

Install using our official tap:

brew tap jesusdmedinac/tap
brew install kmp
To upgrade:
brew update && brew upgrade kmp

If you use SDKMAN! to manage Java and Kotlin SDKs:

sdk install kmp

To automatically detect your CPU architecture (Apple Silicon / Intel / Linux x64) and install kmp into ~/.local/bin:

curl -fsSL https://raw.githubusercontent.com/jesusdmedinac/KMP-CLI/main/install.sh | bash

Add kmp-cli to your GitHub Actions pipeline for automated environment validation, dependency catalog audits, and migration checks:

- name: Install KMP CLI
  run: curl -fsSL https://raw.githubusercontent.com/jesusdmedinac/KMP-CLI/main/install.sh | bash

- name: Verify KMP Toolchain & Runtimes
  run: ~/.local/bin/kmp doctor --json

- name: Audit Dependency Version Catalog
  run: ~/.local/bin/kmp analyze dependencies --json


Prebuilt Binaries (GitHub Releases)

Download precompiled standalone executables directly from the Releases page:

Platform Architecture Binary Asset
macOS Apple Silicon (arm64) kmp-macos-arm64.tar.gz
macOS Intel (x86_64) kmp-macos-x64.tar.gz
Linux AMD64 (x86_64) kmp-linux-x64.tar.gz
Windows x86_64 (mingwX64) kmp-windows-x64.zip

Extract and place the executable in your system $PATH (e.g. /usr/local/bin or ~/.local/bin).


Building from Source

To compile kmp-cli directly from source:

  1. Clone the repository:
    git clone https://github.com/jesusdmedinac/KMP-CLI.git
    cd KMP-CLI
    
  2. Build the native release executable:
    ./gradlew :kmp-cli:linkReleaseExecutableNative
    
  3. The binary will be produced at:
    kmp-cli/build/bin/<target>/releaseExecutable/kmp.kexe
    
    Add a symlink to your $PATH:
    ln -s "$(pwd)/kmp-cli/build/bin/macosArm64/releaseExecutable/kmp.kexe" ~/.local/bin/kmp
    

Verify Installation

Confirm that kmp is properly installed and accessible:

kmp --version
Output:
kmp version 1.0.0