Skip to content

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

Add instructions for cleaning up old version plugins. (#843)

AutoCoderb994bdbba28b
diff --git a/examples/openclaw-plugin/INSTALL-ZH.md b/examples/openclaw-plugin/INSTALL-ZH.md
index 75cd28c2e..115c767a8 100644
--- a/examples/openclaw-plugin/INSTALL-ZH.md
+++ b/examples/openclaw-plugin/INSTALL-ZH.md
@@ -31,6 +31,13 @@
- 插件 2.0 与旧版插件/旧版配置不兼容,需避免旧版和新版插件同时存在。
+#### 方式 A:下载并执行旧版插件清理脚本 (推荐)
+```bash
+curl -O https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/upgrade_scripts/cleanup-memory-openviking.sh
+bash cleanup-memory-openviking.sh
+```
+
+#### 方式 B:手动执行命令清理旧版本插件配置
1. 停止 OpenClaw gateway:
```bash
@@ -49,9 +56,9 @@ mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memo
编辑 `~/.openclaw/openclaw.json`,删除 `plugins.allow` 中的 `"memory-openviking"`,删除 `plugins.entries.memory-openviking`,并将 `plugins.slots.memory` 改为 `"none"`,将 `plugins.load.paths`中旧版本 `memory-openviking` 插件路径修改为`openviking`。
-4. 参考下面方式A或者安装方式B的操作步骤,安装新版插件
+按照上述方式清理完成旧版插件配置后,参考下面安装方式A或者安装方式B的操作步骤,安装新版插件;
-5. 保留并迁移旧版本运行参数到新版本配置(新版本默认可用,旧版本参数按需迁移):
+保留并迁移旧版本运行参数到新版本配置(新版本默认可用,旧版本参数按需迁移):
如果旧版本原来使用的是 `plugins.entries.memory-openviking.config`,请将第二步备份的openclaw配置文件中的 `mode`、`configPath`、`port`、`baseUrl`、`apiKey`、`agentId` 等参数按需迁移到新版 `plugins.entries.openviking.config`。
diff --git a/examples/openclaw-plugin/INSTALL.md b/examples/openclaw-plugin/INSTALL.md
index e7cf5751d..bb619f3af 100644
--- a/examples/openclaw-plugin/INSTALL.md
+++ b/examples/openclaw-plugin/INSTALL.md
@@ -24,8 +24,20 @@ Provide long-term memory capabilities for [OpenClaw](https://github.com/openclaw
### Prerequisite Steps for Upgrading from Legacy `memory-openviking` to New `openviking`
-If the current environment already has the legacy `memory-openviking` plugin installed, complete the following prerequisite steps before installing the new version. Plugin 2.0 is not backward-compatible with the legacy plugin/configuration, so do not keep both versions active at the same time.
+- If the current environment already has the legacy `memory-openviking` plugin installed, complete the following prerequisite steps before installing the new version. Plugin 2.0 is not backward-compatible with the legacy plugin/configuration, so do not keep both versions active at the same time.
+- If you have never installed the legacy plugin before, you can skip this section and go straight to installation.
+
+- Plugin 2.0 is not backward-compatible with the legacy plugin/configuration, so do not keep both versions active at the same time.
+
+#### Method A: Download and Run the Legacy Plugin Cleanup Script (Recommended)
+
+```bash
+curl -fsSLO https://raw.githubusercontent.com/volcengine/OpenViking/main/examples/openclaw-plugin/upgrade_scripts/cleanup-memory-openviking.sh
+bash cleanup-memory-openviking.sh
+```
+
+#### Method B: Manually Clean Up the Legacy Plugin Configuration
1. Stop the OpenClaw gateway:
```bash
@@ -44,12 +56,14 @@ mv ~/.openclaw/extensions/memory-openviking ~/.openclaw/disabled-extensions/memo
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. Install the new plugin by following Method A or Method B below.
+After cleaning up the legacy plugin configuration using either approach above, install the new plugin by following Method A or Method B below.
-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):
+Preserve and migrate legacy runtime settings into the new configuration if needed (the new version works with defaults; legacy parameters are optional to migrate):
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`.
+Run the prerequisite steps above only if they apply to your environment. Once finished, continue with the Plugin 2.0 installation flow. For now, we do not recommend direct natural-language installation; the npm one-click installer is the preferred path.
+
### Method A: npm Installation (Recommended, Cross-platform)
```bash
@@ -429,4 +443,4 @@ python3 -m pip uninstall openviking -y && rm -rf ~/.openviking
**See also:** [INSTALL-ZH.md](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL-ZH.md) (Chinese) · [INSTALL-AGENT.md](https://github.com/volcengine/OpenViking/blob/main/examples/openclaw-plugin/INSTALL-AGENT.md) (Agent Install Guide)
----
+---
\ No newline at end of file