Files
openclaw/docs/configuration.md

198 lines
4.9 KiB
Markdown
Raw Normal View History

---
summary: "All configuration options for ~/.clawdis/clawdis.json with examples"
read_when:
- Adding or modifying config fields
---
2025-12-13 13:25:49 +00:00
<!-- {% raw %} -->
# Configuration 🔧
2025-12-13 13:25:49 +00:00
CLAWDIS reads an optional **JSON5** config from `~/.clawdis/clawdis.json` (comments + trailing commas allowed).
2025-12-17 11:29:12 +01:00
If the file is missing, CLAWDIS uses safe-ish defaults (embedded Pi agent + per-sender sessions + workspace `~/clawd`). You usually only need a config to:
2025-12-13 13:25:49 +00:00
- restrict who can trigger the bot (`inbound.allowFrom`)
- tune group mention behavior (`inbound.groupChat`)
2025-12-17 11:29:12 +01:00
- set the agents workspace (`inbound.workspace`)
- tune the embedded agent (`inbound.agent`) and session behavior (`inbound.session`)
- set the agents identity (`identity`)
2025-12-13 13:25:49 +00:00
## Minimal config (recommended starting point)
2025-12-13 13:25:49 +00:00
```json5
{
2025-12-13 13:25:49 +00:00
inbound: {
2025-12-17 11:29:12 +01:00
allowFrom: ["+15555550123"],
workspace: "~/clawd"
}
}
```
2025-12-13 13:25:49 +00:00
## Common options
### `identity`
Optional agent identity used for defaults and UX. This is written by the macOS onboarding assistant.
If set, CLAWDIS derives defaults (only when you havent set them explicitly):
- `inbound.responsePrefix` from `identity.emoji`
- `inbound.groupChat.mentionPatterns` from `identity.name` (so “@Samantha” works in groups)
```json5
{
identity: { name: "Samantha", theme: "helpful sloth", emoji: "🦥" }
}
```
### `logging`
2025-12-13 13:25:49 +00:00
- Default log file: `/tmp/clawdis/clawdis-YYYY-MM-DD.log`
- If you want a stable path, set `logging.file` to `/tmp/clawdis/clawdis.log`.
```json5
{
logging: { level: "info", file: "/tmp/clawdis/clawdis.log" }
}
```
### `inbound.allowFrom`
2025-12-13 13:25:49 +00:00
Allowlist of E.164 phone numbers that may trigger auto-replies.
2025-12-13 13:25:49 +00:00
```json5
{
inbound: { allowFrom: ["+15555550123", "+447700900123"] }
}
```
### `inbound.groupChat`
2025-12-13 13:25:49 +00:00
Group messages default to **require mention** (either metadata mention or regex patterns).
2025-12-13 13:25:49 +00:00
```json5
{
inbound: {
groupChat: {
requireMention: true,
mentionPatterns: ["@clawd", "clawdbot", "clawd"],
historyLimit: 50
}
}
}
```
2025-12-17 11:29:12 +01:00
### `inbound.workspace`
2025-12-17 11:29:12 +01:00
Sets the **single global workspace directory** used by the agent for file operations.
2025-12-17 11:29:12 +01:00
Default: `~/clawd`.
2025-12-17 11:29:12 +01:00
```json5
{
inbound: { workspace: "~/clawd" }
}
```
2025-12-17 11:29:12 +01:00
### `inbound.agent`
Controls the embedded agent runtime (provider/model/thinking/verbose/timeouts).
```json5
{
2025-12-13 13:25:49 +00:00
inbound: {
2025-12-17 11:29:12 +01:00
workspace: "~/clawd",
agent: {
provider: "anthropic",
model: "claude-opus-4-5",
thinkingDefault: "low",
verboseDefault: "off",
timeoutSeconds: 600,
mediaMaxMb: 5,
2025-12-13 13:25:49 +00:00
heartbeatMinutes: 30,
2025-12-17 11:29:12 +01:00
contextTokens: 200000
2025-12-13 13:25:49 +00:00
}
}
}
```
2025-12-17 11:29:12 +01:00
### `inbound.session`
Controls session scoping, idle expiry, reset triggers, and where the session store is written.
```json5
{
inbound: {
session: {
scope: "per-sender",
idleMinutes: 60,
resetTriggers: ["/new"],
store: "~/.clawdis/sessions/sessions.json",
mainKey: "main"
}
}
}
```
### `browser` (clawd-managed Chrome)
Clawdis can start a **dedicated, isolated** Chrome/Chromium instance for clawd and expose a small loopback control server.
Defaults:
- enabled: `true`
- control URL: `http://127.0.0.1:18791` (CDP uses `18792`)
- profile color: `#FF4500` (lobster-orange)
- Note: the control server is started by the running gateway (Clawdis.app menubar, or `clawdis gateway`).
```json5
{
browser: {
enabled: true,
controlUrl: "http://127.0.0.1:18791",
color: "#FF4500",
// Advanced:
// headless: false,
// attachOnly: false,
}
}
```
2025-12-13 13:25:49 +00:00
## Template variables
2025-12-17 11:29:12 +01:00
Template placeholders are expanded in `inbound.transcribeAudio.command` (and any future templated command fields).
| Variable | Description |
|----------|-------------|
2025-12-13 13:25:49 +00:00
| `{{Body}}` | Full inbound message body |
| `{{BodyStripped}}` | Body with group mentions stripped (best default for agents) |
| `{{From}}` | Sender identifier (E.164 for WhatsApp; may differ per surface) |
| `{{To}}` | Destination identifier |
| `{{MessageSid}}` | Provider message id (when available) |
| `{{SessionId}}` | Current session UUID |
2025-12-13 13:25:49 +00:00
| `{{IsNewSession}}` | `"true"` when a new session was created |
| `{{MediaUrl}}` | Inbound media pseudo-URL (if present) |
| `{{MediaPath}}` | Local media path (if downloaded) |
| `{{MediaType}}` | Media type (image/audio/document/…) |
| `{{Transcript}}` | Audio transcript (when enabled) |
| `{{ChatType}}` | `"direct"` or `"group"` |
| `{{GroupSubject}}` | Group subject (best effort) |
| `{{GroupMembers}}` | Group members preview (best effort) |
| `{{SenderName}}` | Sender display name (best effort) |
| `{{SenderE164}}` | Sender phone number (best effort) |
| `{{Surface}}` | Surface hint (whatsapp|telegram|webchat|…) |
## Cron (Gateway scheduler)
Cron is a Gateway-owned scheduler for wakeups and scheduled jobs. See [Cron + wakeups](./cron.md) for the full RFC and CLI examples.
2025-12-13 13:25:49 +00:00
```json5
{
cron: {
enabled: true,
maxConcurrentRuns: 2
}
}
```
---
2025-12-17 11:29:12 +01:00
*Next: [Agent Runtime](./agent.md)* 🦞
2025-12-13 13:25:49 +00:00
<!-- {% endraw %} -->