### Install zeroclaw using the install script

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

Run the install script directly from a cloned repository or pipe it from curl. This script handles binary installation and offers to run the quickstart setup.

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

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

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

### ZeroClaw Quick Start Commands

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

Run these commands for a quick setup, interactive agent chat, or service installation and management.

```bash
zeroclaw quickstart               # one-shot setup: pick a provider, write a working config
```

```bash
zeroclaw agent -a <alias>         # interactive chat using the [agents.<alias>] entry
```

```bash
zeroclaw service install          # register as systemd/launchctl/Windows Service
```

```bash
zeroclaw service start            # run it always-on in the background
```

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

### Quick Start: Setup and Run Zeroclaw Demo

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

Follow these steps to set up the environment, start the simulator and visualizer, and launch an interactive agent session. This is the recommended way to begin using the demo.

```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 ZeroClaw without quickstart

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

Install ZeroClaw but skip the automatic 'zeroclaw quickstart' command. This allows you to run it manually later.

```bash
./install.sh --skip-quickstart
```

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

### Install zeroclaw using curl

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

Run the installer script directly from GitHub to install or update zeroclaw. Use --skip-quickstart to bypass the initial setup wizard.

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

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

### Run ZeroClaw Quickstart Configuration

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

This snippet shows how to run the ZeroClaw quickstart command on the Uno Q after installation. It's used for initial configuration, requiring your OpenRouter API key and specifying the model provider.

```sh
ssh arduino@<UNO_Q_IP>

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

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

### Install and Run ZeroClaw via Termux

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

Make the ZeroClaw binary executable, move it to the system's bin directory, and verify the installation. Then, run the quickstart command to set up ZeroClaw.

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

# Verify installation
zeroclaw --version

# Run setup
zeroclaw quickstart
```

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

### Start Signal Daemon and ZeroClaw Channel

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

This example shows the commands to start the signal-cli daemon and then start the ZeroClaw channel. Ensure the daemon is running before starting the channel.

```sh
signal-cli daemon --http 127.0.0.1:8686
zeroclaw channel start
```

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

### Install ZeroClaw with specific apps

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

Select which applications to install during the setup. Use 'none' to skip all application installations.

```bash
./install.sh --apps zerocode
```

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

### Install zeroclaw on Windows via setup.bat

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

Execute the setup batch file to install zeroclaw from a release.

```cmd
setup.bat
```

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

### Quick Start: ESP32 Firmware Setup

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

A condensed set of commands for quickly setting up the ESP32 firmware build environment, including Python, virtualenv, Rust tools, building, and flashing.

```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
```

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

### Install and Start zeroclaw on Linux (OpenRC)

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

Use these commands to install the zeroclaw service script for OpenRC, start the service, and enable it to run on boot.

```sh
zeroclaw service install
rc-service zeroclaw start
rc-update add zeroclaw default
```

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

### Install and Configure ngrok

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

Installs ngrok, adds your authentication token, and starts an HTTP tunnel to port 8080. Use the provided ngrok URL for public access.

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

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

### Install and Start zeroclaw Service

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

Install the zeroclaw bot as a managed service for automatic restarts with the machine. Use 'start' to initiate the service after installation.

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

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

### One-time Setup for Zeroclaw Development

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

Perform this setup once to configure environment variables and install necessary tools. Ensure your API keys are correctly set in the .env file.

```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)
```

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

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

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

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

### Quickstart Commands for Web Dashboard Development

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

Use these commands to quickly set up and develop the web dashboard. `cargo web` manages Vite and related tasks. It automatically runs `npm install` if dependencies are missing.

```sh
cargo web build         # production bundle into web/dist/
cargo web dev           # vite dev server with HMR
cargo web check         # typecheck only (gen-api + tsc -b)
cargo web gen-api       # regenerate web/src/lib/api-generated.ts
cargo web install       # npm install in web/
```

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

### Execute ZeroClaw Quickstart within Container

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

Executes the 'zeroclaw quickstart' command inside the running ZeroClaw container. This is used for initial setup or to verify the container is functioning correctly.

```sh
doas podman exec -it zeroclaw zeroclaw quickstart
```

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

### Zeroclaw Plugin Subcommand Examples

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/foundations/fnd-001-intentional-architecture.md

Illustrates the command-line interface for managing plugins, including listing, searching, installing, removing, and updating plugins from a component registry.

```bash
zeroclaw plugin list              # list installed plugins
zeroclaw plugin search <query>    # search the component registry
zeroclaw plugin install <name>    # download, verify, and install a plugin
zeroclaw plugin remove <name>     # remove an installed plugin
zeroclaw plugin update            # update all installed plugins

