Installation Guide

Install ZeroClaw AI Agent Runtime

Single Rust binary, multiple install paths. Pick what works for you.

checklist System Requirements

build Rust

Rust toolchain (stable) via rustup.rs — only needed for source builds

computer OS

Linux (x86_64, aarch64, armv7), macOS (x86_64, aarch64), Windows (x86_64)

memory RAM

Runtime: <5MB RAM. Build from source: 2GB+ RAM, 4GB recommended

hard_drive Disk

Binary: ~8.8MB. Build from source: 6GB free disk, 10GB recommended

extension Optional

Optional: Docker (for sandboxed runtime), Git (for source builds)

wifi Network

Internet for AI API calls. Local models via Ollama work fully offline.

One-liner scripts that handle everything. Recommended for most users.

bolt

Remote One-Liner

macOS / Linux. Single command.

$ curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/main/scripts/bootstrap.sh | bash
rocket_launch

Local Bootstrap

Clone first, then bootstrap. More options.

$ git clone https://github.com/zeroclaw-labs/zeroclaw.git
$ cd zeroclaw && ./bootstrap.sh
$ # With system deps + Rust: ./bootstrap.sh --install-system-deps --install-rust
$ # With onboarding: ./bootstrap.sh --onboard --api-key "sk-..." --provider openrouter

verified Verify Your Installation

Run these commands to confirm ZeroClaw is installed correctly.

1
$ zeroclaw --version

Should print the installed version. Runs in ~0.02s with ~3.9MB peak memory.

2
$ zeroclaw doctor

Runs system diagnostics: Rust version, config files, provider connectivity, channel health.

3
$ zeroclaw onboard --interactive

Interactive setup wizard for API keys, provider selection, and channel configuration.

settings Initial Configuration

After installation, the onboard wizard guides you through setup. Here's what each step does.

1

Choose Your AI Provider

Select from the provider catalog: OpenAI, Anthropic, Google Gemini, xAI, Mistral, DeepSeek, OpenRouter (100+ models), or any OpenAI-compatible endpoint including Ollama for local models.

2

Add Your API Key

Paste your API key. Keys are stored locally in config.toml — never sent anywhere except the AI provider. Subscription auth (OpenAI Codex, Anthropic) also supported with encrypted profiles.

3

Connect a Channel

Link Telegram (paste bot token), Discord (paste bot token), Slack (workspace app), WhatsApp (QR code), or any of the 17+ supported channels. Deny-by-default allowlist policy.

4

Start the Agent

Run 'zeroclaw agent -m "Hello!"' for a quick test, 'zeroclaw daemon' for full autonomous runtime, or 'zeroclaw service install' for background service.

.env — All configuration is stored in ~/.zeroclaw/config.toml. Edit directly to change providers, channels, memory backends, tunnels, and security settings. See docs/reference/README.md for the full reference.

system_update_alt Upgrading ZeroClaw

Keep ZeroClaw up to date to get the latest features, integrations, and security patches.

Homebrew
$ brew upgrade zeroclaw
Cargo
$ cargo install zeroclaw --force
Git
$ cd zeroclaw && git pull && cargo build --release --locked
Docker
$ ./bootstrap.sh --docker --skip-build

Check the changelog at github.com/zeroclaw-labs/zeroclaw/releases for what's new in each version.

build Troubleshooting

Common issues and how to fix them.

Need Help?

Join our community for installation support and troubleshooting.

❯

Stay in the Loop

Get notified when we publish new community tutorials, deployment walkthroughs, and articles on this site. We do not send official ZeroClaw release announcements — for those, follow the official project. Unsubscribe anytime.