ZeroClaw

https://github.com/zeroclaw-labs/zeroclaw
Admin
ZeroClaw is a lightweight, fully autonomous AI assistant infrastructure runtime written in Rust that...
Tokens:1,470,383
Snippets:9,362
Trust Score:7.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run Quickstart via CLI

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/getting-started/quickstart.md

Starts the interactive quickstart setup in the terminal. You answer one prompt per step. The built-in 'cli' channel works immediately, so Channels and Peer groups can be skipped.

```sh
zeroclaw quickstart
```

--------------------------------

### Install and Run ZeroClaw (Termux)

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/hardware/android-setup.md

Makes the binary executable, moves it to the PATH, verifies the installation, and runs the quickstart setup.

```sh
chmod +x zeroclaw
mv zeroclaw $PREFIX/bin/

# Verify installation
zeroclaw --version

# Run setup
zeroclaw quickstart
```

--------------------------------

### Unix guided path: clone and run install.sh

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/_snippets/install.md

Guided install that may offer prebuilt or source installation. On supported targets, offers prebuilt or source; source selects zerocode by default and allows app selection and optional Cargo features. Can bootstrap Rust if missing. Updates shell profile when allowed; reload parent shell. For unconfigured installs, offers 'zeroclaw quickstart' or browser-based Quickstart.

```sh
git clone https://github.com/zeroclaw-labs/zeroclaw.git
cd zeroclaw
./install.sh
```

--------------------------------

### Install zeroclaw on Unix with curl and run quickstart

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/README.md

Installs the current release on Unix via the official install script, then runs the quickstart command. The binary is placed under ${CARGO_HOME:-$HOME/.cargo}/bin. Run ./install.sh --help for the complete Unix installer flag reference.

```sh
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | sh
"${CARGO_HOME:-$HOME/.cargo}/bin/zeroclaw" quickstart
```

--------------------------------

### First-time setup commands

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/tests/manual/telegram/testing-telegram.md

First-time setup steps: run automated tests, configure the bot token and allowed users, verify health, start the channel, and send a test message.

```bash
# 1. Run automated tests
./tests/telegram/test_telegram_integration.sh

# 2. Configure Telegram
zeroclaw config set channels.telegram.default.bot-token <token>      # from @BotFather
zeroclaw config set channels.telegram.default.allowed-users '["<your-id>"]'

# 3. Verify health
zeroclaw channel doctor

# 4. Start channel
zeroclaw channel start

# 5. Send test message in Telegram
```

--------------------------------

### CMD: Install via Scoop

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/windows.md

Adds the zeroclaw Scoop bucket, installs the package, and runs quickstart.

```cmd
scoop bucket add zeroclaw https://github.com/zeroclaw-labs/scoop-zeroclaw
scoop install zeroclaw
zeroclaw quickstart
```

--------------------------------

### Install ZeroClaw service and start it

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/linux.md

Install, start, and check the status of the ZeroClaw systemd service. Logs go to the systemd journal by default.

```sh
zeroclaw service install
zeroclaw service start
zeroclaw service status
```

--------------------------------

### Reset config and run quickstart

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/ops/troubleshooting.md

Deletes the existing zeroclaw config directory and runs quickstart to create a fresh install. Use when you want to start over completely.

```sh
rm -rf ~/.zeroclaw
zeroclaw quickstart
```

--------------------------------

### Quick Start: Full Setup Commands

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/firmware/esp32/SETUP.md

Copy-paste sequence to install Python 3.12, virtualenv, Rust tools, build, and flash the ESP32 firmware. Requires macOS with Homebrew and an ESP32 connected via USB.

```sh
# 1. Install Python 3.12 (ESP-IDF needs 3.10–3.13, not 3.14)
brew install python@3.12

# 2. Install virtualenv (PEP 668 workaround on macOS)
/opt/homebrew/opt/python@3.12/bin/python3.12 -m pip install virtualenv --break-system-packages

# 3. Install Rust tools
cargo install espflash ldproxy

# 4. Build
cd firmware/esp32
export PATH="/opt/homebrew/opt/python@3.12/libexec/bin:$PATH"
cargo build --release

# 5. Flash (connect ESP32 via USB)
espflash flash target/riscv32imc-esp-espidf/release/esp32 --monitor
```

