|
| 1 | +# TAGLINE |
| 2 | + |
| 3 | +Autonomous AI agent runtime built in Rust |
| 4 | + |
| 5 | +# TLDR |
| 6 | + |
| 7 | +**Initialize** configuration with interactive setup wizard |
| 8 | + |
| 9 | +```zeroclaw onboard --interactive``` |
| 10 | + |
| 11 | +**Start an interactive** CLI agent session |
| 12 | + |
| 13 | +```zeroclaw agent``` |
| 14 | + |
| 15 | +**Send a single message** without entering interactive mode |
| 16 | + |
| 17 | +```zeroclaw agent -m "[message]"``` |
| 18 | + |
| 19 | +**Start the full autonomous daemon** with channels and scheduler |
| 20 | + |
| 21 | +```zeroclaw daemon``` |
| 22 | + |
| 23 | +**Check system health** and run diagnostics |
| 24 | + |
| 25 | +```zeroclaw doctor``` |
| 26 | + |
| 27 | +**List all supported** LLM providers |
| 28 | + |
| 29 | +```zeroclaw providers``` |
| 30 | + |
| 31 | +# SYNOPSIS |
| 32 | + |
| 33 | +**zeroclaw** [_command_] [_subcommand_] [_options_] |
| 34 | + |
| 35 | +# PARAMETERS |
| 36 | + |
| 37 | +**onboard** |
| 38 | +> Initialize or reconfigure the workspace. Creates **~/.zeroclaw/config.toml** and scaffold files. |
| 39 | +
|
| 40 | +**onboard --interactive** |
| 41 | +> Run the full 9-step configuration wizard. |
| 42 | +
|
| 43 | +**onboard --api-key** _KEY_ **--provider** _PROVIDER_ [**--model** _MODEL_] |
| 44 | +> Non-interactive setup with API key and provider in one command. |
| 45 | +
|
| 46 | +**onboard --channels-only** |
| 47 | +> Repair or reconfigure channels and allowlists only. |
| 48 | +
|
| 49 | +**agent** [**-m** _MESSAGE_] |
| 50 | +> Run interactive CLI agent or send a single message with **-m**. |
| 51 | +
|
| 52 | +**agent --provider** _PROVIDER_ |
| 53 | +> Override the default provider for this session. |
| 54 | +
|
| 55 | +**gateway** [**--port** _PORT_] |
| 56 | +> Start the HTTP/WebSocket server for external integrations. Default port: 42617. |
| 57 | +
|
| 58 | +**daemon** |
| 59 | +> Start the full autonomous runtime with gateway, channels, heartbeat, and scheduler. |
| 60 | +
|
| 61 | +**status** |
| 62 | +> Display comprehensive system status including provider, memory, channels, and security. |
| 63 | +
|
| 64 | +**doctor** [**models** | **traces**] |
| 65 | +> Run system diagnostics. Optionally check model catalogs or inspect runtime traces. |
| 66 | +
|
| 67 | +**service install** | **start** | **stop** | **status** | **restart** |
| 68 | +> Manage zeroclaw as a background system service (systemd or OpenRC). |
| 69 | +
|
| 70 | +**channel list** | **doctor** | **start** |
| 71 | +> List, health-check, or start configured messaging channels. |
| 72 | +
|
| 73 | +**channel add** _TYPE_ _JSON_CONFIG_ |
| 74 | +> Add a new messaging channel configuration. |
| 75 | +
|
| 76 | +**channel bind-telegram** _USER_ID_ |
| 77 | +> Add a Telegram user to the allowlist. |
| 78 | +
|
| 79 | +**auth login** _PROVIDER_ [_PROFILE_] |
| 80 | +> Authenticate via OAuth or device code flow. |
| 81 | +
|
| 82 | +**auth status** | **logout** _PROFILE_ID_ |
| 83 | +> Show or remove authentication profiles. |
| 84 | +
|
| 85 | +**memory stats** | **list** | **search** _QUERY_ | **delete** _KEY_ | **prune** |
| 86 | +> Manage the built-in memory system. |
| 87 | +
|
| 88 | +**cron add** _NAME_ _SCHEDULE_ _MESSAGE_ [**--tz** _TIMEZONE_] |
| 89 | +> Schedule a recurring task with a cron expression. |
| 90 | +
|
| 91 | +**cron list** | **remove** _NAME_ |
| 92 | +> List or remove scheduled tasks. |
| 93 | +
|
| 94 | +**skills list** | **install** _NAME_ | **remove** _NAME_ |
| 95 | +> Manage agent skills and extensions. |
| 96 | +
|
| 97 | +**migrate openclaw** [**--dry-run**] |
| 98 | +> Import memory from an OpenClaw runtime. |
| 99 | +
|
| 100 | +**completions** _SHELL_ |
| 101 | +> Generate shell completions for bash, zsh, fish, powershell, or nushell. |
| 102 | +
|
| 103 | +**providers** |
| 104 | +> List all supported LLM providers and aliases. |
| 105 | +
|
| 106 | +**estop** [**--resume**] |
| 107 | +> Engage or resume from emergency stop. |
| 108 | +
|
| 109 | +# DESCRIPTION |
| 110 | + |
| 111 | +**zeroclaw** is a lightweight, security-first autonomous AI agent runtime built entirely in Rust. It serves as infrastructure for agentic workflows, abstracting models, tools, memory, and execution into a single binary that can be deployed across ARM, x86, and RISC-V architectures. |
| 112 | + |
| 113 | +The runtime compiles to an approximately 9MB binary with cold start under 10 milliseconds and less than 5MB RAM usage at idle. It uses a trait-driven architecture where providers, channels, memory backends, and tools are swappable through configuration without code changes. |
| 114 | + |
| 115 | +ZeroClaw includes a built-in hybrid search memory system combining vector embeddings with keyword search (SQLite-backed), requiring no external dependencies. It supports 28+ LLM providers including OpenRouter, Anthropic, OpenAI, Gemini, Ollama, and any OpenAI-compatible endpoint. Messaging integrations cover 70+ channels including Telegram, Discord, Slack, iMessage, Matrix, Signal, and WhatsApp. |
| 116 | + |
| 117 | +The agent supports multi-turn conversations with context preservation, tool execution (shell, file, git, browser), scheduled tasks via cron expressions, and hardware peripheral control for IoT devices. |
| 118 | + |
| 119 | +# CONFIGURATION |
| 120 | + |
| 121 | +Configuration is stored in **~/.zeroclaw/config.toml**. Run **zeroclaw onboard --interactive** for guided setup. |
| 122 | + |
| 123 | +``` |
| 124 | +[providers] |
| 125 | +default = "openrouter" |
| 126 | +
|
| 127 | +[providers.openrouter] |
| 128 | +api_key = "sk-or-v1-xxx" |
| 129 | +model = "anthropic/claude-opus-4-5" |
| 130 | +
|
| 131 | +[memory] |
| 132 | +backend = "sqlite" |
| 133 | +
|
| 134 | +[runtime] |
| 135 | +kind = "native" |
| 136 | +
|
| 137 | +[channels.telegram] |
| 138 | +bot_token = "123:ABC..." |
| 139 | +allowed_users = ["123456789"] |
| 140 | +``` |
| 141 | + |
| 142 | +Supported memory backends: **sqlite** (default, hybrid search), **postgres**, **markdown**, and **none** (stateless). |
| 143 | + |
| 144 | +Environment variables override config values: **ZEROCLAW_API_KEY**, **ZEROCLAW_PROVIDER**, **ZEROCLAW_MODEL**, **ZEROCLAW_WORKSPACE**. |
| 145 | + |
| 146 | +# CAVEATS |
| 147 | + |
| 148 | +ZeroClaw executes shell commands and file operations with your user permissions. The agent can modify files and run arbitrary commands when tool use is enabled. API keys are stored in **config.toml** and **auth-profiles.json** (encrypted at rest if secrets encryption is enabled). Channel integrations require the daemon to be running. Compilation from source requires at least 2GB RAM and 6GB disk space due to the Rust toolchain. |
| 149 | + |
| 150 | +# HISTORY |
| 151 | + |
| 152 | +ZeroClaw was created by **ZeroClaw Labs** and first released in **2025** as a Rust-based alternative to existing AI agent runtimes. It was designed around the principle of zero overhead and zero lock-in, targeting deployment on resource-constrained hardware while maintaining production-grade extensibility. The project introduced a trait-driven architecture allowing providers, channels, and tools to be swapped without code changes, and gained attention for achieving sub-10ms cold start times with a single-binary deployment model. |
| 153 | + |
| 154 | +# SEE ALSO |
| 155 | + |
| 156 | +[nanobot](/man/nanobot)(1), [picoclaw](/man/picoclaw)(1), [claude](/man/claude)(1), [openclaw](/man/openclaw)(1) |
0 commit comments