Installation

Binary Download (Recommended)

Download the latest release for your platform from GitHub Releases.

Linux / macOS

OS=$(uname -s | tr '[:upper:]' '[:lower:]')
ARCH=$(uname -m)
case "$ARCH" in
  x86_64) ARCH=amd64 ;;
  aarch64|arm64) ARCH=arm64 ;;
  armv7l) ARCH=armv7 ;;
esac
curl -sL "https://github.com/Breee/outline-cli/releases/latest/download/outline_${OS}_${ARCH}.tar.gz" | sudo tar xz -C /usr/local/bin outline

Windows

Download outline_windows_amd64.zip from the releases page and add outline.exe to your PATH.

Go Install

go install github.com/Breee/outline-cli@latest

Container Image

Use the published image from GitHub Container Registry:

docker run --rm ghcr.io/breee/outline-cli:latest version

For reproducible environments, replace latest with a release tag such as vX.Y.Z.

Build from Source

git clone https://github.com/Breee/outline-cli.git
cd outline-cli
make build
# Binary at ./outline

Shell Completions

Source directly in your current session:

# Bash
source <(outline completion bash)

# Zsh
source <(outline completion zsh)

# Fish
outline completion fish | source

Or install persistently:

# Bash
outline completion bash > /etc/bash_completion.d/outline

# Zsh
outline completion zsh > "${fpath[1]}/_outline"

# Fish
outline completion fish > ~/.config/fish/completions/outline.fish

Verify Installation

outline --help

Quick Start