FAQ
Quick answers plus deeper troubleshooting for real-world setups (local dev, VPS, multi-agent, OAuth/API keys, model failover). For runtime diagnostics, see Troubleshooting. For the full config reference, see Configuration.First 60 seconds if something’s broken
-
Run the doctor
Repairs/migrates config/state + runs health checks. See Doctor.
-
Daemon + port state
Shows supervisor runtime vs RPC reachability, the probe target URL, and which config the daemon likely used.
-
Local probes
Checks provider connectivity and local health. See Health.
-
Gateway snapshot
Asks the running gateway for a full snapshot (WS-only). See Health.
-
Tail the latest log
File logs are separate from service logs; see Logging and Troubleshooting.
What is Clawdbot?
What is Clawdbot, in one paragraph?
Clawdbot is a personal AI assistant you run on your own devices. It replies on the messaging surfaces you already use (WhatsApp, Telegram, Slack, Discord, Signal, iMessage, WebChat) and can also do voice + a live Canvas on supported platforms. The Gateway is the always‑on control plane; the assistant is the product.Quick start and first‑run setup
What’s the recommended way to install and set up Clawdbot?
The repo recommends running from source and using the onboarding wizard:What runtime do I need?
Node >= 22 is required.pnpm is recommended; bun is optional.
What does the onboarding wizard actually do?
clawdbot onboard is the recommended setup path. In local mode it walks you through:
- Model/auth setup (Anthropic OAuth recommended, OpenAI Codex OAuth supported, API keys optional, LM Studio local models supported)
- Workspace location + bootstrap files
- Gateway settings (bind/port/auth/tailscale)
- Providers (WhatsApp, Telegram, Discord, Signal, iMessage)
- Daemon install (LaunchAgent on macOS; systemd user unit on Linux/WSL2)
- Health checks and skills selection
Can I use Bun?
Bun is supported for faster TypeScript execution, but WhatsApp requires Node in this ecosystem. The wizard lets you pick the runtime; choose Node if you use WhatsApp.Is there a dedicated sandboxing doc?
Yes. See Sandboxing. For Docker-specific setup (full gateway in Docker or sandbox images), see Docker.Where things live on disk
Where does Clawdbot store its data?
Everything lives under$CLAWDBOT_STATE_DIR (default: ~/.clawdbot):
| Path | Purpose |
|---|---|
$CLAWDBOT_STATE_DIR/clawdbot.json | Main config (JSON5) |
$CLAWDBOT_STATE_DIR/credentials/oauth.json | Legacy OAuth import (copied into auth profiles on first use) |
$CLAWDBOT_STATE_DIR/agents/<agentId>/agent/auth-profiles.json | Auth profiles (OAuth + API keys) |
$CLAWDBOT_STATE_DIR/agents/<agentId>/agent/auth.json | Runtime auth cache (managed automatically) |
$CLAWDBOT_STATE_DIR/credentials/ | Provider state (e.g. whatsapp/<accountId>/creds.json) |
$CLAWDBOT_STATE_DIR/agents/ | Per‑agent state (agentDir + sessions) |
$CLAWDBOT_STATE_DIR/agents/<agentId>/sessions/ | Conversation history & state (per agent) |
$CLAWDBOT_STATE_DIR/agents/<agentId>/sessions/sessions.json | Session metadata (per agent) |
~/.clawdbot/agent/* (migrated by clawdbot doctor).
Your workspace (AGENTS.md, memory files, skills, etc.) is separate and configured via agent.workspace (default: ~/clawd).
I’m in remote mode — where is the session store?
Session state is owned by the gateway host. If you’re in remote mode, the session store you care about is on the remote machine, not your local laptop. See Session management.Config basics
What format is the config? Where is it?
Clawdbot reads an optional JSON5 config from$CLAWDBOT_CONFIG_PATH (default: ~/.clawdbot/clawdbot.json):
~/clawd).
I set gateway.bind: "lan" (or "tailnet") and now nothing listens / the UI says unauthorized
Non-loopback binds require auth. Configure gateway.auth.mode + gateway.auth.token (or use CLAWDBOT_GATEWAY_TOKEN).
gateway.remote.tokenis for remote CLI calls only; it does not enable local gateway auth.- The Control UI authenticates via
connect.params.auth.token(stored in app/UI settings). Avoid putting tokens in URLs.
Do I have to restart after changing config?
The Gateway watches the config and supports hot‑reload:gateway.reload.mode: "hybrid"(default): hot‑apply safe changes, restart for critical oneshot,restart,offare also supported
gateway, bridge, discovery, and canvasHost changes.
Is there an API / RPC way to apply config?
Yes.config.apply validates + writes the full config and restarts the Gateway as part of the operation.
What’s a minimal “sane” config for a first install?
Env vars and .env loading
How does Clawdbot load environment variables?
Clawdbot reads env vars from the parent process (shell, launchd/systemd, CI, etc.) and additionally loads:.envfrom the current working directory- a global fallback
.envfrom~/.clawdbot/.env(aka$CLAWDBOT_STATE_DIR/.env)
.env file overrides existing env vars.
You can also define inline env vars in config (applied only if missing from the process env):
“I started the Gateway via a daemon and my env vars disappeared.” What now?
Two common fixes:- Put the missing keys in
~/.clawdbot/.envso they’re picked up even when the daemon doesn’t inherit your shell env. - Enable shell import (opt‑in convenience):
CLAWDBOT_LOAD_SHELL_ENV=1, CLAWDBOT_SHELL_ENV_TIMEOUT_MS=15000.
Sessions & multiple chats
How do I start a fresh conversation?
Send/new or /reset as a standalone message. See Session management.
Do groups/threads share context with DMs?
Direct chats collapse to the main session by default. Groups/channels have their own session keys, and Telegram topics / Discord threads are separate sessions. See Groups and Group messages.Models: defaults, selection, aliases, switching
What is the “default model”?
Clawdbot’s default model is whatever you set as:provider/model (example: anthropic/claude-opus-4-5). If you omit the provider, Clawdbot currently assumes anthropic as a temporary deprecation fallback — but you should still explicitly set provider/model.
How do I switch models on the fly (without restarting)?
Use the/model command as a standalone message:
/model, /model list, or /model status.
Are opus / sonnet / gpt built‑in shortcuts?
Yes. Clawdbot ships a few default shorthands (only applied when the model exists inagent.models):
opus→anthropic/claude-opus-4-5sonnet→anthropic/claude-sonnet-4-5gpt→openai/gpt-5.2gpt-mini→openai/gpt-5-minigemini→google/gemini-3-pro-previewgemini-flash→google/gemini-3-flash-preview
How do I define/override model shortcuts (aliases)?
Aliases come fromagent.models.<modelId>.alias. Example:
/model sonnet (or /<alias> when supported) resolves to that model ID.
How do I add models from other providers like OpenRouter or Z.AI?
OpenRouter (pay‑per‑token; many models):No API key found for provider "zai").
Model failover and “All models failed”
How does failover work?
Failover happens in two stages:- Auth profile rotation within the same provider.
- Model fallback to the next model in
agent.model.fallbacks.
What does this error mean?
anthropic:default, but could not find credentials for it in the expected auth store.
Fix checklist for No credentials found for profile "anthropic:default"
- Confirm where auth profiles live (new vs legacy paths)
- Current:
~/.clawdbot/agents/<agentId>/agent/auth-profiles.json - Legacy:
~/.clawdbot/agent/*(migrated byclawdbot doctor)
- Current:
- Confirm your env var is loaded by the Gateway
- If you set
ANTHROPIC_API_KEYin your shell but run the Gateway via systemd/launchd, it may not inherit it. Put it in~/.clawdbot/.envor enableenv.shellEnv.
- If you set
- Make sure you’re editing the correct agent
- Multi‑agent setups mean there can be multiple
auth-profiles.jsonfiles.
- Multi‑agent setups mean there can be multiple
- Sanity‑check model/auth status
- Use
/model statusto see configured models and whether providers are authenticated.
- Use
Why did it also try Google Gemini and fail?
If your model config includes Google Gemini as a fallback (or you switched to a Gemini shorthand), Clawdbot will try it during model fallback. If you haven’t configured Google credentials, you’ll seeNo API key found for provider "google".
Fix: either provide Google auth, or remove/avoid Google models in agent.model.fallbacks / aliases so fallback doesn’t route there.
Auth profiles: what they are and how to manage them
Related: /concepts/oauth (OAuth flows, token storage, multi-account patterns, CLI sync)What is an auth profile?
An auth profile is a named credential record (OAuth or API key) tied to a provider. Profiles live in:What are typical profile IDs?
Clawdbot uses provider‑prefixed IDs like:anthropic:default(common when no email identity exists)anthropic:<email>for OAuth identities- custom IDs you choose (e.g.
anthropic:work)
Can I control which auth profile is tried first?
Yes. Config supports optional metadata for profiles and an ordering per provider (auth.order.<provider>). This does not store secrets; it maps IDs to provider/mode and sets rotation order.
OAuth vs API key: what’s the difference?
Clawdbot supports both:- OAuth often leverages subscription access (where applicable).
- API keys use pay‑per‑token billing.
Gateway: ports, “already running”, and remote mode
What port does the Gateway use?
gateway.port controls the single multiplexed port for WebSocket + HTTP (Control UI, hooks, etc.).
Precedence:
Why does clawdbot daemon status say Runtime: running but RPC probe: failed?
Because “running” is the supervisor’s view (launchd/systemd/schtasks). The RPC probe is the CLI actually connecting to the gateway WebSocket and calling status.
Use clawdbot daemon status and trust these lines:
Probe target:(the URL the probe actually used)Listening:(what’s actually bound on the port)Last gateway error:(common root cause when the process is alive but the port isn’t listening)
Why does clawdbot daemon status show Config (cli) and Config (daemon) different?
You’re editing one config file while the daemon is running another (often a --profile / CLAWDBOT_STATE_DIR mismatch).
Fix:
--profile / environment you want the daemon to use.
What does “another gateway instance is already listening” mean?
Clawdbot enforces a runtime lock by binding the WebSocket listener immediately on startup (defaultws://127.0.0.1:18789). If the bind fails with EADDRINUSE, it throws GatewayLockError indicating another instance is already listening.
Fix: stop the other instance, free the port, or run with clawdbot gateway --port <port>.
How do I run Clawdbot in remote mode (client connects to a Gateway elsewhere)?
Setgateway.mode: "remote" and point to a remote WebSocket URL, optionally with a token/password:
clawdbot gatewayonly starts whengateway.modeislocal(or you pass the override flag).- The macOS app watches the config file and switches modes live when these values change.
The Control UI says “unauthorized” (or keeps reconnecting). What now?
Your gateway is running with auth enabled (gateway.auth.*), but the UI is not sending the matching token/password.
Facts (from code):
- The Control UI stores the token in browser localStorage key
clawdbot.control.settings.v1. - The UI can import
?token=...(and/or?password=...) once, then strips it from the URL.
- Set
gateway.auth.token(orCLAWDBOT_GATEWAY_TOKEN) on the gateway host. - In the Control UI settings, paste the same token (or refresh with a one-time
?token=...link).
I set gateway.bind: "tailnet" but it can’t bind / nothing listens
tailnet bind picks a Tailscale IP from your network interfaces (100.64.0.0/10). If the machine isn’t on Tailscale (or the interface is down), there’s nothing to bind to.
Fix:
- Start Tailscale on that host (so it has a 100.x address), or
- Switch to
gateway.bind: "loopback"/"lan".
Can I run multiple Gateways on the same host?
Yes, but you must isolate:CLAWDBOT_CONFIG_PATH(per‑instance config)CLAWDBOT_STATE_DIR(per‑instance state)agent.workspace(workspace isolation)gateway.port(unique ports)
--dev and --profile <name> that shift state dirs and ports.
Logging and debugging
Where are logs?
File logs (structured):logging.file. File log level is controlled by logging.level. Console verbosity is controlled by --verbose and logging.consoleLevel.
Fastest log tail:
- macOS:
$CLAWDBOT_STATE_DIR/logs/gateway.logandgateway.err.log(default:~/.clawdbot/logs/...; profiles use~/.clawdbot-<profile>/logs/...) - Linux:
journalctl --user -u clawdbot-gateway.service -n 200 --no-pager - Windows:
schtasks /Query /TN "Clawdbot Gateway" /V /FO LIST
How do I start/stop/restart the Gateway daemon?
Use the daemon helpers:clawdbot gateway --force can reclaim the port. See Gateway.
What’s the fastest way to get more details when something fails?
Start the Gateway with--verbose to get more console detail. Then inspect the log file for provider auth, model routing, and RPC errors.
Media & attachments
My skill generated an image/PDF, but nothing was sent
Outbound attachments from the agent must include aMEDIA:<path-or-url> line (on its own line). See Clawdbot assistant setup and Agent send.
CLI sending:
Security and access control
Is it safe to expose Clawdbot to inbound DMs?
Treat inbound DMs as untrusted input. Defaults are designed to reduce risk:- Default behavior on DM‑capable providers is pairing:
- Unknown senders receive a pairing code; the bot does not process their message.
- Approve with:
clawdbot pairing approve --provider <provider> <code>
- Opening DMs publicly requires explicit opt‑in (
dmPolicy: "open"and allowlist"*").
clawdbot doctor to surface risky DM policies.
Chat commands, aborting tasks, and “it won’t stop”
How do I stop/cancel a running task?
Send any of these as a standalone message (no slash):/). Inline text like hello /status is ignored.
Why does it feel like the bot “ignores” rapid‑fire messages?
Queue mode controls how new messages interact with an in‑flight run. Use/queue to change modes:
steer— new messages redirect the current taskfollowup— run messages one at a timecollect— batch messages and reply once (default)steer-backlog— steer now, then process backloginterrupt— abort current run and start fresh
debounce:2s cap:25 drop:summarize for followup modes.
Common troubleshooting
“All models failed” — what should I check first?
- Credentials present for the provider(s) being tried (auth profiles + env vars).
- Model routing: confirm
agent.model.primaryand fallbacks are models you can access. - Gateway logs in
/tmp/clawdbot/…for the exact provider error. /model statusto see current configured models + shorthands.
I’m running on my personal WhatsApp number — why is self-chat weird?
Enable self-chat mode and allowlist your own number:WhatsApp logged me out. How do I re‑auth?
Run the login command again and scan the QR code:Build errors on main — what’s the standard fix path?
git pull origin main && pnpm installpnpm clawdbot doctor- Check GitHub issues or Discord
- Temporary workaround: check out an older commit
Answer the exact question from the screenshot/chat log
Q: “What’s the default model for Anthropic with an API key?” A: In Clawdbot, credentials and model selection are separate. SettingANTHROPIC_API_KEY (or storing an Anthropic API key in auth profiles) enables authentication, but the actual default model is whatever you configure in agent.model.primary (for example, anthropic/claude-sonnet-4-5 or anthropic/claude-opus-4-5). If you see No credentials found for profile "anthropic:default", it means the Gateway couldn’t find Anthropic credentials in the expected auth-profiles.json for the agent that’s running.
Still stuck? Ask in Discord or open a GitHub discussion.