Files
openclaw/docs/reference/AGENTS.default.md

125 lines
5.5 KiB
Markdown
Raw Permalink Normal View History

---
title: "Default AGENTS.md"
2026-01-30 03:15:10 +01:00
summary: "Default OpenClaw agent instructions and skills roster for the personal assistant setup"
read_when:
2026-01-30 03:15:10 +01:00
- Starting a new OpenClaw agent session
- Enabling or auditing default skills
---
2026-01-31 21:13:13 +09:00
2026-01-30 03:15:10 +01:00
# AGENTS.md — OpenClaw Personal Assistant (default)
2025-12-06 23:25:17 +01:00
## First run (recommended)
2026-01-30 03:15:10 +01:00
OpenClaw uses a dedicated workspace directory for the agent. Default: `~/.openclaw/workspace` (configurable via `agents.defaults.workspace`).
2026-01-31 21:13:13 +09:00
1. Create the workspace (if it doesnt already exist):
```bash
2026-01-30 03:15:10 +01:00
mkdir -p ~/.openclaw/workspace
```
2. Copy the default workspace templates into the workspace:
```bash
2026-01-30 03:15:10 +01:00
cp docs/reference/templates/AGENTS.md ~/.openclaw/workspace/AGENTS.md
cp docs/reference/templates/SOUL.md ~/.openclaw/workspace/SOUL.md
cp docs/reference/templates/TOOLS.md ~/.openclaw/workspace/TOOLS.md
```
3. Optional: if you want the personal assistant skill roster, replace AGENTS.md with this file:
```bash
2026-01-30 03:15:10 +01:00
cp docs/reference/AGENTS.default.md ~/.openclaw/workspace/AGENTS.md
```
4. Optional: choose a different workspace by setting `agents.defaults.workspace` (supports `~`):
```json5
{
2026-01-31 21:13:13 +09:00
agents: { defaults: { workspace: "~/.openclaw/workspace" } },
}
```
## Safety defaults
2026-01-31 21:13:13 +09:00
- Dont dump directories or secrets into chat.
- Dont run destructive commands unless explicitly asked.
- Dont send partial/streaming replies to external messaging surfaces (only final replies).
## Session start (required)
2026-01-31 21:13:13 +09:00
- Read `SOUL.md`, `USER.md`, `memory.md`, and today+yesterday in `memory/`.
- Do it before responding.
## Soul (required)
2026-01-31 21:13:13 +09:00
- `SOUL.md` defines identity, tone, and boundaries. Keep it current.
- If you change `SOUL.md`, tell the user.
- You are a fresh instance each session; continuity lives in these files.
## Shared spaces (recommended)
2026-01-31 21:13:13 +09:00
- Youre not the users voice; be careful in group chats or public channels.
- Dont share private data, contact info, or internal notes.
## Memory system (recommended)
2026-01-31 21:13:13 +09:00
- Daily log: `memory/YYYY-MM-DD.md` (create `memory/` if needed).
- Long-term memory: `memory.md` for durable facts, preferences, and decisions.
- On session start, read today + yesterday + `memory.md` if present.
- Capture: decisions, preferences, constraints, open loops.
- Avoid secrets unless explicitly requested.
## Tools & skills
2026-01-31 21:13:13 +09:00
- Tools live in skills; follow each skills `SKILL.md` when you need it.
- Keep environment-specific notes in `TOOLS.md` (Notes for Skills).
## Backup tip (recommended)
2026-01-31 21:13:13 +09:00
If you treat this workspace as Clawds “memory”, make it a git repo (ideally private) so `AGENTS.md` and your memory files are backed up.
```bash
2026-01-30 03:15:10 +01:00
cd ~/.openclaw/workspace
git init
git add AGENTS.md
git commit -m "Add Clawd workspace"
# Optional: add a private remote + push
```
2026-01-30 03:15:10 +01:00
## What OpenClaw Does
2026-01-31 21:13:13 +09:00
- Runs WhatsApp gateway + Pi coding agent so the assistant can read/write chats, fetch context, and run skills via the host Mac.
2026-01-30 03:15:10 +01:00
- macOS app manages permissions (screen recording, notifications, microphone) and exposes the `openclaw` CLI via its bundled binary.
2026-01-13 07:15:57 +00:00
- Direct chats collapse into the agent's `main` session by default; groups stay isolated as `agent:<agentId>:<channel>:group:<id>` (rooms/channels: `agent:<agentId>:<channel>:channel:<id>`); heartbeats keep background tasks alive.
2025-12-06 23:25:17 +01:00
## Core Skills (enable in Settings → Skills)
2026-01-31 21:13:13 +09:00
- **mcporter** — Tool server runtime/CLI for managing external skill backends.
2025-12-06 23:25:17 +01:00
- **Peekaboo** — Fast macOS screenshots with optional AI vision analysis.
- **camsnap** — Capture frames, clips, or motion alerts from RTSP/ONVIF security cams.
- **oracle** — OpenAI-ready agent CLI with session replay and browser control.
2025-12-14 01:54:10 +00:00
- **eightctl** — Control your sleep, from the terminal.
- **imsg** — Send, read, stream iMessage & SMS.
- **wacli** — WhatsApp CLI: sync, search, send.
- **discord** — Discord actions: react, stickers, polls. Use `user:<id>` or `channel:<id>` targets (bare numeric ids are ambiguous).
2025-12-14 01:54:10 +00:00
- **gog** — Google Suite CLI: Gmail, Calendar, Drive, Contacts.
2025-12-06 23:25:17 +01:00
- **spotify-player** — Terminal Spotify client to search/queue/control playback.
2025-12-14 01:54:10 +00:00
- **sag** — ElevenLabs speech with mac-style say UX; streams to speakers by default.
- **Sonos CLI** — Control Sonos speakers (discover/status/playback/volume/grouping) from scripts.
2025-12-17 20:39:34 +01:00
- **blucli** — Play, group, and automate BluOS players from scripts.
2025-12-06 23:25:17 +01:00
- **OpenHue CLI** — Philips Hue lighting control for scenes and automations.
2025-12-14 01:56:18 +00:00
- **OpenAI Whisper** — Local speech-to-text for quick dictation and voicemail transcripts.
2025-12-06 23:25:17 +01:00
- **Gemini CLI** — Google Gemini models from the terminal for fast Q&A.
- **agent-tools** — Utility toolkit for automations and helper scripts.
2025-12-06 23:25:17 +01:00
## Usage Notes
2026-01-31 21:13:13 +09:00
2026-01-30 03:15:10 +01:00
- Prefer the `openclaw` CLI for scripting; mac app handles permissions.
- Run installs from the Skills tab; it hides the button if a binary is already present.
2025-12-06 23:25:17 +01:00
- Keep heartbeats enabled so the assistant can schedule reminders, monitor inboxes, and trigger camera captures.
2025-12-21 03:14:16 +01:00
- Canvas UI runs full-screen with native overlays. Avoid placing critical controls in the top-left/top-right/bottom edges; add explicit gutters in the layout and dont rely on safe-area insets.
2026-01-30 03:15:10 +01:00
- For browser-driven verification, use `openclaw browser` (tabs/status/screenshot) with the OpenClaw-managed Chrome profile.
- For DOM inspection, use `openclaw browser eval|query|dom|snapshot` (and `--json`/`--out` when you need machine output).
- For interactions, use `openclaw browser click|type|hover|drag|select|upload|press|wait|navigate|back|evaluate|run` (click/type require snapshot refs; use `evaluate` for CSS selectors).