mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-25 03:04:29 -04:00
chore: Run pnpm format:fix.
This commit is contained in:
@@ -4,19 +4,20 @@ read_when:
|
||||
- Starting a new OpenClaw agent session
|
||||
- Enabling or auditing default skills
|
||||
---
|
||||
|
||||
# AGENTS.md — OpenClaw Personal Assistant (default)
|
||||
|
||||
## First run (recommended)
|
||||
|
||||
OpenClaw uses a dedicated workspace directory for the agent. Default: `~/.openclaw/workspace` (configurable via `agents.defaults.workspace`).
|
||||
|
||||
1) Create the workspace (if it doesn’t already exist):
|
||||
1. Create the workspace (if it doesn’t already exist):
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.openclaw/workspace
|
||||
```
|
||||
|
||||
2) Copy the default workspace templates into the workspace:
|
||||
2. Copy the default workspace templates into the workspace:
|
||||
|
||||
```bash
|
||||
cp docs/reference/templates/AGENTS.md ~/.openclaw/workspace/AGENTS.md
|
||||
@@ -24,39 +25,44 @@ 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:
|
||||
3. Optional: if you want the personal assistant skill roster, replace AGENTS.md with this file:
|
||||
|
||||
```bash
|
||||
cp docs/reference/AGENTS.default.md ~/.openclaw/workspace/AGENTS.md
|
||||
```
|
||||
|
||||
4) Optional: choose a different workspace by setting `agents.defaults.workspace` (supports `~`):
|
||||
4. Optional: choose a different workspace by setting `agents.defaults.workspace` (supports `~`):
|
||||
|
||||
```json5
|
||||
{
|
||||
agents: { defaults: { workspace: "~/.openclaw/workspace" } }
|
||||
agents: { defaults: { workspace: "~/.openclaw/workspace" } },
|
||||
}
|
||||
```
|
||||
|
||||
## Safety defaults
|
||||
|
||||
- Don’t dump directories or secrets into chat.
|
||||
- Don’t run destructive commands unless explicitly asked.
|
||||
- Don’t send partial/streaming replies to external messaging surfaces (only final replies).
|
||||
|
||||
## Session start (required)
|
||||
|
||||
- Read `SOUL.md`, `USER.md`, `memory.md`, and today+yesterday in `memory/`.
|
||||
- Do it before responding.
|
||||
|
||||
## Soul (required)
|
||||
|
||||
- `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)
|
||||
|
||||
- You’re not the user’s voice; be careful in group chats or public channels.
|
||||
- Don’t share private data, contact info, or internal notes.
|
||||
|
||||
## Memory system (recommended)
|
||||
|
||||
- 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.
|
||||
@@ -64,10 +70,12 @@ cp docs/reference/AGENTS.default.md ~/.openclaw/workspace/AGENTS.md
|
||||
- Avoid secrets unless explicitly requested.
|
||||
|
||||
## Tools & skills
|
||||
|
||||
- Tools live in skills; follow each skill’s `SKILL.md` when you need it.
|
||||
- Keep environment-specific notes in `TOOLS.md` (Notes for Skills).
|
||||
|
||||
## Backup tip (recommended)
|
||||
|
||||
If you treat this workspace as Clawd’s “memory”, make it a git repo (ideally private) so `AGENTS.md` and your memory files are backed up.
|
||||
|
||||
```bash
|
||||
@@ -79,11 +87,13 @@ git commit -m "Add Clawd workspace"
|
||||
```
|
||||
|
||||
## What OpenClaw Does
|
||||
|
||||
- Runs WhatsApp gateway + Pi coding agent so the assistant can read/write chats, fetch context, and run skills via the host Mac.
|
||||
- macOS app manages permissions (screen recording, notifications, microphone) and exposes the `openclaw` CLI via its bundled binary.
|
||||
- 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.
|
||||
|
||||
## Core Skills (enable in Settings → Skills)
|
||||
|
||||
- **mcporter** — Tool server runtime/CLI for managing external skill backends.
|
||||
- **Peekaboo** — Fast macOS screenshots with optional AI vision analysis.
|
||||
- **camsnap** — Capture frames, clips, or motion alerts from RTSP/ONVIF security cams.
|
||||
@@ -104,6 +114,7 @@ git commit -m "Add Clawd workspace"
|
||||
- **agent-tools** — Utility toolkit for automations and helper scripts.
|
||||
|
||||
## Usage Notes
|
||||
|
||||
- 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.
|
||||
- Keep heartbeats enabled so the assistant can schedule reminders, monitor inboxes, and trigger camera captures.
|
||||
|
||||
Reference in New Issue
Block a user