Installation¶

APX can be installed from pre-built binaries (GitHub Releases), Homebrew, or from source.

Beta Release

APX is currently in beta (v0.9.0-beta.2). The Homebrew formula and other package manager entries are not yet stable-released. We recommend installing from GitHub Releases or from source for the beta period.

GitHub Releases (Recommended for Beta)¶

Download the latest binary for your platform from the GitHub Releases page.

# macOS (Apple Silicon)
curl -L https://github.com/infobloxopen/apx/releases/latest/download/apx_Darwin_arm64.tar.gz | tar -xz
chmod +x apx && mv apx /usr/local/bin/

# macOS (Intel)
curl -L https://github.com/infobloxopen/apx/releases/latest/download/apx_Darwin_amd64.tar.gz | tar -xz
chmod +x apx && mv apx /usr/local/bin/

# Linux (x86_64)
curl -L https://github.com/infobloxopen/apx/releases/latest/download/apx_Linux_x86_64.tar.gz | tar -xz
chmod +x apx && sudo mv apx /usr/local/bin/

# Linux (ARM64)
curl -L https://github.com/infobloxopen/apx/releases/latest/download/apx_Linux_arm64.tar.gz | tar -xz
chmod +x apx && sudo mv apx /usr/local/bin/

Homebrew (macOS and Linux)¶

brew install --cask infobloxopen/tap/apx

This taps infobloxopen/homebrew-tap and installs the latest release, including shell completions for bash, zsh, and fish.

Build from Source¶

For development or latest features:

git clone https://github.com/infobloxopen/apx.git
cd apx
go build -o apx ./cmd/apx
chmod +x apx && mv apx /usr/local/bin/

Verify Installation¶

After installation, verify APX is working correctly:

apx --version

You should see output similar to:

apx 0.9.0-beta.2 (4b0e92a) 2026-03-09

Toolchain Management¶

APX bundles pinned generators and tools via apx.lock for reproducible builds:

# Download pinned toolchain (respects apx.lock)
apx fetch

Note

APX manages its own toolchain to ensure consistent results across environments. The first apx fetch will download necessary tools like buf, protoc, and language-specific generators.

Shell Completion¶

APX supports shell completion for bash, zsh, fish, and PowerShell.

Bash¶

# Add to ~/.bashrc
source <(apx completion bash)

# Or install system-wide
apx completion bash | sudo tee /etc/bash_completion.d/apx

Zsh¶

# Add to ~/.zshrc
source <(apx completion zsh)

# Or for oh-my-zsh
apx completion zsh > "${fpath[1]}/_apx"

Fish¶

apx completion fish | source

# Or install permanently
apx completion fish > ~/.config/fish/completions/apx.fish

PowerShell¶

apx completion powershell | Out-String | Invoke-Expression

# Or add to profile
apx completion powershell >> $PROFILE

Next Steps¶

Now that APX is installed, you can:

Try the Quick Start Guide
Walk through the full Tutorial
Explore the Initialization Guide for smart defaults and flags
Check out the CLI Reference

Troubleshooting¶

Command not found¶

If you get command not found: apx, ensure:

The binary is in your PATH
You have execute permissions: chmod +x apx
For Go install: $GOPATH/bin is in your PATH

Permission denied¶

If you get permission errors:

# Make executable
chmod +x apx

# Move to user directory instead of system
mv apx ~/bin/  # ensure ~/bin is in PATH

Go version issues¶

APX requires Go 1.26+. Check your version:

go version

Update Go if needed from golang.org.

Need help? Open an issue on GitHub or check existing discussions.