Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/openagen/zeroclaw/llms.txt

Use this file to discover all available pages before exploring further.

ZeroClaw ships as a single static binary with no mandatory runtime dependencies. Choose the installation method that fits your platform and constraints.

​
Prerequisites

Install build essentials and the Rust toolchain before building from source. Pre-built binaries do not require these steps.Debian / Ubuntu:
sudo apt install build-essential pkg-config
Fedora / RHEL:
sudo dnf group install development-tools && sudo dnf install pkg-config
Rust toolchain (all Linux distributions):
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Verify both tools are available:
rustc --version
cargo --version

​
Build resource requirements

Compiling from source requires significantly more resources than running the resulting binary:
ResourceMinimumRecommended
RAM + swap2 GB4 GB+
Free disk6 GB10 GB+
If your host is below the minimum, use a pre-built binary instead.

​
Installation methods

​
Homebrew

The simplest option on macOS or any machine with Linuxbrew installed: 
brew install zeroclaw

​
One-line bootstrap script

The bootstrap script installs system dependencies, the Rust toolchain (if missing), and ZeroClaw in a single step. It defaults to building from source but can download pre-built binaries when resources are constrained. 
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | bash
In security-sensitive environments, clone the repository first and inspect install.sh before executing it. The remote one-liner pipes directly to bash without a review step.
Common bootstrap flags: 
# Install system dependencies and Rust on a fresh machine
./install.sh --install-system-deps --install-rust

# Try pre-built binary first; fall back to source build if unavailable
./install.sh --prefer-prebuilt

# Binary-only install — fail if no compatible release asset exists
./install.sh --prebuilt-only

# Install and run onboarding in the same step
./install.sh --onboard --api-key "sk-..." --provider openrouter

# Run install + onboarding inside a Docker container
./install.sh --docker
See all available flags: 
./install.sh --help

​
Pre-built binaries

Release assets are published for the following targets:
  • Linux: x86_64, aarch64, armv7
  • macOS: x86_64, aarch64
  • Windows: x86_64
Download from the latest release. Example — ARM64 Linux: 
curl -fsSLO https://github.com/zeroclaw-labs/zeroclaw/releases/latest/download/zeroclaw-aarch64-unknown-linux-gnu.tar.gz
tar xzf zeroclaw-aarch64-unknown-linux-gnu.tar.gz
install -m 0755 zeroclaw "$HOME/.cargo/bin/zeroclaw"
After installing, ensure ~/.cargo/bin is on your PATH: 
export PATH="$HOME/.cargo/bin:$PATH"

​
Build from source

Clone the repository and build with Cargo: 
git clone https://github.com/zeroclaw-labs/zeroclaw.git
cd zeroclaw
cargo build --release --locked
cargo install --path . --force --locked
The default cargo build --release uses codegen-units=1 to reduce peak compile-time memory pressure. For faster builds on machines with ample RAM, use cargo build --profile release-fast instead.
Add ~/.cargo/bin to your PATH if it is not already present: 
export PATH="$HOME/.cargo/bin:$PATH"
Verify the installation: 
zeroclaw --version

​
Shell completions

ZeroClaw can generate completion scripts for bash, zsh, fish, PowerShell, and Elvish.
Source completions for the current session:
source <(zeroclaw completions bash)
To persist across sessions, add the line above to your ~/.bashrc.

​
Next steps

Quickstart

Onboard, send your first message, and start the daemon

Configuration

Configure providers, channels, memory, and autonomy settings

Build docs developers (and LLMs) love

Get started for freeTalk to us