Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Linux

Install, update, run as a service, and uninstall, all Linux distributions.

Install

./install.sh

That is the whole install. Run it from a clone, or pipe it from curl:

sh

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

The canonical installation paths explain the fast and guided routes, source fallback, app selection, PATH handoff, and the next Quickstart step.

Homebrew (Linuxbrew)

sh

brew install zeroclaw

Homebrew-on-Linux installs follow Homebrew’s service path convention, your workspace lives under $HOMEBREW_PREFIX/var/zeroclaw/ instead of ~/.zeroclaw/. See Service management for why this matters.

NixOS

The upstream flake provides the ZeroClaw CLI. With Nix and flakes enabled:

nix run github:zeroclaw-labs/zeroclaw -- --version

See NixOS for source builds, the Nixpkgs package, and the multi-instance NixOS service module. For prebuilt binaries, use the installer described above.

System dependencies

The core binary is statically linked where possible. Some features require system libraries:

FeaturePackage (Debian/Ubuntu)Package (Arch)Package (Fedora)
Docs translation (cargo mdbook sync)gettextgettextgettext
Browser tool (playwright)libnss3, libatk1.0-0, libcups2 (see playwright --help)nss, atk, cupsnss, atk, cups
Audio (TTS, voice channels)libasound2-devalsa-libalsa-lib-devel

The hardware feature (GPIO / I2C / SPI on a Pi) uses the pure-Rust rppal driver and needs no extra system library; it talks to /dev/gpiomem, /dev/spidev*, and /dev/i2c-* directly. What it does need is device access: enable the SPI/I2C interfaces and put the service user in the gpio, spi, and i2c groups (see SBC / Raspberry Pi below).

Most deployments don’t need any of these.

Running as a service

Systemd is the default. OpenRC is detected and supported as a fallback.

sh

zeroclaw service install
zeroclaw service start
zeroclaw service status

Logs go to the systemd journal by default:

sh

journalctl --user -u zeroclaw -f

Full details: Service management.

SBC / Raspberry Pi

On a Raspberry Pi or similar SBC, build with the hardware feature:

sh

./install.sh --source --features hardware

For hardware access without running as root, the service user needs the gpio, spi, and i2c groups. The user-level unit that zeroclaw service install writes does not set these; use the system-level Pi unit template at scripts/zeroclaw.service, which includes SupplementaryGroups=gpio spi i2c. Either way, verify your user is in those groups:

sh

getent group gpio spi i2c
sudo usermod -aG gpio,spi,i2c $USER
# re-login for group changes to take effect

Update

Standard release updates carry the native adapters for both minimal and full tool settings. Full stays the default for new and existing installations, including configurations without [tools]. Minimal, eleven tools in Chat and eight in Code/ACP, is opt-in through optional = []. Explicit selections are preserved; named entries select individual extras. Full preserves existing integration prerequisites and permission gates. Plain Cargo-default source builds, including a Homebrew formula that uses only those defaults, can still omit adapters. See minimal/full tools and build recovery.

Re-run the installer, it detects the existing install and upgrades in place:

sh

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

Or from a clone:

sh

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

If installed via Homebrew instead:

sh

brew update && brew upgrade zeroclaw

After updating, restart the service:

sh

zeroclaw service restart

Uninstall

If you installed with the bootstrap script, use the same script to uninstall:

sh

./install.sh --uninstall

Stop and remove the service:

sh

zeroclaw service stop
zeroclaw service uninstall

Remove the binary:

sh

# cargo install / bootstrap
rm ~/.cargo/bin/zeroclaw

# Homebrew
brew uninstall zeroclaw

Remove config and workspace (optional: this deletes conversation history):

sh

rm -rf ~/.zeroclaw ~/.config/zeroclaw

Next