Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nullclaw/nullclaw/llms.txt

Use this file to discover all available pages before exploring further.

The nullclaw status command displays a quick overview of your NullClaw installation, configuration, and running services.

​
Usage

nullclaw status

​
What It Shows

​
Installation Info

  • Zig version
  • Binary location and size
  • Config directory location

​
Configuration

  • Active provider(s)
  • Primary model
  • Configured channels
  • Memory backend

​
Runtime Status

  • Gateway running (yes/no)
  • Active channels
  • Service status (if installed)

​
Example Output

$ nullclaw status

NullClaw Status
═══════════════════════════════════════════════════════

Installation:
  Zig version: 0.15.2
  Binary: /usr/local/bin/nullclaw (678 KB)
  Config: ~/.nullclaw/config.json

Configuration:
  Provider: openrouter
  Model: openrouter/anthropic/claude-sonnet-4
  Channels: telegram, discord (2 configured)
  Memory: sqlite (147 entries)

Runtime:
  Gateway: running (port 3000)
  Active channels: telegram, discord
  Service: installed, active
  Uptime: 2h 15m

═══════════════════════════════════════════════════════
Status: ✓ All systems operational

​
Exit Codes

  • 0 - All systems operational
  • 1 - Warnings (some components not configured)
  • 2 - Errors (critical components missing)

​
Use Cases

​
Quick Health Check

nullclaw status
Shows overall system health at a glance.

​
Pre-Deployment Validation

if nullclaw status; then
  echo "Ready to deploy"
else
  echo "Fix configuration issues first"
  exit 1
fi

​
Debugging

nullclaw status
Verify configuration before troubleshooting.

​
See Also