Skip to content

OpenClaw 插件

OpenClaw 添加长效记忆。安装完成后,OpenClaw 会自动记住对话中的重要信息,并在每次回复前召回相关上下文。

源码:examples/openclaw-plugin

前置条件

组件版本要求
Node.js>= 22
OpenClaw>= 2026.4.8

插件需要连接到一个正在运行的 OpenViking 服务——参见 部署指南

从旧版 memory-openviking 升级?

旧插件不兼容,请先清理:

bash
curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/examples/openclaw-plugin/upgrade_scripts/cleanup-memory-openviking.sh -o cleanup-memory-openviking.sh
bash cleanup-memory-openviking.sh

安装

bash
openclaw plugins install clawhub:@openviking/openclaw-plugin
openclaw openviking setup --base-url http://your-server:1933 --api-key sk-xxx --json
openclaw gateway restart

setup 向导写入配置并激活插件。安装完成后开始对话——OpenClaw 会自动记忆和召回。

备用方案:通过 ov-install 安装

当 ClawHub 不可用时:

bash
npm install -g openclaw-openviking-setup-helper
ov-install --base-url http://your-server:1933

常用参数:

参数含义
--workdir PATHOpenClaw 数据目录(默认 ~/.openclaw
--plugin-version=VER插件版本:npm 版本、dist-tag 或 Git ref
--base-url URLOpenViking 服务地址
--api-key KEYOpenViking API Key
--uninstall卸载插件

完整参数列表见 安装指南

验证

bash
openclaw openviking status

一键检查插件注册、服务端连通性和版本兼容性。追加 --json 获取机器可读结果。

手动验证

确认插件占用了 contextEngine 槽位:

bash
openclaw config get plugins.slots.contextEngine
# 期望输出:openviking

全链路健康检查:

bash
python examples/openclaw-plugin/health_check_tools/ov-healthcheck.py

详见 HEALTHCHECK.md

配置

插件配置位于 plugins.entries.openviking.config,通常 setup 已经写好。

参数默认值含义
baseUrlhttp://127.0.0.1:1933OpenViking 服务端点
apiKeyOpenViking API Key
peer_prefixpeer_role=assistant 时 assistant peer 身份的可选前缀
autoRecallTimeoutMs5000整个 auto-recall 流程的外层超时(毫秒);本地嵌入硬件较慢时可调大(取值范围 1000–300000)
bash
openclaw config set plugins.entries.openviking.config.baseUrl http://your-server:1933
openclaw config set plugins.entries.openviking.config.apiKey your-api-key

卸载

bash
curl -fsSL https://raw.githubusercontent.com/volcengine/OpenViking/main/examples/openclaw-plugin/upgrade_scripts/uninstall-openclaw-plugin.sh -o uninstall-openviking.sh
bash uninstall-openviking.sh

参见

Released under the Apache-2.0 License.