mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-06 14:51:08 +00:00
4c1022c73b
* memory-core: add dreaming promotion flow with weighted thresholds * docs(memory): mark dreaming as experimental * memory-core: address dreaming promotion review feedback * memory-core: harden short-term promotion concurrency * acpx: make abort-process test timer-independent * memory-core: simplify dreaming config with mode presets * memory-core: add /dreaming command and tighten recall tracking * ui: add Dreams tab with sleeping lobster animation Adds a new Dreams tab to the gateway UI under the Agent group. The tab is gated behind the memory-core dreaming config — it only appears in the sidebar when dreaming.mode is not 'off'. Features: - Sleeping vector lobster with breathing animation - Floating Z's, twinkling starfield, moon glow - Rotating dream phrase bubble (17 whimsical phrases) - Memory stats bar (short-term, long-term, promoted) - Active/idle visual states - 14 unit tests * plugins: fix --json stdout pollution from hook runner log The hook runner initialization message was using log.info() which writes to stdout via console.log, breaking JSON.parse() in the Docker smoke test for 'openclaw plugins list --json'. Downgrade to log.debug() so it only appears when debugging is enabled. * ui: keep Dreams tab visible when dreaming is off * tests: fix contracts and stabilize extension shards * memory-core: harden dreaming recall persistence and locking * fix: stabilize dreaming PR gates (#60569) (thanks @vignesh07) * test: fix rebase drift in telegram and plugin guards
122 lines
5.2 KiB
Markdown
122 lines
5.2 KiB
Markdown
---
|
||
summary: "CLI reference for `openclaw memory` (status/index/search/promote)"
|
||
read_when:
|
||
- You want to index or search semantic memory
|
||
- You’re debugging memory availability or indexing
|
||
- You want to promote recalled short-term memory into `MEMORY.md`
|
||
title: "memory"
|
||
---
|
||
|
||
# `openclaw memory`
|
||
|
||
Manage semantic memory indexing and search.
|
||
Provided by the active memory plugin (default: `memory-core`; set `plugins.slots.memory = "none"` to disable).
|
||
|
||
Related:
|
||
|
||
- Memory concept: [Memory](/concepts/memory)
|
||
- Plugins: [Plugins](/tools/plugin)
|
||
|
||
## Examples
|
||
|
||
```bash
|
||
openclaw memory status
|
||
openclaw memory status --deep
|
||
openclaw memory index --force
|
||
openclaw memory search "meeting notes"
|
||
openclaw memory search --query "deployment" --max-results 20
|
||
openclaw memory promote --limit 10 --min-score 0.75
|
||
openclaw memory promote --apply
|
||
openclaw memory promote --json --min-recall-count 0 --min-unique-queries 0
|
||
openclaw memory status --json
|
||
openclaw memory status --deep --index
|
||
openclaw memory status --deep --index --verbose
|
||
openclaw memory status --agent main
|
||
openclaw memory index --agent main --verbose
|
||
```
|
||
|
||
## Options
|
||
|
||
`memory status` and `memory index`:
|
||
|
||
- `--agent <id>`: scope to a single agent. Without it, these commands run for each configured agent; if no agent list is configured, they fall back to the default agent.
|
||
- `--verbose`: emit detailed logs during probes and indexing.
|
||
|
||
`memory status`:
|
||
|
||
- `--deep`: probe vector + embedding availability.
|
||
- `--index`: run a reindex if the store is dirty (implies `--deep`).
|
||
- `--json`: print JSON output.
|
||
|
||
`memory index`:
|
||
|
||
- `--force`: force a full reindex.
|
||
|
||
`memory search`:
|
||
|
||
- Query input: pass either positional `[query]` or `--query <text>`.
|
||
- If both are provided, `--query` wins.
|
||
- If neither is provided, the command exits with an error.
|
||
- `--agent <id>`: scope to a single agent (default: the default agent).
|
||
- `--max-results <n>`: limit the number of results returned.
|
||
- `--min-score <n>`: filter out low-score matches.
|
||
- `--json`: print JSON results.
|
||
|
||
`memory promote`:
|
||
|
||
- Ranks short-term candidates from `memory/YYYY-MM-DD.md` using weighted recall signals (`frequency`, `relevance`, `query diversity`, `recency`).
|
||
- Uses recall events captured when `memory_search` returns daily-memory hits.
|
||
- Optional auto-dreaming mode: when `plugins.entries.memory-core.config.dreaming.mode` is `core`, `deep`, or `rem`, `memory-core` auto-manages a cron job that triggers promotion in the background (no manual `openclaw cron add` required).
|
||
- `--agent <id>`: scope to a single agent (default: the default agent).
|
||
- `--limit <n>`: max candidates to return/apply.
|
||
- `--min-score <n>`: minimum weighted promotion score.
|
||
- `--min-recall-count <n>`: minimum recall count required for a candidate.
|
||
- `--min-unique-queries <n>`: minimum distinct query count required for a candidate.
|
||
- `--apply`: append selected candidates into `MEMORY.md` and mark them promoted.
|
||
- `--include-promoted`: include already promoted candidates in output.
|
||
- `--json`: print JSON output.
|
||
|
||
## Dreaming (experimental)
|
||
|
||
Dreaming is the overnight reflection pass for memory. It is called "dreaming" because the system revisits what was recalled during the day and decides what is worth keeping long-term.
|
||
|
||
- It is opt-in and disabled by default.
|
||
- Enable it with `plugins.entries.memory-core.config.dreaming.mode`.
|
||
- You can toggle modes from chat with `/dreaming off|core|rem|deep`. Run `/dreaming` (or `/dreaming options`) to see what each mode does.
|
||
- When enabled, `memory-core` automatically creates and maintains a managed cron job.
|
||
- Set `dreaming.limit` to `0` if you want dreaming enabled but automatic promotion effectively paused.
|
||
- Ranking uses weighted signals: recall frequency, retrieval relevance, query diversity, and temporal recency (recent recalls decay over time).
|
||
- Promotion into `MEMORY.md` only happens when quality thresholds are met, so long-term memory stays high signal instead of collecting one-off details.
|
||
|
||
Default mode presets:
|
||
|
||
- `core`: daily at `0 3 * * *`, `minScore=0.75`, `minRecallCount=3`, `minUniqueQueries=2`
|
||
- `deep`: every 12 hours (`0 */12 * * *`), `minScore=0.8`, `minRecallCount=3`, `minUniqueQueries=3`
|
||
- `rem`: every 6 hours (`0 */6 * * *`), `minScore=0.85`, `minRecallCount=4`, `minUniqueQueries=3`
|
||
|
||
Example:
|
||
|
||
```json
|
||
{
|
||
"plugins": {
|
||
"entries": {
|
||
"memory-core": {
|
||
"config": {
|
||
"dreaming": {
|
||
"mode": "core"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
Notes:
|
||
|
||
- `memory index --verbose` prints per-phase details (provider, model, sources, batch activity).
|
||
- `memory status` includes any extra paths configured via `memorySearch.extraPaths`.
|
||
- If effectively active memory remote API key fields are configured as SecretRefs, the command resolves those values from the active gateway snapshot. If gateway is unavailable, the command fails fast.
|
||
- Gateway version skew note: this command path requires a gateway that supports `secrets.resolve`; older gateways return an unknown-method error.
|
||
- Dreaming cadence defaults to each mode's preset schedule. Override cadence with `plugins.entries.memory-core.config.dreaming.frequency` as a cron expression (for example `0 3 * * *`) and fine-tune with `timezone`, `limit`, `minScore`, `minRecallCount`, and `minUniqueQueries`.
|