ZeroClaw Agent Runtime

repository·master·Indexed 12 days ago

https://github.com/zeroclaw-labs/zeroclaw

A local-first, privacy-focused AI agent runtime written in Rust. ZeroClaw enables the creation of autonomous agents that interact with LLM providers, communicate via web, CLI, or messaging apps, and control local hardware or software tools. It includes a Robot Kit for Raspberry Pi with tools for movement, vision, and speech, as well as a deterministic evaluation harness called zeroclaw-eval for testing agent behavior using JSON trace fixtures.

Tokens
302.7K
Snippets
711
Records
1.4K
Agent score
97%

What's inside ZeroClaw

  1. What is zerocode?

    master

    zerocode is the terminal interface for managing ZeroClaw. It is used for three primary tasks:

    1. Managing Configuration: Use the Config pane to change settings (this is the preferred method for modifying ZeroClaw settings).
    2. Interacting with Agents: Use the Code and Chat panes to drive agents.
    3. Monitoring: Monitor your running ZeroClaw daemon.

    zerocode connects to the daemon via several transport methods depending on your setup:

    • Local IPC (Unix): Uses a Unix domain socket.
    • Local IPC (Windows): Uses a named pipe.
    • Remote: Uses WebSocket Secure (WSS).
  2. What is ZeroClaw?

    master

    ZeroClaw is an agent runtime written in Rust designed to be a self-hosted, personal AI assistant. It operates as a single binary that you configure and run locally on your own machine using your own API keys.

    ZeroClaw's core functionality is built around three pillars:

    1. Model Providers: Connects to LLMs (e.g., Anthropic, OpenAI, Ollama, and ~20 others).
    2. Channels: Interfaces with the world via communication platforms like Discord, Telegram, Matrix, email, voice, webhooks, or a custom CLI.
    3. Tools: Performs actions through capabilities such as shell access, web browsing, HTTP requests, hardware control, and custom MCP (Model Context Protocol) servers.
  3. Overview of ZeroClaw Robot Kit tools

    master

    The Robot Kit provides a set of high-level tools that allow an AI agent to interact with the physical world. These tools bridge the gap between the high-level AI (Ollama) and the hardware layer.

    ToolDescription
    driveOmni-directional movement (forward, strafe, rotate)
    lookCamera capture + vision model description
    listenSpeech-to-text via Whisper.cpp
    speakText-to-speech via Piper TTS
    senseLIDAR, motion sensors, ultrasonic distance
    emoteLED expressions and sound effects
  4. Overview of ZeroClaw capabilities

    master

    ZeroClaw is an agent runtime that provides several core capabilities:

    • Multi-channel: One agent can respond across multiple channels (Discord, Telegram, Matrix, email, webhooks, CLI, etc.).
    • Provider-agnostic: Supports Anthropic, OpenAI, local Ollama, and ~20 other providers with fallback chains and routing.
    • Security-first: Features supervised autonomy by default (approving medium-risk, blocking high-risk), workspace boundaries, and OS-level sandboxing (Landlock, Docker, etc.).
    • Hardware-capable: Supports GPIO, I2C, SPI, and USB on devices like Raspberry Pi and ESP32 via the Peripheral trait.
    • SOP Engine: Event-triggered Standard Operating Procedures (via MQTT, webhook, cron, or peripheral) with approval gates.
    • ACP: Integration with IDEs/editors via the Agent Client Protocol (JSON-RPC 2.0 over stdio).
  5. ZeroClaw Maturity Framework Document Sequence

    master

    The framework is organized into a sequence of six core documents that build upon one another. While you can enter at any point, reading them in order provides the full context of the project's evolution from architecture to code-level discipline.

    #DocumentFocus Area
    1Intentional Architecture: Microkernel TransitionArchitectural shape and purpose
    2Documentation Standards and Knowledge ArchitectureRecording and transferring knowledge
    3Team Organization and Project GovernanceCoordination and decision-making
    4Engineering Infrastructure: CI/CD PipelineBuilding, testing, and shipping
    5Contribution Culture: Human Collaboration and AI PartnershipHuman and AI collaboration
    6Zero Compromise in PracticeCode health and production readiness
  6. Understand ZeroClaw Default Security Posture

    master

    By default, ZeroClaw ships with a balanced security posture suitable for local development:

    FeatureDefault Value
    AutonomySupervised
    Workspace-onlytrue
    SandboxAuto-detect (OS-native)
    Audit loggingfalse
    OTPfalse
    E-stopfalse

    For production environments, it is recommended to increase security by enabling OTP, audit logging, and restricted tools. For pure development, you can use the YOLO mode.

  7. Use Claude Code skills to automate maintainer workflows

    master

    The repository includes a set of Claude Code skills located in .claude/skills/ that automate common maintainer tasks. These skills are loaded automatically when you open the repository. You can invoke them by describing your intent in plain language or by using an explicit reference (e.g., /skill-name <argument>).

    Available skills

    SkillUse it when
    github-pr-review-sessionReviewing a specific PR or working through the review queue
    github-issue-triageRunning a backlog sweep, closing stale/duplicate issues, or applying labels
    github-issueFiling a structured issue (bug report or feature request)
    github-prOpening or updating a PR with a fully-populated template body
    squash-mergeLanding an approved PR into master with preserved history and the purple Merged badge
    changelog-generationPreparing CHANGELOG-next.md for a release by summarizing merges since the last tag
    skill-creatorCreating, editing, or benchmarking the skills themselves
    zeroclawOperating the running ZeroClaw instance (CLI + gateway API)
  8. Use cases for the Agent Client Protocol

    master

    ACP is ideal for scenarios where you need to manage agent sessions without the overhead of HTTP or port binding. Common use cases include:

    • Editor Extensions: Implementing commands like "ask the agent about this file" directly within an IDE.
    • Terminal Multiplexers: Integrating agent sessions into side panes within terminal environments.
    • CI Runners: Driving an agent programmatically during continuous integration without a full gateway setup.
    • Subprocess Integration: Any tool that needs to communicate with an agent via standard input/output streams.
  9. What is the Agent Client Protocol (ACP)?

    master

    The Agent Client Protocol (ACP) is a JSON-RPC 2.0 protocol designed to allow editors, IDEs, or other tools to drive a running ZeroClaw agent as a session host. It operates over stdio using newline-delimited JSON, making it lightweight, streamable, and easy to integrate with subprocesses.

    Conceptually, it functions like the Language Server Protocol (LSP) but for agents: the host (e.g., an editor) launches the zeroclaw acp command, sends prompts via stdin, and receives session updates via stdout.

  10. What is an Alias and how to name them

    master

    An Alias is a user-defined name assigned to a configured instance, used as a reference point to wire different parts of the configuration together.

    Naming Rules (Alias Grammar)

    To ensure compatibility with the configuration parser, aliases must follow these constraints:

    • Use only lowercase ASCII letters, digits, and single underscores (_).
    • Must start and end with a letter or a digit.
    • Cannot contain double underscores (__) or hyphens (-).

    Usage in Configuration

    Aliases are used within section headers to identify specific instances. For example, they appear as the <alias> segment in paths like:

    • [agents.<alias>]
    • [providers.models.<type>.<alias>]
  11. Overview of Standard Operating Procedures (SOP)

    master
    Standard Operating Procedures (SOPs) in ZeroClaw are deterministic procedures executed by the SopEngine. They are designed to provide explicit trigger matching, approval gates, and an auditable run state. SOPs allow you to automate complex workflows by defining how the system should respond to specific events or triggers.
  12. What is a Model Provider in ZeroClaw

    master

    A Model Provider is ZeroClaw's abstraction layer for interacting with LLM (Large Language Model) endpoints. Instead of calling APIs directly, every chat-completion request is routed through a provider. This allows ZeroClaw to support various backends including remote APIs, self-hosted servers, or local instances like Ollama.

    Key characteristics:

    • Vendor Families: Providers are categorized by their vendor family (e.g., OpenAI, Anthropic, Ollama).
    • Named Instances: You can define multiple named instances of the same vendor family (using aliases) to manage different models or configurations simultaneously.
    • Configuration Path: Providers are configured under the [providers.models.<type>.<alias>] hierarchy in your configuration file.