Files
openclaw/docs/start/openclaw.md

216 lines
7.1 KiB
Markdown
Raw Normal View History

---
2026-01-30 03:15:10 +01:00
summary: "End-to-end guide for running OpenClaw as a personal assistant with safety cautions"
read_when:
- Onboarding a new assistant instance
- Reviewing safety/permission implications
title: "Personal Assistant Setup"
---
2026-01-31 21:13:13 +09:00
2026-01-30 03:15:10 +01:00
# Building a personal assistant with OpenClaw
2026-01-30 03:15:10 +01:00
OpenClaw is a WhatsApp + Telegram + Discord + iMessage gateway for **Pi** agents. Plugins add Mattermost. This guide is the "personal assistant" setup: one dedicated WhatsApp number that behaves like your always-on agent.
2025-12-13 13:25:49 +00:00
## ⚠️ Safety first
2025-12-13 13:25:49 +00:00
Youre putting an agent in a position to:
2026-01-31 21:13:13 +09:00
2025-12-13 13:25:49 +00:00
- run commands on your machine (depending on your Pi tool setup)
- read/write files in your workspace
- send messages back out via WhatsApp/Telegram/Discord/Mattermost (plugin)
2025-12-13 13:25:49 +00:00
Start conservative:
2026-01-31 21:13:13 +09:00
- Always set `channels.whatsapp.allowFrom` (never run open-to-the-world on your personal Mac).
2025-12-13 13:25:49 +00:00
- Use a dedicated WhatsApp number for the assistant.
- Heartbeats now default to every 30 minutes. Disable until you trust the setup by setting `agents.defaults.heartbeat.every: "0m"`.
2025-12-13 13:25:49 +00:00
## Prerequisites
- OpenClaw installed and onboarded — see [Getting Started](/start/getting-started) if you haven't done this yet
2025-12-13 13:25:49 +00:00
- A second phone number (SIM/eSIM/prepaid) for the assistant
2025-12-13 13:25:49 +00:00
## The two-phone setup (recommended)
2025-12-13 13:25:49 +00:00
You want this:
```mermaid
flowchart TB
A["<b>Your Phone (personal)<br></b><br>Your WhatsApp<br>+1-555-YOU"] -- message --> B["<b>Second Phone (assistant)<br></b><br>Assistant WA<br>+1-555-ASSIST"]
B -- linked via QR --> C["<b>Your Mac (openclaw)<br></b><br>Pi agent"]
```
2026-01-30 03:15:10 +01:00
If you link your personal WhatsApp to OpenClaw, every message to you becomes “agent input”. Thats rarely what you want.
2025-12-13 13:25:49 +00:00
## 5-minute quick start
2026-01-31 21:13:13 +09:00
1. Pair WhatsApp Web (shows QR; scan with the assistant phone):
2025-12-13 13:25:49 +00:00
```bash
2026-01-30 03:15:10 +01:00
openclaw channels login
```
2. Start the Gateway (leave it running):
2025-12-13 13:25:49 +00:00
```bash
2026-01-30 03:15:10 +01:00
openclaw gateway --port 18789
```
3. Put a minimal config in `~/.openclaw/openclaw.json`:
```json5
{
2026-01-31 21:13:13 +09:00
channels: { whatsapp: { allowFrom: ["+15555550123"] } },
}
```
2025-12-13 13:25:49 +00:00
Now message the assistant number from your allowlisted phone.
When onboarding finishes, we auto-open the dashboard and print a clean (non-tokenized) link. If it prompts for auth, paste the token from `gateway.auth.token` into Control UI settings. To reopen later: `openclaw dashboard`.
2026-01-12 19:08:29 +00:00
## Give the agent a workspace (AGENTS)
2026-01-30 03:15:10 +01:00
OpenClaw reads operating instructions and “memory” from its workspace directory.
By default, OpenClaw uses `~/.openclaw/workspace` as the agent workspace, and will create it (plus starter `AGENTS.md`, `SOUL.md`, `TOOLS.md`, `IDENTITY.md`, `USER.md`, `HEARTBEAT.md`) automatically on setup/first agent run. `BOOTSTRAP.md` is only created when the workspace is brand new (it should not come back after you delete it). `MEMORY.md` is optional (not auto-created); when present, it is loaded for normal sessions. Subagent sessions only inject `AGENTS.md` and `TOOLS.md`.
2026-01-30 03:15:10 +01:00
Tip: treat this folder like OpenClaws “memory” and make it a git repo (ideally private) so your `AGENTS.md` + memory files are backed up. If git is installed, brand-new workspaces are auto-initialized.
```bash
2026-01-30 03:15:10 +01:00
openclaw setup
```
2026-01-10 14:51:21 -06:00
Full workspace layout + backup guide: [Agent workspace](/concepts/agent-workspace)
2026-01-12 05:28:17 +00:00
Memory workflow: [Memory](/concepts/memory)
2026-01-07 00:04:03 +01:00
Optional: choose a different workspace with `agents.defaults.workspace` (supports `~`).
```json5
{
agent: {
2026-01-31 21:13:13 +09:00
workspace: "~/.openclaw/workspace",
},
}
```
If you already ship your own workspace files from a repo, you can disable bootstrap file creation entirely:
```json5
{
agent: {
2026-01-31 21:13:13 +09:00
skipBootstrap: true,
},
}
```
2025-12-13 13:25:49 +00:00
## The config that turns it into “an assistant”
2026-01-30 03:15:10 +01:00
OpenClaw defaults to a good assistant setup, but youll usually want to tune:
2026-01-31 21:13:13 +09:00
2025-12-17 11:29:12 +01:00
- persona/instructions in `SOUL.md`
2025-12-13 13:25:49 +00:00
- thinking defaults (if desired)
- heartbeats (once you trust it)
2025-12-13 13:25:49 +00:00
Example:
```json5
{
2025-12-13 13:25:49 +00:00
logging: { level: "info" },
agent: {
model: "anthropic/claude-opus-4-6",
2026-01-30 03:15:10 +01:00
workspace: "~/.openclaw/workspace",
thinkingDefault: "high",
timeoutSeconds: 1800,
// Start with 0; enable later.
2026-01-31 21:13:13 +09:00
heartbeat: { every: "0m" },
},
channels: {
whatsapp: {
allowFrom: ["+15555550123"],
groups: {
2026-01-31 21:13:13 +09:00
"*": { requireMention: true },
},
},
},
routing: {
2025-12-13 13:25:49 +00:00
groupChat: {
2026-01-31 21:13:13 +09:00
mentionPatterns: ["@openclaw", "openclaw"],
},
},
session: {
scope: "per-sender",
resetTriggers: ["/new", "/reset"],
reset: {
mode: "daily",
atHour: 4,
2026-01-31 21:13:13 +09:00
idleMinutes: 10080,
},
},
}
```
2025-12-13 13:25:49 +00:00
## Sessions and memory
2026-01-30 03:15:10 +01:00
- Session files: `~/.openclaw/agents/<agentId>/sessions/{{SessionId}}.jsonl`
- Session metadata (token usage, last route, etc): `~/.openclaw/agents/<agentId>/sessions/sessions.json` (legacy: `~/.openclaw/sessions/sessions.json`)
2025-12-22 20:36:34 +01:00
- `/new` or `/reset` starts a fresh session for that chat (configurable via `resetTriggers`). If sent alone, the agent replies with a short hello to confirm the reset.
- `/compact [instructions]` compacts the session context and reports the remaining context budget.
2025-12-13 13:25:49 +00:00
## Heartbeats (proactive mode)
2026-01-30 03:15:10 +01:00
By default, OpenClaw runs a heartbeat every 30 minutes with the prompt:
2026-01-16 00:46:07 +00:00
`Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.`
Set `agents.defaults.heartbeat.every: "0m"` to disable.
2026-01-30 03:15:10 +01:00
- If `HEARTBEAT.md` exists but is effectively empty (only blank lines and markdown headers like `# Heading`), OpenClaw skips the heartbeat run to save API calls.
- If the file is missing, the heartbeat still runs and the model decides what to do.
2026-01-30 03:15:10 +01:00
- If the agent replies with `HEARTBEAT_OK` (optionally with short padding; see `agents.defaults.heartbeat.ackMaxChars`), OpenClaw suppresses outbound delivery for that heartbeat.
- Heartbeats run full agent turns — shorter intervals burn more tokens.
```json5
{
agent: {
2026-01-31 21:13:13 +09:00
heartbeat: { every: "30m" },
},
}
```
2025-12-13 13:25:49 +00:00
## Media in and out
2025-12-13 13:25:49 +00:00
Inbound attachments (images/audio/docs) can be surfaced to your command via templates:
2026-01-31 21:13:13 +09:00
2025-12-13 13:25:49 +00:00
- `{{MediaPath}}` (local temp file path)
- `{{MediaUrl}}` (pseudo-URL)
- `{{Transcript}}` (if audio transcription is enabled)
2025-12-13 13:25:49 +00:00
Outbound attachments from the agent: include `MEDIA:<path-or-url>` on its own line (no spaces). Example:
```
2025-12-13 13:25:49 +00:00
Heres the screenshot.
MEDIA:https://example.com/screenshot.png
```
2026-01-30 03:15:10 +01:00
OpenClaw extracts these and sends them as media alongside the text.
2025-12-13 13:25:49 +00:00
## Operations checklist
```bash
2026-01-30 03:15:10 +01:00
openclaw status # local status (creds, sessions, queued events)
openclaw status --all # full diagnosis (read-only, pasteable)
openclaw status --deep # adds gateway health probes (Telegram + Discord)
openclaw health --json # gateway health snapshot (WS)
```
2026-01-30 03:15:10 +01:00
Logs live under `/tmp/openclaw/` (default: `openclaw-YYYY-MM-DD.log`).
2025-12-13 13:25:49 +00:00
## Next steps
2026-01-07 02:04:02 +01:00
- WebChat: [WebChat](/web/webchat)
2026-01-06 23:32:12 +00:00
- Gateway ops: [Gateway runbook](/gateway)
2026-01-07 02:04:02 +01:00
- Cron + wakeups: [Cron jobs](/automation/cron-jobs)
2026-01-30 03:15:10 +01:00
- macOS menu bar companion: [OpenClaw macOS app](/platforms/macos)
2026-01-07 02:04:02 +01:00
- iOS node app: [iOS app](/platforms/ios)
- Android node app: [Android app](/platforms/android)
- Windows status: [Windows (WSL2)](/platforms/windows)
- Linux status: [Linux app](/platforms/linux)
- Security: [Security](/gateway/security)