mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 14:40:43 +00:00
docs: typography hygiene + 1 in-body H1 removal across 6 pages
Replaced 84 typography characters (curly quotes, apostrophes, em/en dashes, non-breaking hyphens) with ASCII equivalents per docs/CLAUDE.md heading and content hygiene rules. - docs/gateway/tools-invoke-http-api.md: 14 chars; removed the duplicate '# Tools Invoke (HTTP)' H1 (Mintlify renders title from frontmatter; the in-body H1 with parens produced a brittle anchor). - docs/tools/browser-control.md: 14 chars - docs/security/formal-verification.md: 14 chars - docs/gateway/configuration-reference.md: 14 chars - docs/concepts/agent.md: 14 chars - docs/channels/qa-channel.md: 14 chars
This commit is contained in:
@@ -5,14 +5,14 @@ read_when:
|
||||
title: "Agent runtime"
|
||||
---
|
||||
|
||||
OpenClaw runs a **single embedded agent runtime** — one agent process per
|
||||
OpenClaw runs a **single embedded agent runtime** - one agent process per
|
||||
Gateway, with its own workspace, bootstrap files, and session store. This page
|
||||
covers that runtime contract: what the workspace must contain, which files get
|
||||
injected, and how sessions bootstrap against it.
|
||||
|
||||
## Workspace (required)
|
||||
|
||||
OpenClaw uses a single agent workspace directory (`agents.defaults.workspace`) as the agent’s **only** working directory (`cwd`) for tools and context.
|
||||
OpenClaw uses a single agent workspace directory (`agents.defaults.workspace`) as the agent's **only** working directory (`cwd`) for tools and context.
|
||||
|
||||
Recommended: use `openclaw setup` to create `~/.openclaw/openclaw.json` if missing and initialize the workspace files.
|
||||
|
||||
@@ -26,18 +26,18 @@ per-session workspaces under `agents.defaults.sandbox.workspaceRoot` (see
|
||||
|
||||
Inside `agents.defaults.workspace`, OpenClaw expects these user-editable files:
|
||||
|
||||
- `AGENTS.md` — operating instructions + “memory”
|
||||
- `SOUL.md` — persona, boundaries, tone
|
||||
- `TOOLS.md` — user-maintained tool notes (e.g. `imsg`, `sag`, conventions)
|
||||
- `BOOTSTRAP.md` — one-time first-run ritual (deleted after completion)
|
||||
- `IDENTITY.md` — agent name/vibe/emoji
|
||||
- `USER.md` — user profile + preferred address
|
||||
- `AGENTS.md` - operating instructions + "memory"
|
||||
- `SOUL.md` - persona, boundaries, tone
|
||||
- `TOOLS.md` - user-maintained tool notes (e.g. `imsg`, `sag`, conventions)
|
||||
- `BOOTSTRAP.md` - one-time first-run ritual (deleted after completion)
|
||||
- `IDENTITY.md` - agent name/vibe/emoji
|
||||
- `USER.md` - user profile + preferred address
|
||||
|
||||
On the first turn of a new session, OpenClaw injects the contents of these files into the system prompt's Project Context.
|
||||
|
||||
Blank files are skipped. Large files are trimmed and truncated with a marker so prompts stay lean (read the file for full content).
|
||||
|
||||
If a file is missing, OpenClaw injects a single “missing file” marker line (and `openclaw setup` will create a safe default template).
|
||||
If a file is missing, OpenClaw injects a single "missing file" marker line (and `openclaw setup` will create a safe default template).
|
||||
|
||||
`BOOTSTRAP.md` is only created for a **brand new workspace** (no other bootstrap files present). While it is pending, OpenClaw keeps it in Project Context and adds system-prompt bootstrap guidance for the initial ritual instead of copying it into the user message. If you delete it after completing the ritual, it should not be recreated on later restarts.
|
||||
|
||||
@@ -51,7 +51,7 @@ To disable bootstrap file creation entirely (for pre-seeded workspaces), set:
|
||||
|
||||
Core tools (read/exec/edit/write and related system tools) are always available,
|
||||
subject to tool policy. `apply_patch` is optional and gated by
|
||||
`tools.exec.applyPatch`. `TOOLS.md` does **not** control which tools exist; it’s
|
||||
`tools.exec.applyPatch`. `TOOLS.md` does **not** control which tools exist; it's
|
||||
guidance for how _you_ want them used.
|
||||
|
||||
## Skills
|
||||
@@ -100,7 +100,7 @@ Block streaming sends completed assistant blocks as soon as they finish; it is
|
||||
**off by default** (`agents.defaults.blockStreamingDefault: "off"`).
|
||||
Tune the boundary via `agents.defaults.blockStreamingBreak` (`text_end` vs `message_end`; defaults to text_end).
|
||||
Control soft block chunking with `agents.defaults.blockStreamingChunk` (defaults to
|
||||
800–1200 chars; prefers paragraph breaks, then newlines; sentences last).
|
||||
800-1200 chars; prefers paragraph breaks, then newlines; sentences last).
|
||||
Coalesce streamed chunks with `agents.defaults.blockStreamingCoalesce` to reduce
|
||||
single-line spam (idle-based merging before send). Non-Telegram channels require
|
||||
explicit `*.blockStreaming: true` to enable block replies.
|
||||
|
||||
Reference in New Issue
Block a user