Skip to content

Getting Started

Community Implementation

A Rust implementation of OpenClaw by Neul Labs.

Welcome to openclaw-rs! This guide will help you get up and running quickly.

Overview

openclaw-rs provides a high-performance Rust implementation of the OpenClaw AI agent framework. It includes:

  • CLI - Command-line interface for managing agents and the gateway
  • Gateway - HTTP/WebSocket server with JSON-RPC API
  • Web Dashboard - Vue 3 UI for monitoring and interaction
  • Node.js Bindings - Use from JavaScript/TypeScript applications

What You'll Need

Before starting, ensure you have:

  • Rust 1.85+ (2024 edition)
  • Node.js 20+ (for building the web UI from source)
  • An API key from Anthropic or OpenAI

System dependencies for the agent sandbox:

Platform Requirement
Linux bubblewrap (bwrap)
macOS Built-in sandbox-exec
Windows None (uses Job Objects)

Quick Path

# 1. Install
cargo install openclaw-cli

# 2. Setup
openclaw onboard

# 3. Run
openclaw gateway run

# 4. Verify
openclaw status
openclaw doctor

The onboard wizard writes config to ~/.openclaw/openclaw.json and stores provider API keys via the secrets module (openclaw-core::secrets, AES-256-GCM). The doctor command validates the resulting setup before you start the gateway.

Next Steps