Installation

The APKG CLI ships as a single native binary with no runtime dependencies. Choose the installation method that works best for your setup.

Build from source

Clone the repository and build with Cargo:

git clone https://github.com/apkg-ai/cli.git
cd cli
cargo build --release

The compiled binary will be at target/release/apkg. Move it to a directory in your PATH:

cp target/release/apkg /usr/local/bin/

Alternatively, run apkg add-to-path to automatically symlink the binary into ~/.apkg/bin and add it to your shell PATH.

This requires a working Rust toolchain (built and tested with Rust 1.94; older versions may work but are untested).

Additional install methods

Quick install

The fastest way to get started. This script auto-detects your platform and architecture, downloads the appropriate binary, and places it in your path:

curl -fsSL https://get.apkg.ai | sh

To customize the install location (default is /usr/local/bin or ~/.local/bin):

curl -fsSL https://get.apkg.ai | sh -s -- --install-dir ~/bin

Homebrew

Available for macOS and Linux:

brew install apkg

Cargo

Build from source using Rust’s package manager:

cargo install apkg

This requires a working Rust toolchain (built and tested with Rust 1.94; older versions may work but are untested).

Direct download

Pre-built binaries are available on GitHub Releases:

Platform	Architecture	Binary
macOS	Apple Silicon	apkg-darwin-arm64
macOS	Intel	apkg-darwin-x64
Linux	arm64	apkg-linux-arm64
Linux	x64	apkg-linux-x64
Windows	x64	apkg-windows-x64.exe

Download the binary for your platform, make it executable, and move it to a directory in your PATH:

chmod +x apkg-darwin-arm64
mv apkg-darwin-arm64 /usr/local/bin/apkg

Verify installation

Confirm that APKG is installed correctly:

apkg --version

Shell completions

Generate shell completions for your preferred shell:

# Bash
apkg completions bash > ~/.local/share/bash-completion/completions/apkg

# Zsh
apkg completions zsh > ~/.zfunc/_apkg

# Fish
apkg completions fish > ~/.config/fish/completions/apkg.fish