```

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

### Install ZeroClaw rc.conf Drop-in

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

Installs the `rc.conf.zeroclaw` drop-in file to configure the service via `rc.conf.d`. Remember to edit the `youruser` placeholder within the file before installation.

```sh
doas install -m 644 rc.conf.zeroclaw /etc/rc.conf.d/zeroclaw   # edit youruser first
```

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

### Install and manage zeroclaw as a LaunchAgent service

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

Install zeroclaw as a LaunchAgent to run it as a background service. This writes a plist file to `~/Library/LaunchAgents/` and allows starting, stopping, and checking the service status.

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

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

### Update zeroclaw from a Git clone

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

If you cloned the repository, navigate to the directory, pull the latest changes, and re-run the install script to update. Use --skip-quickstart to bypass the initial setup wizard.

```sh
cd /path/to/zeroclaw
git pull
./install.sh --skip-quickstart
```

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

### Enable and Start zeroclaw Service

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

Configures zeroclaw to start on boot and starts the service immediately. Also shows how to check the service status.

```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 Skills

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

Install a skill from various sources including a local directory, a Git URL, a registry name, or a ClawHub source. Specify the source after the install command.

```sh
zeroclaw skills install ./release-check
```

```sh
zeroclaw skills install https://example.com/zeroclaw-release-check.git
```

```sh
zeroclaw skills install release-check
```

```sh
zeroclaw skills install clawhub:release-check
```

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

### Dry run installation with prebuilt binary

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

Perform a dry run of the installation using a prebuilt binary. This will show what would happen without actually installing anything.

```bash
./install.sh --dry-run --prebuilt
```

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

### Clone and Set Up Development Environment

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

Clone the repository, navigate into the directory, and enable the pre-push hook for automated checks. Build and test the project, then run the quality gate script for formatting and linting.

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

git config core.hooksPath .githooks

cargo build
cargo test --locked

./scripts/ci/rust_quality_gate.sh

