Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

The fastest way to get Zeph running is the install script. Alternative methods (crates.io, source, binaries, Docker) are listed below.

Run the one-liner to download and install the latest release:

curl -fsSL https://github.com/bug-ops/zeph/releases/latest/download/install.sh | sh

The script detects your OS and architecture, downloads the binary to ~/.zeph/bin/zeph, and adds it to your PATH. Override the install directory with ZEPH_INSTALL_DIR:

ZEPH_INSTALL_DIR=/usr/local/bin curl -fsSL https://github.com/bug-ops/zeph/releases/latest/download/install.sh | sh

Install a specific version:

curl -fsSL https://github.com/bug-ops/zeph/releases/latest/download/install.sh | sh -s -- --version v0.18.5

Verify it works:

zeph --version

Then run the configuration wizard:

zeph init

See Configuration Wizard for a step-by-step walkthrough of zeph init.

From crates.io

cargo install zeph

With optional features:

cargo install zeph --features tui,a2a

From Source

Requires Rust 1.94+ (Edition 2024).

git clone https://github.com/bug-ops/zeph
cd zeph
cargo build --release

The binary is produced at target/release/zeph. Run zeph init to generate a config file.

Build with optional features for TUI, IDE integration, or server deployment:

cargo build --release --features desktop          # TUI dashboard
cargo build --release --features ide              # ACP for IDE integration
cargo build --release --features server           # HTTP gateway + A2A + OpenTelemetry
cargo build --release --features full             # all optional features

See Feature Flags for the complete list of build options.

Pre-built Binaries

Download from GitHub Releases:

PlatformArchitectureDownload
Linuxx86_64zeph-x86_64-unknown-linux-gnu.tar.gz
Linuxaarch64zeph-aarch64-unknown-linux-gnu.tar.gz
macOSx86_64zeph-x86_64-apple-darwin.tar.gz
macOSaarch64zeph-aarch64-apple-darwin.tar.gz
Windowsx86_64zeph-x86_64-pc-windows-msvc.zip

Docker

Pull the latest image from GitHub Container Registry:

docker pull ghcr.io/bug-ops/zeph:latest

Or use a specific version:

docker pull ghcr.io/bug-ops/zeph:v0.18.5

Images are scanned with Trivy in CI/CD and use Oracle Linux 9 Slim base with 0 HIGH/CRITICAL CVEs. Multi-platform: linux/amd64, linux/arm64.

See Docker Deployment for full deployment options including GPU support and age vault.

Next Steps