Skip to content

Installation

The Trace CLI lets you create apps, manage links, and handle billing from your terminal.

Terminal window
brew install bmcreations/tap/trace

Download the latest release for your platform:

Terminal window
# macOS (Apple Silicon)
curl -fsSL https://github.com/bmcreations/homebrew-tap/releases/latest/download/trace_darwin_arm64.tar.gz | tar xz
sudo mv trace /usr/local/bin/
# macOS (Intel)
curl -fsSL https://github.com/bmcreations/homebrew-tap/releases/latest/download/trace_darwin_amd64.tar.gz | tar xz
sudo mv trace /usr/local/bin/
# Linux (x86_64)
curl -fsSL https://github.com/bmcreations/homebrew-tap/releases/latest/download/trace_linux_amd64.tar.gz | tar xz
sudo mv trace /usr/local/bin/
# Linux (ARM64)
curl -fsSL https://github.com/bmcreations/homebrew-tap/releases/latest/download/trace_linux_arm64.tar.gz | tar xz
sudo mv trace /usr/local/bin/

Download trace_windows_amd64.zip from the latest release, extract it, and add the directory to your PATH.

Terminal window
trace version

Log in with your Trace account via browser OAuth:

Terminal window
trace login

This opens your browser for GitHub or Google sign-in. Once authenticated, you can manage all your apps from the CLI.

Create your first app after logging in:

Terminal window
trace init

Or if you have an existing app created before user accounts, claim it:

Terminal window
trace apps claim --api-key tr_live_your_key_here

For CI/CD pipelines or scripts, you can still authenticate with an API key directly:

Terminal window
trace login --api-key tr_live_your_key_here
# EU region apps
trace login --api-key tr_live_your_key_here --region eu

Your credentials are stored locally at ~/.trace/config.json. The CLI automatically uses the correct API server based on your region.

The Trace CLI supports tab completions for Bash, Zsh, Fish, and PowerShell.

Terminal window
# Bash (add to ~/.bashrc)
source <(trace completion bash)
# Zsh (add to ~/.zshrc)
source <(trace completion zsh)
# Fish
trace completion fish | source
# PowerShell
trace completion powershell | Out-String | Invoke-Expression

After adding the line, restart your shell or run source ~/.bashrc (or ~/.zshrc).