Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

update docs for openclaw-plugin (#766)

AutoCoderc435b345bb34
diff --git a/examples/openclaw-plugin/INSTALL-ZH.md b/examples/openclaw-plugin/INSTALL-ZH.md
index edd50745b..3548337e9 100644
--- a/examples/openclaw-plugin/INSTALL-ZH.md
+++ b/examples/openclaw-plugin/INSTALL-ZH.md
@@ -40,18 +40,19 @@ openclaw gateway stop
```bash
cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.pre-openviking-upgrade.bak
-mkdir -p ~/.openclaw/disabled-extensions && mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memory-openviking-upgrade-backup
+mkdir -p ~/.openclaw/disabled-extensions
+mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memory-openviking-upgrade-backup
```
3. 修改 OpenClaw 配置,移除旧版本配置参数:
-编辑 `~/.openclaw/openclaw.json`,删除 `plugins.allow` 中的 `"memory-openviking"`,删除 `plugins.entries.memory-openviking`,并将 `plugins.slots.memory` 改为 `"none"`。
+编辑 `~/.openclaw/openclaw.json`,删除 `plugins.allow` 中的 `"memory-openviking"`,删除 `plugins.entries.memory-openviking`,并将 `plugins.slots.memory` 改为 `"none"`,删除 `plugins.load.paths`中旧版本 `memory-openviking` 插件路径。
-4. 保留并迁移旧版本运行参数到新版本配置:
+4. 参考下面方式A或者安装方式B的操作步骤,安装新版插件
-如果旧版本原来使用的是 `plugins.entries.memory-openviking.config`,请将其中的 `mode`、`configPath`、`port`、`baseUrl`、`apiKey`、`agentId` 按需迁移到新版 `plugins.entries.openviking.config`。
+5. 保留并迁移旧版本运行参数到新版本配置(新版本默认可用,旧版本参数按需迁移):
-完成以上前置操作后,再按下方任一方式安装新版插件。
+如果旧版本原来使用的是 `plugins.entries.memory-openviking.config`,请将第二步备份的openclaw配置文件中的 `mode`、`configPath`、`port`、`baseUrl`、`apiKey`、`agentId` 等参数按需迁移到新版 `plugins.entries.openviking.config`。
### 方式 A:npm 安装(推荐,全平台)
diff --git a/examples/openclaw-plugin/INSTALL.md b/examples/openclaw-plugin/INSTALL.md
index 0f840826e..5e1ae7506 100644
--- a/examples/openclaw-plugin/INSTALL.md
+++ b/examples/openclaw-plugin/INSTALL.md
@@ -42,18 +42,19 @@ openclaw gateway stop
```bash
cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.pre-openviking-upgrade.bak
-mkdir -p ~/.openclaw/disabled-extensions && mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memory-openviking-upgrade-backup
+mkdir -p ~/.openclaw/disabled-extensions
+mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memory-openviking-upgrade-backup
```
3. Update the OpenClaw configuration and remove legacy settings:
-Edit `~/.openclaw/openclaw.json`, remove `"memory-openviking"` from `plugins.allow`, remove `plugins.entries.memory-openviking`, and change `plugins.slots.memory` to `"none"`.
+Edit `~/.openclaw/openclaw.json`, remove `"memory-openviking"` from `plugins.allow`, remove `plugins.entries.memory-openviking`, change `plugins.slots.memory` to `"none"`, and remove the legacy `memory-openviking` plugin path from `plugins.load.paths`.
-4. Preserve and migrate legacy runtime settings into the new configuration:
+4. Install the new plugin by following Method A or Method B below.
-If the legacy plugin was using `plugins.entries.memory-openviking.config`, migrate `mode`, `configPath`, `port`, `baseUrl`, `apiKey`, and `agentId` into `plugins.entries.openviking.config` as needed.
+5. Preserve and migrate legacy runtime settings into the new configuration if needed (the new version works with defaults; legacy parameters are optional to migrate):
-After completing the prerequisite steps above, install the new plugin using either method below.
+If the legacy plugin was using `plugins.entries.memory-openviking.config`, migrate `mode`, `configPath`, `port`, `baseUrl`, `apiKey`, `agentId`, and any other needed parameters from the backup `openclaw.json` file created in Step 2 into `plugins.entries.openviking.config`.
### Method A: npm Installation (Recommended, Cross-platform)