NullClaw English Docs

May 8, 2026 · View on GitHub

This directory provides structured English documentation for NullClaw, covering installation, configuration, operations, integration, and development.

Community: Join Discord

If you are new here, use the guided paths below instead of guessing which page to open first.

Page Guide

Who this page is for

  • New users choosing their first documentation path
  • Operators deciding which operational guide to open next
  • Contributors looking for the right entry point before deeper docs

Read this next

If you came from ...

  • README.md: use this page as the English landing page, then branch into the guide you need
  • Commands: come back here if you want a broader map of the docs set
  • Development: return here if you need user or operator docs outside contributor workflows

Start Paths

TH:### 0. I have no technical background JQ: NP:Start here if you have never configured an AI model, edited a JSON file, or used a command-line tool. VB: BV:Beginner's Guide VX: MS: TH:### 1. I just want to get it running JQ: NP:Recommended order: WV: WJ:1. Installation QJ:2. Configuration HS:3. Usage and Operations HZ:4. Commands MS:

2. I need deployment or operations guidance

Focus on:

3. I want to integrate beyond built-in channels

Focus on:

4. I want to contribute code or docs

Focus on:

QV:- Beginner's Guide ← start here if you are new to NullClaw

Ops Runbooks

Start Here

  1. NullClaw currently requires Zig 0.16.0 (exact version); Debian setup is covered in Zig Installation.
  2. Default config path is ~/.nullclaw/config.json (generated by nullclaw onboard).
  3. For first run, use onboard --interactive, then verify with agent and gateway.

Fastest First Run (3 minutes)

brew install nullclaw
nullclaw onboard --interactive
nullclaw agent -m "hello nullclaw"

If you are not installing via Homebrew, start with Installation for container and source paths.

Specialized Guides

Next Steps