mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-28 15:27:14 +00:00
* refactor: extract agent core package Introduce packages/agent-core as the OpenClaw-owned home for reusable agent loop, harness, session, prompt, and runtime dependency contracts. * refactor: extract shared llm runtime Move provider model registries, stream wrappers, OAuth helpers, and LLM utilities into src/llm with plugin-sdk barrels instead of depending on the old embedded runtime layout. * refactor: remove pi runtime internals Rename remaining Pi-shaped agent surfaces to OpenClaw agent runtime names, delete obsolete Pi docs and package graph checks, and add the third-party notice for incorporated code. * refactor: tighten agent session runtime Make agent-core/runtime dependencies explicit, consolidate compaction and session transcript helpers, and move model/session helpers behind OpenClaw-owned contracts. * refactor: remove static model and pi auth paths Drop static model catalogs and Pi auth bridges, move model/provider facts to manifest-owned runtime contracts, and harden internal embedded-agent utilities. * refactor: remove legacy provider compat paths * docs: remove agent parity notes * fix: skip provider wildcard metadata parsing * refactor: share session extension sdk loading * refactor: inline acpx proxy error formatter * refactor: fold edit recovery into edit tool * fix: accept extension batch separator * test: align startup provider plugin expectations * fix: restore provider-scoped release discovery * test: align static asset packaging expectations * fix: run static provider catalogs during scoped discovery * fix: add provider entry catalogs for scoped live discovery * fix: load lightweight provider catalog entries * fix: refresh provider-scoped plugin metadata * fix: keep provider catalog entries on release live path * fix: keep static manifest models in release live checks * fix: harden release model discovery * fix: reduce OpenAI live cache probe reasoning * fix: disable OpenAI cache probe reasoning * ci: extend OpenAI gateway live timeout * fix: extend live gateway model budget * fix: stabilize release validation regressions * fix: honor provider aliases in model rows * fix: stabilize release validation lanes * fix: stabilize release memory qa * ci: stabilize release validation lanes * ci: prefer ipv4 for live docker node calls * fix: restore shared tool-call stream wrapper * ci: remove legacy pi test shard alias * fix: clean up embedded agent test drift * fix: stabilize runtime alias status * fix: clean up embedded agent ci drift * fix: restore release ci invariants * fix: clean up post-rebase runtime drift * fix: restore release ci checks * fix: restore release ci after rebase * fix: remove stale pi runtime path * test: align compaction runtime expectations * test: update plugin prerelease expectations * fix: handle claude live tool approvals * fix: stabilize release validation gates * fix: finish agent runtime import * test: finish post-rebase agent runtime mocks * fix: keep codex compaction native * fix: stabilize codex app-server hook tests * test: isolate codex diagnostic active run * test: remove codex diagnostic completion race # Conflicts: # extensions/codex/src/app-server/run-attempt.test.ts * ci: fix full release manifest performance run id * refactor: narrow llm plugin sdk boundary * chore: drop generated google boundary stamps * fix: repair rebase fallout * fix: clean up rebased runtime references * fix: decode codex jwt payloads as base64url * fix: preserve shipped pi runtime alias * fix: add scoped sdk virtual modules * fix: decode llm codex oauth jwt as base64url * fix: avoid stale vertex adc negative cache * fix: harden tool arg decoding and codeql path * fix: keep vertex adc negative checks live * refactor: consolidate codex jwt and edit helpers * fix: await codex oauth node runtime imports * fix: preserve sdk tool and notice contracts * fix: preserve shipped compat config boundaries * fix: align codex oauth callback host * fix: terminate agent-core loop streams on failure * fix: keep codex oauth callback alive during fallback * ci: include session tools in critical codeql scans * fix: keep Cloudflare Anthropic provider auth header * docs: redirect legacy pi runtime pages * fix: honor bundled web provider compat discovery * fix: protect session output spill files * fix: keep legacy agent dir env blocked * fix: contain auto-discovered skill symlinks * fix: harden agent core sdk proxy surfaces * fix: restore approval reaction sdk compat * fix: keep live docker runs bounded * fix: keep codex oauth redirect host aligned * fix: resolve post-rebase agent runtime drift * fix: redact anthropic oauth parse failures * fix: preserve responses strict tool shaping * fix: repair agent runtime rebase cleanup * docs: redirect retired parity pages * fix: bound auto-discovered resources to roots * fix: repair post-rebase agent test drift * fix: preserve bundled provider allowlist migration * fix: preserve manifest-owned provider aliases * fix: declare photon image dependency * fix: keep provider headers out of proxy body * fix: preserve shipped env aliases * fix: refresh control ui i18n generated state * fix: quote read fallback paths * fix: preview edits through configured backend * test: satisfy core test typecheck * fix: preserve ZAI usage auth fallback * test: repair codex diagnostic test * fix: repair agent runtime rebase drift * test: finish embedded runner import rename * fix: repair agent runtime rebase integrations * test: align compaction oauth fallback expectations * fix: allow sdk-auth session models * fix: update doctor tool schema import * fix: preserve bedrock plugin region * fix: stream harmony-like prose immediately * ci: include session runtime in codeql shards * fix: repair latest rebase integrations * fix: honor explicit codex websocket transport * fix: keep openai-compatible credentials provider-scoped * fix: refresh sdk api baseline after rebase * fix: route cli runtime aliases through openclaw harness * test: rename stale harness mock expectation * test: rename embedded agent overflow calls * test: clean embedded auth test wording * test: use openclaw stream types in deepinfra cache test * fix: refresh sdk api baseline on latest main * fix: honor bundled discovery compat allowlists * fix: refresh sdk api baseline after latest rebase * fix: remove stale rebase imports * test: rename stale model catalog mock * test: mock renamed doctor runtime modules * fix: map canonical kimi env auth * fix: use internal model registry in bench script * fix: migrate deepinfra provider catalog entry * fix: enforce builtin tool suppression * fix: route compaction auth and proxy payloads safely * refactor: prune unused llm registry leftovers * test: update codex hooks session import * test: fix model picker ci coverage * test: align model picker auth mock types
132 lines
5.8 KiB
Markdown
132 lines
5.8 KiB
Markdown
---
|
|
summary: "Default OpenClaw agent instructions and skills roster for the personal assistant setup"
|
|
title: "Default AGENTS.md"
|
|
read_when:
|
|
- Starting a new OpenClaw agent session
|
|
- Enabling or auditing default skills
|
|
---
|
|
|
|
## 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):
|
|
|
|
```bash
|
|
mkdir -p ~/.openclaw/workspace
|
|
```
|
|
|
|
2. Copy the default workspace templates into the workspace:
|
|
|
|
```bash
|
|
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
|
|
cp docs/reference/AGENTS.default.md ~/.openclaw/workspace/AGENTS.md
|
|
```
|
|
|
|
4. Optional: choose a different workspace by setting `agents.defaults.workspace` (supports `~`):
|
|
|
|
```json5
|
|
{
|
|
agents: { defaults: { workspace: "~/.openclaw/workspace" } },
|
|
}
|
|
```
|
|
|
|
## Safety defaults
|
|
|
|
- Don't dump directories or secrets into chat.
|
|
- Don't run destructive commands unless explicitly asked.
|
|
- Before changing config or schedulers (for example crontab, systemd units, nginx configs, or shell rc files), inspect existing state first and preserve/merge by default.
|
|
- Don't send partial/streaming replies to external messaging surfaces (only final replies).
|
|
|
|
## Session start (required)
|
|
|
|
- Read `SOUL.md`, `USER.md`, and today+yesterday in `memory/`.
|
|
- Read `MEMORY.md` when present.
|
|
- 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.
|
|
- Lowercase `memory.md` is legacy repair input only; do not keep both root files on purpose.
|
|
- On session start, read today + yesterday + `MEMORY.md` when present.
|
|
- Before writing memory files, read them first; write only concrete updates, never empty placeholders.
|
|
- Capture: decisions, preferences, constraints, open loops.
|
|
- Avoid secrets unless explicitly requested.
|
|
|
|
## Tools and 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
|
|
cd ~/.openclaw/workspace
|
|
git init
|
|
git add AGENTS.md
|
|
git commit -m "Add Clawd workspace"
|
|
# Optional: add a private remote + push
|
|
```
|
|
|
|
## What OpenClaw does
|
|
|
|
- Runs WhatsApp gateway + embedded OpenClaw 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.
|
|
- **oracle** - OpenAI-ready agent CLI with session replay and browser control.
|
|
- **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).
|
|
- **gog** - Google Suite CLI: Gmail, Calendar, Drive, Contacts.
|
|
- **spotify-player** - Terminal Spotify client to search/queue/control playback.
|
|
- **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.
|
|
- **blucli** - Play, group, and automate BluOS players from scripts.
|
|
- **OpenHue CLI** - Philips Hue lighting control for scenes and automations.
|
|
- **OpenAI Whisper** - Local speech-to-text for quick dictation and voicemail transcripts.
|
|
- **Gemini CLI** - Google Gemini models from the terminal for fast Q&A.
|
|
- **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.
|
|
- 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 don't rely on safe-area insets.
|
|
- 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).
|
|
|
|
## Related
|
|
|
|
- [Agent workspace](/concepts/agent-workspace)
|
|
- [Agent runtime](/concepts/agent)
|