Files
openclaw/docs/AGENTS.default.md

101 lines
4.5 KiB
Markdown
Raw Normal View History

---
summary: "Default Clawdis agent instructions and tool roster for the personal assistant setup"
read_when:
- Starting a new Clawdis agent session
- Enabling or auditing default tools
---
2025-12-06 23:25:17 +01:00
# AGENTS.md — Clawdis Personal Assistant (default)
## First run (recommended)
Clawdis uses a dedicated workspace directory for the agent. Default: `~/.clawdis/workspace`.
1) Create the workspace (if it doesnt already exist):
```bash
mkdir -p ~/.clawdis/workspace
```
2) Copy the default workspace templates into the workspace:
```bash
cp docs/templates/AGENTS.md ~/.clawdis/workspace/AGENTS.md
cp docs/templates/SOUL.md ~/.clawdis/workspace/SOUL.md
cp docs/templates/TOOLS.md ~/.clawdis/workspace/TOOLS.md
```
3) Optional: if you want the personal assistant tool roster, replace AGENTS.md with this file:
```bash
cp docs/AGENTS.default.md ~/.clawdis/workspace/AGENTS.md
```
4) Optional: choose a different workspace by setting `inbound.workspace` (supports `~`):
```json5
{
inbound: {
workspace: "~/clawd"
}
}
```
## Safety defaults
- 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).
## Daily memory (recommended)
- Keep a short daily log at `memory/YYYY-MM-DD.md` (create `memory/` if needed).
- On session start, read today + yesterday if present.
- Capture durable facts, preferences, and decisions; avoid secrets.
## Backup tip (recommended)
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
cd ~/.clawdis/workspace
git init
git add AGENTS.md
git commit -m "Add Clawd workspace"
# Optional: add a private remote + push
```
2025-12-06 23:25:17 +01:00
## What Clawdis Does
2025-12-13 13:25:49 +00:00
- Runs WhatsApp gateway + Pi coding agent so the assistant can read/write chats, fetch context, and run tools via the host Mac.
2025-12-06 23:25:17 +01:00
- macOS app manages permissions (screen recording, notifications, microphone) and exposes a CLI helper `clawdis-mac` for scripts.
- Direct chats collapse into the shared `main` session by default; groups stay isolated as `group:<jid>`; heartbeats keep background tasks alive.
2025-12-06 23:25:17 +01:00
## Core Tools (enable in Settings → Tools)
- **mcporter** — MCP runtime/CLI to list, call, and sync Model Context Protocol servers.
- **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
- **qmd** — Hybrid markdown search (BM25 + vectors + rerank) with an MCP server for agents.
- **eightctl** — Control your sleep, from the terminal.
- **imsg** — Send, read, stream iMessage & SMS.
- **wacli** — WhatsApp CLI: sync, search, send.
- **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.
- **bird** — X/Twitter CLI to tweet, reply, read threads, and search without a browser.
- **agent-tools** — Utility toolkit for automations and MCP-friendly scripts.
## MCP Servers (added via mcporter)
- **Gmail MCP** (`gmail`) — Search, read, and send Gmail messages.
- **Google Calendar MCP** (`google-calendar`) — List, create, and update events.
## Usage Notes
- Prefer the `clawdis-mac` CLI for scripting; mac app handles permissions.
- Run installs from the Tools tab; it hides the button if a tool is already present.
- For MCPs, mcporter writes to the home-scope config; re-run installs if you rotate tokens.
- Keep heartbeats enabled so the assistant can schedule reminders, monitor inboxes, and trigger camera captures.
- For browser-driven verification, use `clawdis browser` (tabs/status/screenshot) with the clawd-managed Chrome profile.
- For DOM inspection, use `clawdis browser eval|query|dom|snapshot` (and `--json`/`--out` when you need machine output).
- For interactions, use `clawdis browser click|type|hover|drag|select|upload|press|wait|navigate|back|evaluate|run`.