openclaw/docs
openclaw/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(sync): mirror docs from openclaw/openclaw@a780151fd1

Browse Source
This commit is contained in:
openclaw-docs-sync[bot] 2026-04-15 10:47:21 +00:00
parent e9171cfbe8
commit d3541ac5dd
10 changed files with 91 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.openclaw-sync/source.json
View File

@ -1,5 +1,5 @@
{
"repository": "openclaw/openclaw",
"sha": "f09a4d9ba07d5af00e9dc50587e6b2285069c15c",
"syncedAt": "2026-04-15T10:42:17.494Z"
"sha": "a780151fd1aaabf1f576e21af45aaa0fb84659a2",
"syncedAt": "2026-04-15T10:47:20.831Z"
}

4
docs/.i18n/glossary.zh-CN.json
View File

@ -83,6 +83,10 @@
"source": "Diffs",
"target": "Diffs"
},
{
"source": "Dreaming",
"target": "Dreaming"
},
{
"source": "Capability Cookbook",
"target": "能力扩展手册"

2
docs/cli/memory.md
View File

@ -121,7 +121,7 @@ openclaw memory rem-harness [--agent <id>] [--include-promoted] [--json]
- `--include-promoted`: include already promoted deep candidates.
- `--json`: print JSON output.
## Dreaming (experimental)
## Dreaming
Dreaming is the background memory consolidation system with three cooperative
phases: **light** (sort/stage short-term material), **deep** (promote durable

6
docs/concepts/dreaming.md
View File

@ -1,5 +1,5 @@
---
title: "Dreaming (experimental)"
title: "Dreaming"
summary: "Background memory consolidation with light, deep, and REM phases plus a Dream Diary"
read_when:
- You want memory promotion to run automatically
@ -7,7 +7,7 @@ read_when:
- You want to tune consolidation without polluting MEMORY.md
---
# Dreaming (experimental)
# Dreaming
Dreaming is the background memory consolidation system in `memory-core`.
It helps OpenClaw move strong short-term signals into durable memory while
@ -215,7 +215,7 @@ All settings live under `plugins.entries.memory-core.config.dreaming`.
Phase policy, thresholds, and storage behavior are internal implementation
details (not user-facing config).
See [Memory configuration reference](/reference/memory-config#dreaming-experimental)
See [Memory configuration reference](/reference/memory-config#dreaming)
for the full key list.
## Dreams UI

47
docs/concepts/experimental-features.md Normal file
View File

@ -0,0 +1,47 @@
---
title: "Experimental Features"
summary: "What experimental flags mean in OpenClaw and which ones are currently documented"
read_when:
- You see an `.experimental` config key and want to know whether it is stable
- You want to try preview runtime features without confusing them with normal defaults
- You want one place to find the currently documented experimental flags
---
# Experimental features
Experimental features in OpenClaw are **opt-in preview surfaces**. They are
behind explicit flags because they still need real-world mileage before they
deserve a stable default or a long-lived public contract.
Treat them differently from normal config:
- Keep them **off by default** unless the related doc tells you to try one.
- Expect **shape and behavior to change** faster than stable config.
- Prefer the stable path first when one already exists.
- If you are rolling OpenClaw out broadly, test experimental flags in a smaller
environment before baking them into a shared baseline.
## Currently documented flags
| Surface | Key | Use it when | More |
| ------------------------ | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| Local model runtime | `agents.defaults.experimental.localModelLean` | A smaller or stricter local backend chokes on OpenClaw's full default tool surface | [Local Models](/gateway/local-models) |
| Memory search | `agents.defaults.memorySearch.experimental.sessionMemory` | You want `memory_search` to index prior session transcripts and accept the extra storage/indexing cost | [Memory configuration reference](/reference/memory-config#session-memory-search-experimental) |
| Structured planning tool | `tools.experimental.planTool` | You want the structured `update_plan` tool exposed for multi-step work tracking in compatible runtimes and UIs | [Gateway configuration reference](/gateway/configuration-reference#toolsexperimental) |
## Local model lean mode
`agents.defaults.experimental.localModelLean: true` is a pressure-release valve
for weaker local-model setups. It trims heavyweight default tools like
`browser`, `cron`, and `message` so the prompt shape is smaller and less brittle
for small-context or stricter OpenAI-compatible backends.
That is intentionally **not** the normal path. If your backend handles the full
runtime cleanly, leave this off.
## Experimental does not mean hidden
If a feature is experimental, OpenClaw should say so plainly in docs and in the
config path itself. What it should **not** do is smuggle preview behavior into a
stable-looking default knob and pretend that is normal. That's how config
surfaces get messy.

8
docs/concepts/memory.md
View File

@ -20,7 +20,7 @@ Your agent has three memory-related files:
decisions. Loaded at the start of every DM session.
- **`memory/YYYY-MM-DD.md`** -- daily notes. Running context and observations.
Today and yesterday's notes are loaded automatically.
- **`DREAMS.md`** (experimental, optional) -- Dream Diary and dreaming sweep
- **`DREAMS.md`** (optional) -- Dream Diary and dreaming sweep
summaries for human review, including grounded historical backfill entries.
These files live in the agent workspace (default `~/.openclaw/workspace`).
@ -114,7 +114,7 @@ important facts in the conversation that are not yet written to a file, they
will be saved automatically before the summary happens.
</Tip>
## Dreaming (experimental)
## Dreaming
Dreaming is an optional background consolidation pass for memory. It collects
short-term signals, scores candidates, and promotes only qualified items into
@ -131,7 +131,7 @@ It is designed to keep long-term memory high signal:
for human review.
For phase behavior, scoring signals, and Dream Diary details, see
[Dreaming (experimental)](/concepts/dreaming).
[Dreaming](/concepts/dreaming).
## Grounded backfill and live promotion
@ -184,7 +184,7 @@ openclaw memory index --force # Rebuild the index
- [Memory Wiki](/plugins/memory-wiki) -- compiled knowledge vault and wiki-native tools
- [Memory Search](/concepts/memory-search) -- search pipeline, providers, and
tuning
- [Dreaming (experimental)](/concepts/dreaming) -- background promotion
- [Dreaming](/concepts/dreaming) -- background promotion
from short-term recall to long-term memory
- [Memory configuration reference](/reference/memory-config) -- all config knobs
- [Compaction](/concepts/compaction) -- how compaction interacts with memory

39
docs/docs.json
View File

@ -1072,7 +1072,8 @@
"concepts/agent-workspace",
"concepts/soul",
"concepts/oauth",
"start/bootstrapping"
"start/bootstrapping",
"concepts/experimental-features"
]
},
{
@ -2453,7 +2454,8 @@
"ja-JP/concepts/agent-workspace",
"ja-JP/concepts/soul",
"ja-JP/concepts/oauth",
"ja-JP/start/bootstrapping"
"ja-JP/start/bootstrapping",
"ja-JP/concepts/experimental-features"
]
},
{
@ -3219,7 +3221,8 @@
"es/concepts/agent-workspace",
"es/concepts/soul",
"es/concepts/oauth",
"es/start/bootstrapping"
"es/start/bootstrapping",
"es/concepts/experimental-features"
]
},
{
@ -3985,7 +3988,8 @@
"pt-BR/concepts/agent-workspace",
"pt-BR/concepts/soul",
"pt-BR/concepts/oauth",
"pt-BR/start/bootstrapping"
"pt-BR/start/bootstrapping",
"pt-BR/concepts/experimental-features"
]
},
{
@ -4751,7 +4755,8 @@
"ko/concepts/agent-workspace",
"ko/concepts/soul",
"ko/concepts/oauth",
"ko/start/bootstrapping"
"ko/start/bootstrapping",
"ko/concepts/experimental-features"
]
},
{
@ -5517,7 +5522,8 @@
"de/concepts/agent-workspace",
"de/concepts/soul",
"de/concepts/oauth",
"de/start/bootstrapping"
"de/start/bootstrapping",
"de/concepts/experimental-features"
]
},
{
@ -6283,7 +6289,8 @@
"fr/concepts/agent-workspace",
"fr/concepts/soul",
"fr/concepts/oauth",
"fr/start/bootstrapping"
"fr/start/bootstrapping",
"fr/concepts/experimental-features"
]
},
{
@ -7049,7 +7056,8 @@
"ar/concepts/agent-workspace",
"ar/concepts/soul",
"ar/concepts/oauth",
"ar/start/bootstrapping"
"ar/start/bootstrapping",
"ar/concepts/experimental-features"
]
},
{
@ -7815,7 +7823,8 @@
"it/concepts/agent-workspace",
"it/concepts/soul",
"it/concepts/oauth",
"it/start/bootstrapping"
"it/start/bootstrapping",
"it/concepts/experimental-features"
]
},
{
@ -8581,7 +8590,8 @@
"tr/concepts/agent-workspace",
"tr/concepts/soul",
"tr/concepts/oauth",
"tr/start/bootstrapping"
"tr/start/bootstrapping",
"tr/concepts/experimental-features"
]
},
{
@ -9347,7 +9357,8 @@
"uk/concepts/agent-workspace",
"uk/concepts/soul",
"uk/concepts/oauth",
"uk/start/bootstrapping"
"uk/start/bootstrapping",
"uk/concepts/experimental-features"
]
},
{
@ -10113,7 +10124,8 @@
"id/concepts/agent-workspace",
"id/concepts/soul",
"id/concepts/oauth",
"id/start/bootstrapping"
"id/start/bootstrapping",
"id/concepts/experimental-features"
]
},
{
@ -10879,7 +10891,8 @@
"pl/concepts/agent-workspace",
"pl/concepts/soul",
"pl/concepts/oauth",
"pl/start/bootstrapping"
"pl/start/bootstrapping",
"pl/concepts/experimental-features"
]
},
{

2
docs/gateway/configuration-reference.md
View File

@ -2764,7 +2764,7 @@ See [Local Models](/gateway/local-models). TL;DR: run a large local model via LM
- `plugins.entries.xai.config.xSearch`: xAI X Search (Grok web search) settings.
- `enabled`: enable the X Search provider.
- `model`: Grok model to use for search (e.g. `"grok-4-1-fast"`).
- `plugins.entries.memory-core.config.dreaming`: memory dreaming (experimental) settings. See [Dreaming](/concepts/dreaming) for phases and thresholds.
- `plugins.entries.memory-core.config.dreaming`: memory dreaming settings. See [Dreaming](/concepts/dreaming) for phases and thresholds.
- `enabled`: master dreaming switch (default `false`).
- `frequency`: cron cadence for each full dreaming sweep (`"0 3 * * *"` by default).
- phase policy and thresholds are implementation details (not user-facing config keys).

3
docs/gateway/local-models.md
View File

@ -167,7 +167,8 @@ Compatibility notes for stricter OpenAI-compatible backends:
OpenClaw agent turns, first try
`agents.defaults.experimental.localModelLean: true` to drop heavyweight
default tools like `browser`, `cron`, and `message`; this is an experimental
flag, not a stable default-mode setting. If that still fails, try
flag, not a stable default-mode setting. See
[Experimental Features](/concepts/experimental-features). If that still fails, try
`models.providers.<provider>.models[].compat.supportsTools: false`.
- If the backend still fails only on larger OpenClaw runs, the remaining issue
is usually upstream model/server capacity or a backend bug, not OpenClaw's

2
docs/reference/memory-config.md
View File

@ -479,7 +479,7 @@ Default is DM-only. `match.keyPrefix` matches the normalized session key;
---
## Dreaming (experimental)
## Dreaming
Dreaming is configured under `plugins.entries.memory-core.config.dreaming`,
not under `agents.defaults.memorySearch`.