--------------------------------

### CMD: Build and install from source

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/windows.md

Clones the repository, builds with Cargo, and runs quickstart. Requires Rust (rustup) and Visual Studio Build Tools.

```cmd
git clone https://github.com/zeroclaw-labs/zeroclaw
cd zeroclaw
cargo install --locked --path .
zeroclaw quickstart
```

--------------------------------

### Provision jail with helper script

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/dist/freebsd/README.md

Runs the jail setup helper on the host as root. It creates the jail, extracts a base, adds the jail.conf entry, starts the jail, and installs the launcher and hardened rc.d script inside it. Override defaults via environment variables.

```sh
doas sh zeroclaw-jail-setup.sh
# override defaults via env, e.g.:
#   JAIL_NAME=zc ZPOOL=tank ZEROCLAW_USER=agent doas sh zeroclaw-jail-setup.sh
```

--------------------------------

### Set up Claude subscription token and quickstart

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/getting-started/quickstart.md

Generates a setup token with 'claude setup-token' and runs quickstart with Anthropic provider. Choose 'Anthropic', set 'Authentication' to 'setup_token', and paste the token into the API key/token prompt. Scripted input may use '--model-provider claude' as an alias.

```sh
claude setup-token
zeroclaw quickstart --model-provider anthropic --model claude-sonnet-4-5 --agent assistant
```

--------------------------------

### PowerShell: Download and install prebuilt binary

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/windows.md

Downloads the latest Windows release zip, extracts zeroclaw.exe to %USERPROFILE%\.zeroclaw\bin, adds it to the user PATH, and runs quickstart. Idempotent: skips download and PATH setup if already at latest release.

```powershell
# Installation and PATH setup are idempotent. If zeroclaw is already at the
# latest release and on the user PATH, those steps are skipped; Quickstart
# still runs at the end.
$ver = (Invoke-RestMethod 'https://api.github.com/repos/zeroclaw-labs/zeroclaw/releases/latest').tag_name.TrimStart('v')
$dst = "$env:USERPROFILE\.zeroclaw\bin"
$exe = "$dst\zeroclaw.exe"

$current = if (Test-Path $exe) {
    ((& $exe --version 2>$null) | Select-String -Pattern '\d+\.\d+\.\d+').Matches.Value
} else { '' }

if ($current -ne $ver) {
    $url = "https://github.com/zeroclaw-labs/zeroclaw/releases/download/v$ver/zeroclaw-x86_64-pc-windows-msvc.zip"
    New-Item -ItemType Directory -Force -Path $dst | Out-Null
    Invoke-WebRequest -Uri $url -OutFile "$env:TEMP\zeroclaw.zip" -UseBasicParsing
    Expand-Archive -Force -Path "$env:TEMP\zeroclaw.zip" -DestinationPath $dst
}

$environment = [Environment]
$userPath = $environment::GetEnvironmentVariable('Path', 'User')
if (($userPath -split ';') -notcontains $dst) {
    $environment::SetEnvironmentVariable('Path', "$dst;$userPath", 'User')
}
if (($env:Path -split ';') -notcontains $dst) {
    $env:Path = "$dst;$env:Path"
}

& $exe quickstart
```

--------------------------------

### Advanced source path: Unix install.sh --source

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/_snippets/install.md

Guided source build that always builds from source. Selects zerocode by default and allows app selection and optional Cargo features. Can bootstrap Rust if missing. Updates shell profile when allowed; reload parent shell. For unconfigured installs, offers 'zeroclaw quickstart' or browser-based Quickstart.

```sh
./install.sh --source
```

--------------------------------

### Install and manage zeroclaw service with OpenRC on Linux

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/service.md

Install the zeroclaw service on Linux with OpenRC, start it, and enable it to start on boot. The init script is written to /etc/init.d/zeroclaw. Logs are kept in /var/log/zeroclaw/access.log and error.log, each bounded to 8 MiB. Reinstall and restart after upgrading to use bounded logger processes.

```sh
zeroclaw service install   # writes /etc/init.d/zeroclaw
rc-service zeroclaw start
rc-update add zeroclaw default    # start on boot

```

