2026-01-15 06:12:54 +00:00
---
2026-01-30 03:15:10 +01:00
summary: "CLI reference for `openclaw memory` (status/index/search)"
2026-01-15 06:12:54 +00:00
read_when:
- You want to index or search semantic memory
- You’ re debugging memory availability or indexing
2026-01-31 16:04:03 -05:00
title: "memory"
2026-01-15 06:12:54 +00:00
---
2026-01-30 03:15:10 +01:00
# `openclaw memory`
2026-01-15 06:12:54 +00:00
2026-01-18 15:29:43 +00:00
Manage semantic memory indexing and search.
Provided by the active memory plugin (default: `memory-core` ; set `plugins.slots.memory = "none"` to disable).
2026-01-15 06:12:54 +00:00
Related:
2026-01-31 21:13:13 +09:00
2026-01-15 06:12:54 +00:00
- Memory concept: [Memory ](/concepts/memory )
2026-02-07 15:40:35 -05:00
- Plugins: [Plugins ](/tools/plugin )
2026-01-15 06:12:54 +00:00
## Examples
```bash
2026-01-30 03:15:10 +01:00
openclaw memory status
openclaw memory status --deep
openclaw memory status --deep --index
openclaw memory status --deep --index --verbose
openclaw memory index
openclaw memory index --verbose
openclaw memory search "release checklist"
2026-02-25 02:40:05 +00:00
openclaw memory search --query "release checklist"
2026-01-30 03:15:10 +01:00
openclaw memory status --agent main
openclaw memory index --agent main --verbose
2026-01-15 06:12:54 +00:00
```
2026-01-18 01:24:16 +00:00
## Options
2026-01-18 15:29:43 +00:00
Common:
- `--agent <id>` : scope to a single agent (default: all configured agents).
- `--verbose` : emit detailed logs during probes and indexing.
2026-02-25 02:40:05 +00:00
`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.
2026-01-18 15:29:43 +00:00
Notes:
2026-01-31 21:13:13 +09:00
2026-01-18 15:29:43 +00:00
- `memory status --deep` probes vector + embedding availability.
- `memory status --deep --index` runs a reindex if the store is dirty.
- `memory index --verbose` prints per-phase details (provider, model, sources, batch activity).
2026-01-28 21:49:38 -05:00
- `memory status` includes any extra paths configured via `memorySearch.extraPaths` .
2026-03-02 20:58:20 -06:00
- 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.