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.

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

• Start with Installation if NullClaw is not running yet
• Go to Configuration if you already installed it
• Jump to Commands if you want a task-based CLI reference

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

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:

Focus on:

• Usage and Operations
• Security
• Gateway API
• DingTalk Ops Readiness
• Lark Ops Readiness
• Signal Deployment

Focus on:

• External Channel Plugins
• Configuration
• Usage and Operations
• Architecture

Focus on:

• Architecture
• Development
• Commands
• Contributing

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

• Installation
• Termux Guide
• Configuration
• Usage and Operations
• Architecture
• Security
• Gateway API
• External Channel Plugins
• Commands
• Development

• DingTalk Ops Readiness
• Lark Ops Readiness

1. NullClaw currently requires Zig 0.16.0 (exact version).
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.

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.

• Contributing
• Security Policy
• Signal Deployment

• Follow Installation for setup from Homebrew, container, or source
• Continue to Configuration to wire providers, memory, channels, and gateway settings
• Use Usage and Operations once you want to run NullClaw day to day

• Termux Guide
• Commands
• Development
• Architecture
• Gateway API