./dev/ci.sh all
```

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

### Run zeroclaw Quickstart via CLI

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

Initiates the quickstart process using the command-line interface. This is the fastest method for headless systems or SSH connections. Configuration is done via interactive prompts.

```sh
zeroclaw quickstart
```

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

### Manage zeroclaw service with Homebrew

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

For Homebrew installations, use `brew services` to start and get information about the zeroclaw service. This provides an alternative to the `zeroclaw service` commands.

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

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

### Build and Serve Documentation

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

Use these commands to build the documentation site locally and serve it with live reloading for fast iteration on prose and translations.

```bash
cargo mdbook build
cargo mdbook serve
```

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

### Reset ZeroClaw Installation

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

Use this command to remove an existing ZeroClaw installation and its configuration before running quickstart.

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

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

### Initialize ZeroClaw Configuration

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

Executes the quickstart command within a running ZeroClaw container to bootstrap its initial configuration.

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

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

### Run Simulator and Frontend

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

Starts the simulator and frontend in the first terminal. Open the provided URL in your browser once ready.

```bash
./demo/run-sim.sh
```

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

### Quick Start Deployment

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

Executes the one-shot cross-compile and deploy script for Raspberry Pi. Sets the host and user for SSH connection.

```bash
RPI_HOST=raspberrypi.local RPI_USER=pi ./scripts/deploy-rpi.sh
```

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

### Start ZeroClaw systemd Service

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

Reloads the systemd daemon and starts the ZeroClaw service for the current user. For rootless setups, enable linger to ensure the service starts on boot.

```sh
systemctl --user daemon-reload
systemctl --user start zeroclaw.service
```

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

### Install zeroclaw using setup.bat

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

Installs zeroclaw using the `setup.bat` script with the `--prebuilt` flag to download a prebuilt binary. Note that this script still checks for `cargo`.

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

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

### Install and Run ZeroClaw as a Systemd Service

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

Install the systemd user service for ZeroClaw and enable it to start automatically on boot. Ensure it survives user logouts by enabling lingering.

```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
```

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

### Install zeroclaw on Windows from source

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

Build and install zeroclaw from source using Cargo.

```cmd
cargo install --locked --path .
```

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

### Download and install ZeroClaw binary for Raspberry Pi

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

Manually download the appropriate ZeroClaw binary tarball for your Raspberry Pi's architecture and install it to a system-wide location. This method is recommended for faster setup.

```shell
# 64-bit (Pi 4/5 with 64-bit Raspberry Pi OS)
curl -LO 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
sudo install -m 0755 zeroclaw /usr/local/bin/
```

```shell
# 32-bit (Pi Zero 2 W, older Pi 3 with 32-bit OS)
curl -LO https://github.com/zeroclaw-labs/zeroclaw/releases/latest/download/zeroclaw-armv7-unknown-linux-gnueabihf.tar.gz
tar xzf zeroclaw-armv7-unknown-linux-gnueabihf.tar.gz
sudo install -m 0755 zeroclaw /usr/local/bin/
```

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

### Start ZeroClaw Development Environment

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

Builds the agent from source and starts both the agent and sandbox containers. Run from the repository root.

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

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

### Start SGLang server

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

Launches an SGLang server for a specified Llama model. Requires the sglang Python package to be installed.

```sh
python -m sglang.launch_server --model meta-llama/Llama-3.1-8B-Instruct --port 30000
```

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

### Run zeroclaw Docker Container

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

Quick start command to run the zeroclaw Docker container. Assumes Docker is installed and configured.

```bash
docker run --rm -it ghcr.io/zeroclaw-labs/zeroclaw:latest quickstart
```

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

### Start vLLM server

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

Serves a specified Llama model using the vLLM inference engine. Ensure vLLM is installed and configured.

```sh
vllm serve meta-llama/Llama-3.1-8B-Instruct
```

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

### Install ZeroClaw from source with custom features

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

Build from source and enable specific features like agent-runtime and channel-discord.

```bash
./install.sh --source --features agent-runtime,channel-discord
```

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

### Gateway Startup Log - Dashboard Available

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/gateway/web-dashboard.md

Example of the gateway startup log when the web dashboard is successfully found and served. This indicates the path to the `web/dist` directory.

```text
Web dashboard: serving from /absolute/path/to/zeroclaw/web/dist
```

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

### ZeroClaw Service CLI Commands

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

Use these commands to manage the ZeroClaw service installation, start, stop, restart, check status, and uninstall it.

```sh
zeroclaw service install
zeroclaw service start
zeroclaw service stop
zeroclaw service restart
zeroclaw service status
zeroclaw service uninstall
```

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

### Copy Sample Manifests

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

Copies sample YAML files to create your real configuration files for deployment.

```bash
for f in deploy-k8s/*-sample.yaml; do cp "$f" "${f/-sample/}"; done
```

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

### Query Logs: All WARN+ Events

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

Example using curl to fetch all logs with severity level WARN or higher since the daemon started.

```sh
# All WARN+ events since the daemon started.
curl "$ZEROCLAW_GATEWAY/api/logs?severity_min=13"
```

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

### Configure ZeroClaw Workspace for Homebrew

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

Set the ZEROCLAW_WORKSPACE environment variable to align the Homebrew installation path with the default config directory before running quickstart.

```sh
export ZEROCLAW_WORKSPACE="$HOMEBREW_PREFIX/var/zeroclaw"
zeroclaw quickstart
```

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

### Install ZeroClaw from source

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

Force the installation to build from source, allowing for customisation.

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

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

### Start llama.cpp server

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

Starts a llama.cpp server with specified model and configuration. Ensure the llama-server executable is in your PATH.

```sh
llama-server -hf ggml-org/gpt-oss-20b-GGUF --jinja -c 133000 --host 127.0.0.1 --port 8033
```

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

### Proposed GitHub Wiki Structure

Source: https://github.com/zeroclaw-labs/zeroclaw/blob/master/docs/book/src/foundations/fnd-002-documentation-standards.md

This is a hierarchical outline of the proposed structure for the GitHub Wiki, categorizing documentation by function such as Getting Started, Configuration, Channels, Operations, Hardware, and Community.

```text
Home
│
├── Getting Started
│     ├── Installation
│     ├── Quick Start (TL;DR)
│     ├── Migrating from OpenClaw
│     └── Onboarding Walkthrough
│
├── Configuration
│     ├── Providers
│     ├── Channels
│     ├── Memory
│     ├── Security & Pairing
│     └── Tunnels
│
├── Channels
│     ├── Telegram
│     ├── Discord
│     ├── Slack
│     ├── WhatsApp
│     └── ... (one page per channel)
│
├── Operations
│     ├── Troubleshooting
│     ├── Deployment
│     ├── Network Setup
│     └── Performance Tuning
│
├── Hardware
│     ├── Getting Started with Peripherals
│     ├── ESP32 Setup
│     ├── STM32 Nucleo Setup
│     └── Arduino Setup
│
└── Community
      ├── FAQ
      ├── Translations
      └── How to Contribute

```

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

### Snapshotting with References

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

Shows how to open a URL, take an interactive snapshot, and close the browser.

```sh
# Snapshot with refs
agent-browser open https://example.com
agent-browser snapshot -i
agent-browser close
```

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

### JSON Trace Fixture Structure

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

Example of a JSON trace fixture used for declarative conversation scripting in tests. This format replaces inline mock setup with a readable and editable script.

```json
{
  "model_name": "test-name",
  "turns": [
    {
      "user_input": "User message",
      "steps": [
        {
          "response": {
            "type": "text",
            "content": "LLM response",
            "input_tokens": 20,
            "output_tokens": 10
          }
        }
      ]
    }
  ],
  "expects": {
    "response_contains": ["expected text"],
    "tools_used": ["echo"],
    "max_tool_calls": 1
  }
}

```

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

### Install ZeroClaw with minimal source preset

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

Use the minimal source preset for installation, which includes only the kernel and results in a smaller footprint.

```bash
./install.sh --preset minimal
```