--------------------------------

### Start the development environment

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/dev/README.md

Builds the agent from source and starts both containers.

```bash
./dev/cli.sh up
```

--------------------------------

### Run zeroclaw as a service

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/macos.md

Installs, starts, and checks the status of the LaunchAgent. Writes ~/Library/LaunchAgents/com.zeroclaw.daemon.plist.

```sh
zeroclaw service install   # writes ~/Library/LaunchAgents/com.zeroclaw.daemon.plist
zeroclaw service start
zeroclaw service status
```

--------------------------------

### Update ZeroClaw via curl pipe with skip-quickstart

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/linux.md

Re-run the installer via curl to update an existing installation, skipping the quickstart.

```sh
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | sh -s -- --skip-quickstart
```

--------------------------------

### Deploy Bridge app from Uno Q

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/hardware/arduino-uno-q-setup.md

Run the setup command directly on the Uno Q (SSH'd in) to deploy the Bridge app. This copies the Bridge app to ~/ArduinoApps/uno-q-bridge and starts it.

```sh
zeroclaw peripheral setup-uno-q

```

--------------------------------

### Authenticate and quickstart with OpenAI Codex

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/README.md

Use `zeroclaw auth login` to import an existing Codex CLI credential file, then `zeroclaw quickstart` to generate a provider entry for the OpenAI Codex subscription. The alias below is an example of the canonical OpenAI provider shape.

```bash
zeroclaw auth login --model-provider openai-codex --import ~/.codex/auth.json  # if already signed in with Codex CLI
zeroclaw quickstart --model-provider openai-codex --model gpt-5.4
```

--------------------------------

### Install ZeroClaw from a clone

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/linux.md

Run the install script from a cloned repository. This is the whole install process.

```sh
./install.sh
```

--------------------------------

### Host setup and run commands for zeroclaw vignette

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/demo/README.md

One-time setup: copy .env template, edit secrets, install socat, create config. Then run simulator and agent in separate terminals. The agent prints a Telegram bind code; send /bind <code> to the bot before using natural language prompts.

```bash
# 1. One-time setup
cp demo/.env.template demo/.env
nano demo/.env          # easiest on Mac. Use: code demo/.env  or  vim demo/.env
                        # At minimum, set:  OPENROUTER_API_KEY="your-real-key"
# For Telegram test comms: TELEGRAM_BOT_TOKEN="your-bot-token" (from @BotFather)

# 2. Install socat if missing (required by the simulator)
brew install socat

# 3. Ensure demo config exists
mkdir -p demo/data/config
cp -n demo/zeroclaw.toml.example demo/data/config/config.toml || true

# 4. Keep secrets in demo/.env. The host script injects them at runtime and does not persist them into config.toml.

# 5. Terminal 1 – start simulator + visualizer
./demo/run-sim-host.sh

# Wait for "frontend ready: http://127.0.0.1:8080", then open the URL. You should see the simulated room (lamps, fan, motion sensor etc.).

# 6. Terminal 2 – start the channel agent (it will poll Telegram if token configured)
./demo/run-agent-host.sh
```

--------------------------------

### Install flashing tools

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/firmware/esp32-ui/README.md

Installs espflash and cargo-espflash for flashing the firmware.

```bash
cargo install espflash cargo-espflash
```

--------------------------------

### Enable and start zeroclaw service (sh)

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/freebsd.md

Sets the rc.conf variables with sysrc, then starts and checks the service. The daemon starts on boot because zeroclaw_enable=YES is written to /etc/rc.conf.

```sh
doas sysrc zeroclaw_enable=YES
doas sysrc zeroclaw_runas=youruser     # the account that owns ~/.zeroclaw

doas service zeroclaw start
doas service zeroclaw status

```

--------------------------------

### Install ESP Rust toolchain

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/firmware/esp32-ui/README.md

Installs espup and sets up the ESP-IDF environment. Run these commands in order.

```bash
cargo install espup
espup install
source ~/export-esp.sh
```

--------------------------------

### Install and start ZeroClaw service

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/windows.md

Installs and starts the ZeroClaw scheduled task on Windows. The task is user-scoped and starts on login.

```cmd
zeroclaw service install
zeroclaw service start
```

--------------------------------

### Unix fast path: curl install script

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/_snippets/install.md

Noninteractive install that prefers a prebuilt binary and falls back to a source build. Uses a fixed feature set. On Unix, updates the shell profile when allowed; reload the parent shell before relying on the new PATH. Skips setup and prints 'zeroclaw quickstart' as the next step.

```sh
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | sh
```

--------------------------------

### Quickstart: docker exec zeroclaw quickstart

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/container.md

Bootstraps a default config on first run. Required before the container is useful.

```sh
docker exec -it zeroclaw zeroclaw quickstart
```

--------------------------------

### Run quickstart - shell command

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/hardware/arduino-uno-q-setup.md

SSH into the Uno Q and run the quickstart command with your OpenRouter API key and model provider to generate a configuration.

```sh
ssh arduino@<UNO_Q_IP>

# Quick config
zeroclaw quickstart --api-key YOUR_OPENROUTER_KEY --model-provider openrouter
```

--------------------------------

### Run ZeroClaw container and quickstart

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/freebsd.md

Run the ZeroClaw container with persistent storage and then execute the quickstart command. Keep the --os linux --arch amd64 flags on every run to avoid re-resolving to the FreeBSD default.

```sh
doas podman run -d --name zeroclaw --restart=always \
    --os linux --arch amd64 \
    -p 42617:42617 \
    -v /var/db/zeroclaw:/zeroclaw-data \
    ghcr.io/zeroclaw-labs/zeroclaw:debian

doas podman exec -it zeroclaw zeroclaw quickstart
```

--------------------------------

### CMD: Run setup.bat with --prebuilt

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/windows.md

Downloads a prebuilt binary from GitHub Releases. Note: current script still checks for cargo first, so this is not a true no-Rust install.

```cmd
setup.bat --prebuilt
```

--------------------------------

### Update zeroclaw via curl installer

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/macos.md

Re-runs the installer, detects existing install, and upgrades in place. Skips quickstart and restarts the service.

```sh
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | sh -s -- --skip-quickstart
zeroclaw service restart
```

--------------------------------

### Basic SOP.md Steps with tools, confirmation, policy, input/output, and next

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/sop/syntax.md

Shows a minimal SOP.md '## Steps' section with two steps: a preflight check and a deployment. The deployment step includes tool suggestions, confirmation requirement, policy, JSON Schema-like input/output contracts, and an explicit next step.

```markdown
## Steps

1. **Preflight** — Check service health and release window.
   - tools: http_request

2. **Deploy** — Run deployment command.
   - tools: shell
   - requires_confirmation: true
   - policy: prod
   - input: {"type":"object","required":["version"],"properties":{"version":{"type":"string"}}}
   - output: {"type":"object","required":["digest"],"properties":{"digest":{"type":"string"}}}
   - next: 3

```

--------------------------------

### One-time setup: copy .env template and edit

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/demo/README.md

Copy the environment template and set OPENROUTER_API_KEY in the .env file.

```bash
cp demo/.env.template demo/.env
$EDITOR demo/.env   # set OPENROUTER_API_KEY
```

--------------------------------

### Quick start commands for ZeroClaw demo

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/demo/README.md

Commands to copy and fill the environment file, start the simulator and visualizer, and launch an interactive agent session. The system primer from demo/PROMPTS.md should be pasted into the session.

```bash
# 1. Copy and fill env (needed for the model)
cp demo/.env.template demo/.env
$EDITOR demo/.env

# 2. Start the simulator + visualizer
./demo/run-sim.sh

# 3. In another terminal, start an interactive agent session
./demo/run-zeroclaw.sh

# 4. Paste the system primer from demo/PROMPTS.md, then try natural language:
#    "It's getting dark and chilly. I'm settling in to read for an hour."
```

--------------------------------

### Install hardened rc.d service

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/dist/freebsd/README.md

Installs the launcher and hardened rc.d script, substitutes the user placeholder, enables and starts the service. Replace zeroclaw-hardened.rc with zeroclaw.rc for the basic service.

```sh
user=youruser     # the account that owns ~/.zeroclaw

# Launcher: no substitution needed (derives HOME from the daemon -u account).
doas install -m 755 zeroclaw-run.sh /usr/local/libexec/zeroclaw-run.sh

sed "s/@@ZEROCLAW_USER@@/${user}/g" zeroclaw-hardened.rc \
    | doas tee /usr/local/etc/rc.d/zeroclaw >/dev/null
doas chmod 755 /usr/local/etc/rc.d/zeroclaw

doas sysrc zeroclaw_enable=YES
doas service zeroclaw start
doas service zeroclaw status
```

--------------------------------

### Run ZeroClaw as a persistent systemd service

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/hardware/raspberry-pi-setup.md

Installs and starts ZeroClaw as a persistent systemd user service, enabling it to start on boot and survive logout/reboot via loginctl enable-linger.

```sh
# Install and start the systemd user service
zeroclaw service install
systemctl --user enable --now zeroclaw

# So it survives logout / reboot:
loginctl enable-linger $USER
```

--------------------------------

### GET /api/status

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/ops/observability.md

Retrieves daemon status information, including the daemon start time.

```APIDOC
## GET /api/status

### Description
Retrieves daemon status information, including the daemon start time.

### Method
GET

### Endpoint
/api/status

### Parameters
None

### Response
#### Success Response (200)
- **daemon_started_at** (string) - RFC 3339 timestamp of when the daemon started.

#### Response Example
```json
{
  "daemon_started_at": "2025-01-01T00:00:00Z"
}
```

```

--------------------------------

### Start VNC server with Xvfb, fluxbox, x11vnc, and noVNC

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/tools/browser.md

Starts a virtual display with VNC access. Configures display number, ports, and resolution. Launches Xvfb, fluxbox, x11vnc, and websockify, then prints connection URLs.

```bash
#!/bin/bash
# Start virtual display with VNC access

DISPLAY_NUM=99
VNC_PORT=5900
NOVNC_PORT=6080
RESOLUTION=1920x1080x24

# Start Xvfb
Xvfb :$DISPLAY_NUM -screen 0 $RESOLUTION -ac &
sleep 1

# Start window manager
fluxbox -display :$DISPLAY_NUM &
sleep 1

# Start x11vnc
x11vnc -display :$DISPLAY_NUM -rfbport $VNC_PORT -forever -shared -nopw -bg
sleep 1

# Start noVNC (web-based VNC)
websockify --web=/usr/share/novnc $NOVNC_PORT localhost:$VNC_PORT &

echo "VNC available at:"
echo "  VNC Client: localhost:$VNC_PORT"
echo "  Web Browser: http://localhost:$NOVNC_PORT/vnc.html"
```

--------------------------------

### Deploy Bridge app from computer

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/hardware/arduino-uno-q-setup.md

Run the setup command from your computer (with the zeroclaw repo) to deploy the Bridge app to the Uno Q. Replace the IP with your board's address.

```sh
zeroclaw peripheral setup-uno-q --host 192.168.0.48

```

--------------------------------

### Advanced source path: Windows cargo install

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/_snippets/install.md

Noninteractive source build that installs the core 'zeroclaw' binary only; does not install optional apps. Uses a fixed feature set. Requires a Rust toolchain. Does not edit PATH; ensure Cargo's bin directory is in your shell. After installation, run 'zeroclaw quickstart'.

```powershell
cargo install --locked --path .
```

--------------------------------

### Build on device (Option A) - shell commands

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/hardware/arduino-uno-q-setup.md

SSH into the Uno Q, install Rust and build dependencies, clone the repository, and build with CARGO_BUILD_JOBS=1 to avoid OOM during linking. Then install the binary to /usr/local/bin.

```sh
# SSH into Uno Q
ssh arduino@<UNO_Q_IP>

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
source ~/.cargo/env

# Install build deps (Debian)
sudo apt-get update
sudo apt-get install -y pkg-config libssl-dev

# Clone zeroclaw (or scp your project)
git clone https://github.com/zeroclaw-labs/zeroclaw.git
cd zeroclaw

# Build (on-device build is slow; cross-compile from a larger machine if build time matters)
export CARGO_BUILD_JOBS=1 # build will be OOM-killed mid-link without this
cargo build --release --features hardware

# Install
sudo cp target/release/zeroclaw /usr/local/bin/
```

--------------------------------

### Start ZeroClaw daemon, channel, or service

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/channels/telegram.md

Commands to start ZeroClaw in different modes: full daemon for normal operation, channel-only process for foreground diagnostic, or installed service for long-running use.

```sh
zeroclaw daemon

# Alternative foreground diagnostic: starts all configured channels.
zeroclaw channel start

# If ZeroClaw is installed as a managed service.
zeroclaw service restart
```

--------------------------------

### Manage zeroclaw service with brew services

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/macos.md

For Homebrew installs, prefer using brew services to start and check the service.

```sh
brew services start zeroclaw
brew services info zeroclaw
```

--------------------------------

### Create crate and add dependencies

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/_snippets/plugin-crate-setup.md

Run these commands to create a new library crate and add the required dependencies: wit-bindgen, serde with derive feature, and serde_json.

```bash
cargo new --lib my-plugin
cd my-plugin
cargo add wit-bindgen@0.46
cargo add serde --features derive
cargo add serde_json
```

--------------------------------

### zeroclaw service CLI commands

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/service.md

Core commands to install, start, stop, restart, check status, and uninstall the ZeroClaw service.

```sh
zeroclaw service install     # register the service
zeroclaw service start       # start it
zeroclaw service stop        # stop it
zeroclaw service restart     # stop + start
zeroclaw service status      # running / stopped, last exit code
zeroclaw service uninstall   # remove it
```

--------------------------------

### Build ZeroClaw with channel feature flags

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/channels/overview.md

Shows how to install with the full preset and build with specific channel features. The first command installs with the full source preset, the second builds with all channels, and the third builds a minimal set with only the Slack channel.

```sh
./install.sh --source --preset full
cargo build --features channels-full
cargo build --no-default-features --features "agent-runtime,gateway,channel-slack"
```

--------------------------------

### Start and check zeroclaw service status

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/ops/troubleshooting.md

Use these commands to start the zeroclaw service and check its status. If the service is inactive, use `zeroclaw service logs` to tail the installed service logs, optionally with `--follow` or `--lines <count>`.

```sh
zeroclaw service start
zeroclaw service status
```

--------------------------------

### Quickstart with OpenAI Codex alias

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/getting-started/quickstart.md

Runs quickstart with scripted input for OpenAI Codex. The 'openai-codex' alias is accepted and writes the canonical '[providers.models.openai.<alias>]' entry.

```sh
zeroclaw quickstart --model-provider openai-codex --model gpt-5.4 --agent assistant
```

--------------------------------

### Quick start: single instance configuration

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/nix/README.md

Import the module and declare one instance. The settings mirror ~/.zeroclaw/config.toml as a Nix attrset. The environmentFile is set from an age secret. The bot_token uses $BOT_TOKEN placeholder, which is substituted by envsubst in ExecStartPre.

```nix
{ config, pkgs, ... }: {
  imports = [ ./path/to/zeroclaw/nix/module.nix ];

  # If pkgs.zeroclaw isn't yet in nixpkgs, set the package explicitly:
  # services.zeroclaw.instances.me.package = pkgs.callPackage ./zeroclaw.nix { };

  age.secrets.zeroclaw-bot-token.file = ./secrets/zeroclaw-bot-token.age;

  services.zeroclaw.instances.me = {
    environmentFile = config.age.secrets.zeroclaw-bot-token.path;
    # `settings` mirrors `~/.zeroclaw/config.toml` as a Nix attrset. The
    # config schema (section headers, type/alias convention, required
    # fields) is documented at
    # https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/providers/configuration.md
    settings = {
      providers.models.anthropic.home = {           # type = anthropic; alias = home (you choose)
        model = "claude-sonnet-4-6";
        api_key = "sk-ant-...";                     # or inject via env (see "Secrets pattern" below)
      };

      agents.assistant = {                          # alias = assistant (you choose)
        model_provider = "anthropic.home";          # <type>.<alias> reference
        risk_profile = "assistant";
        channels = [ "telegram.home" ];             # <type>.<alias> reference
      };

      risk_profiles.assistant = { };                # must match agents.assistant.risk_profile

      channels.telegram.home = {                    # type = telegram; alias = home (you choose)
        enabled = true;
        # The unit's ExecStartPre runs `envsubst` over the rendered
        # TOML. `$BOT_TOKEN` is read from the EnvironmentFile= and
        # written into ${dataDir}/config.toml (mode 0600, owner =
        # zeroclaw-me). The world-readable copy in /nix/store keeps
        # only the literal "$BOT_TOKEN" placeholder.
        bot_token = "$BOT_TOKEN";
        allowed_users = [ "12345" ];
      };
    };
  };
}
```

--------------------------------

### Expose frontend via ngrok

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/demo/README.md

Install ngrok, add your authtoken, and expose port 8080 to get a public URL for the hackathon demo.

```bash
brew install ngrok
ngrok config add-authtoken <TOKEN>   # from ngrok dashboard
ngrok http 8080
```

--------------------------------

### Quickstart writes the provider entry

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/providers/openai-codex-subscription.md

zeroclaw quickstart can generate the provider entry for the openai-codex provider with the specified model.

```bash
zeroclaw quickstart --model-provider openai-codex --model gpt-5.4
```

--------------------------------

### Run ZeroClaw daemon after Bridge setup

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/hardware/arduino-uno-q-setup.md

Start the ZeroClaw daemon again after configuring the peripherals. This enables GPIO commands via the Bridge when messaging the Telegram bot.

```sh
zeroclaw daemon --host 127.0.0.1 --port 42617

```

--------------------------------

### Override RPC socket with ZEROCLAW_SOCKET (sh and PowerShell)

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/architecture/rpc-socket.md

Override the default RPC socket endpoint on either platform. Set the ZEROCLAW_SOCKET environment variable before starting the daemon. The sh example uses a Unix domain socket path; the PowerShell example uses a named pipe path.

```sh
export ZEROCLAW_SOCKET=/tmp/my-zeroclaw.sock
zeroclaw daemon
```

```powershell
$env:ZEROCLAW_SOCKET = '\\.\pipe\my-zeroclaw'
zeroclaw daemon
```

--------------------------------

### Install a skill from local directory, Git URL, or registry name

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/tools/skills.md

Installs a skill from a local directory, Git URL, or registry name. Use --bundle to specify the destination bundle or --agent to target an agent.

```sh
zeroclaw skills install ./release-check --bundle ops
zeroclaw skills install https://example.com/zeroclaw-release-check.git --bundle ops
zeroclaw skills install release-check --agent default
```

--------------------------------

### Build Docker image

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/demo/README.md

Build the Docker image for the demo. This is heavy on the first run.

```bash
docker compose -f demo/docker-compose.yml build
```

--------------------------------

### sop_execute tool invocation example

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/sop/example.md

Shows the tool call that fires the pipeline when a release is published. The payload includes the project name, new version, and old version. This starts a SopRun with a manual trigger and forwards the payload into the run context.

```jsonc
// tool: sop_execute
// args: { "name": "stagex-update", "payload": "{\"project\":{\"name\":\"bzip2\"},\"version\":\"1.0.9\",\"old_version\":\"1.0.8\"}" }
```

--------------------------------

### Start browser on VNC display

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/tools/browser.md

Launches Google Chrome on the virtual display (DISPLAY=:99) with --no-sandbox flag, opening example.com.

```sh
DISPLAY=:99 google-chrome --no-sandbox https://example.com &
```

--------------------------------

### Manage zeroclaw service with Homebrew on macOS

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/setup/service.md

Use brew services to start, restart, and check the status of the zeroclaw service when installed via Homebrew. Do not mix these commands with zeroclaw service CLI commands; pick one to avoid confusing launchctl.

```sh
brew services start zeroclaw
brew services restart zeroclaw
brew services info zeroclaw

```

--------------------------------

### Run simulator and frontend (Terminal 1)

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/demo/README.md

Starts the simulator and frontend. Wait for 'frontend ready: http://127.0.0.1:8080' before opening it.

```bash
./demo/run-sim.sh
```
Tokens:
Raw