mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-12 09:41:11 +00:00
215 lines
5.3 KiB
Markdown
215 lines
5.3 KiB
Markdown
---
|
|
summary: "CLI reference for `openclaw wiki` (memory-wiki vault status, search, compile, lint, apply, bridge, and Obsidian helpers)"
|
|
read_when:
|
|
- You want to use the memory-wiki CLI
|
|
- You are documenting or changing `openclaw wiki`
|
|
title: "wiki"
|
|
---
|
|
|
|
# `openclaw wiki`
|
|
|
|
Inspect and maintain the `memory-wiki` vault.
|
|
|
|
Provided by the bundled `memory-wiki` plugin.
|
|
|
|
Related:
|
|
|
|
- [Memory Wiki plugin](/plugins/memory-wiki)
|
|
- [Memory Overview](/concepts/memory)
|
|
- [CLI: memory](/cli/memory)
|
|
|
|
## What it is for
|
|
|
|
Use `openclaw wiki` when you want a compiled knowledge vault with:
|
|
|
|
- wiki-native search and page reads
|
|
- provenance-rich syntheses
|
|
- contradiction and freshness reports
|
|
- bridge imports from the active memory plugin
|
|
- optional Obsidian CLI helpers
|
|
|
|
## Common commands
|
|
|
|
```bash
|
|
openclaw wiki status
|
|
openclaw wiki doctor
|
|
openclaw wiki init
|
|
openclaw wiki ingest ./notes/alpha.md
|
|
openclaw wiki compile
|
|
openclaw wiki lint
|
|
openclaw wiki search "alpha"
|
|
openclaw wiki get entity.alpha --from 1 --lines 80
|
|
|
|
openclaw wiki apply synthesis "Alpha Summary" \
|
|
--body "Short synthesis body" \
|
|
--source-id source.alpha
|
|
|
|
openclaw wiki apply metadata entity.alpha \
|
|
--source-id source.alpha \
|
|
--status review \
|
|
--question "Still active?"
|
|
|
|
openclaw wiki bridge import
|
|
openclaw wiki unsafe-local import
|
|
|
|
openclaw wiki obsidian status
|
|
openclaw wiki obsidian search "alpha"
|
|
openclaw wiki obsidian open syntheses/alpha-summary.md
|
|
openclaw wiki obsidian command workspace:quick-switcher
|
|
openclaw wiki obsidian daily
|
|
```
|
|
|
|
## Commands
|
|
|
|
### `wiki status`
|
|
|
|
Inspect current vault mode, health, and Obsidian CLI availability.
|
|
|
|
Use this first when you are unsure whether the vault is initialized, bridge mode
|
|
is healthy, or Obsidian integration is available.
|
|
|
|
### `wiki doctor`
|
|
|
|
Run wiki health checks and surface configuration or vault problems.
|
|
|
|
Typical issues include:
|
|
|
|
- bridge mode enabled without public memory artifacts
|
|
- invalid or missing vault layout
|
|
- missing external Obsidian CLI when Obsidian mode is expected
|
|
|
|
### `wiki init`
|
|
|
|
Create the wiki vault layout and starter pages.
|
|
|
|
This initializes the root structure, including top-level indexes and cache
|
|
directories.
|
|
|
|
### `wiki ingest <path-or-url>`
|
|
|
|
Import content into the wiki source layer.
|
|
|
|
Notes:
|
|
|
|
- URL ingest is controlled by `ingest.allowUrlIngest`
|
|
- imported source pages keep provenance in frontmatter
|
|
- auto-compile can run after ingest when enabled
|
|
|
|
### `wiki compile`
|
|
|
|
Rebuild indexes, related blocks, dashboards, and compiled digests.
|
|
|
|
This writes stable machine-facing artifacts under:
|
|
|
|
- `.openclaw-wiki/cache/agent-digest.json`
|
|
- `.openclaw-wiki/cache/claims.jsonl`
|
|
|
|
If `render.createDashboards` is enabled, compile also refreshes report pages.
|
|
|
|
### `wiki lint`
|
|
|
|
Lint the vault and report:
|
|
|
|
- structural issues
|
|
- provenance gaps
|
|
- contradictions
|
|
- open questions
|
|
- low-confidence pages/claims
|
|
- stale pages/claims
|
|
|
|
Run this after meaningful wiki updates.
|
|
|
|
### `wiki search <query>`
|
|
|
|
Search wiki content.
|
|
|
|
Behavior depends on config:
|
|
|
|
- `search.backend`: `shared` or `local`
|
|
- `search.corpus`: `wiki`, `memory`, or `all`
|
|
|
|
Use `wiki search` when you want wiki-specific ranking or provenance details.
|
|
For one broad shared recall pass, prefer `openclaw memory search` when the
|
|
active memory plugin exposes shared search.
|
|
|
|
### `wiki get <lookup>`
|
|
|
|
Read a wiki page by id or relative path.
|
|
|
|
Examples:
|
|
|
|
```bash
|
|
openclaw wiki get entity.alpha
|
|
openclaw wiki get syntheses/alpha-summary.md --from 1 --lines 80
|
|
```
|
|
|
|
### `wiki apply`
|
|
|
|
Apply narrow mutations without freeform page surgery.
|
|
|
|
Supported flows include:
|
|
|
|
- create/update a synthesis page
|
|
- update page metadata
|
|
- attach source ids
|
|
- add questions
|
|
- add contradictions
|
|
- update confidence/status
|
|
- write structured claims
|
|
|
|
This command exists so the wiki can evolve safely without manually editing
|
|
managed blocks.
|
|
|
|
### `wiki bridge import`
|
|
|
|
Import public memory artifacts from the active memory plugin into bridge-backed
|
|
source pages.
|
|
|
|
Use this in `bridge` mode when you want the latest exported memory artifacts
|
|
pulled into the wiki vault.
|
|
|
|
### `wiki unsafe-local import`
|
|
|
|
Import from explicitly configured local paths in `unsafe-local` mode.
|
|
|
|
This is intentionally experimental and same-machine only.
|
|
|
|
### `wiki obsidian ...`
|
|
|
|
Obsidian helper commands for vaults running in Obsidian-friendly mode.
|
|
|
|
Subcommands:
|
|
|
|
- `status`
|
|
- `search`
|
|
- `open`
|
|
- `command`
|
|
- `daily`
|
|
|
|
These require the official `obsidian` CLI on `PATH` when
|
|
`obsidian.useOfficialCli` is enabled.
|
|
|
|
## Practical usage guidance
|
|
|
|
- Use `wiki search` + `wiki get` when provenance and page identity matter.
|
|
- Use `wiki apply` instead of hand-editing managed generated sections.
|
|
- Use `wiki lint` before trusting contradictory or low-confidence content.
|
|
- Use `wiki compile` after bulk imports or source changes when you want fresh
|
|
dashboards and compiled digests immediately.
|
|
- Use `wiki bridge import` when bridge mode depends on newly exported memory
|
|
artifacts.
|
|
|
|
## Configuration tie-ins
|
|
|
|
`openclaw wiki` behavior is shaped by:
|
|
|
|
- `plugins.entries.memory-wiki.config.vaultMode`
|
|
- `plugins.entries.memory-wiki.config.search.backend`
|
|
- `plugins.entries.memory-wiki.config.search.corpus`
|
|
- `plugins.entries.memory-wiki.config.bridge.*`
|
|
- `plugins.entries.memory-wiki.config.obsidian.*`
|
|
- `plugins.entries.memory-wiki.config.render.*`
|
|
- `plugins.entries.memory-wiki.config.context.includeCompiledDigestPrompt`
|
|
|
|
See [Memory Wiki plugin](/plugins/memory-wiki) for the full config model.
|