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.

This guide takes you from a fresh machine to a working ZeroClaw agent in the shortest possible path. You will install the binary, run onboarding to create your config file, send a test message, and optionally start the long-running daemon.
1

Install ZeroClaw

The fastest install method depends on your platform. Pick the one that fits.Homebrew (macOS or Linuxbrew):
brew install zeroclaw
One-line installer (Linux/macOS):
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | bash
The script builds ZeroClaw from source using your existing Rust toolchain. On low-RAM or low-disk machines, add --prefer-prebuilt to download a pre-built binary instead:
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | bash -s -- --prefer-prebuilt
After installation, verify the binary is on your PATH:
zeroclaw --version
2

Run onboarding

Onboarding creates ~/.zeroclaw/config.toml with your API key, provider, and sensible defaults for memory, security, and autonomy.
zeroclaw onboard --api-key sk-... --provider openrouter
Replace sk-... with your API key. The --provider flag accepts any provider ID — run zeroclaw providers to see the full list. You can also specify a model explicitly:
zeroclaw onboard --api-key sk-... --provider openrouter --model "openrouter/auto"
If you prefer to walk through each option manually, use the interactive wizard:
zeroclaw onboard --interactive
Run zeroclaw doctor after onboarding to verify that your configuration is valid and all required dependencies are reachable.
3

Send your first message

With onboarding complete, send a single-shot message to confirm the agent is working:
zeroclaw agent -m "Hello, ZeroClaw!"
The agent will call your configured provider, apply memory and tool routing, and print the response inline. To enter a persistent interactive session instead:
zeroclaw agent
Type your messages at the prompt and press Enter. Use Ctrl+C or exit to quit.
4

Start the autonomous daemon

The daemon keeps ZeroClaw running continuously so it can process scheduled tasks, respond to channel messages (Telegram, Discord, Slack, etc.), and execute heartbeat workflows.
zeroclaw daemon
Check that the daemon and all configured channels are healthy:
zeroclaw status
zeroclaw doctor
To run ZeroClaw as a persistent background service managed by systemd (Linux) or OpenRC (Alpine), see service management.

​
Verify your setup

Use zeroclaw doctor to run a full diagnostic that checks daemon freshness, scheduler health, and channel connectivity: 
zeroclaw doctor
Use zeroclaw status for a quick snapshot of the current system state: 
zeroclaw status

​
Next steps

Installation options

Pre-built binaries, build from source, shell completions, and prerequisites

Configuration

Set providers, channels, memory backends, and autonomy levels

Channels

Connect Telegram, Discord, Slack, WhatsApp, and more

CLI reference

Every command and flag, with examples

Build docs developers (and LLMs) love

Get started for freeTalk to us