OpenClaw 插件
为 OpenClaw 添加长效记忆。安装完成后,OpenClaw 会自动记住对话中的重要信息,并在每次回复前召回相关上下文。
前置条件
| 组件 | 版本要求 |
|---|---|
| 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 restartsetup 向导写入配置并激活插件。安装完成后开始对话——OpenClaw 会自动记忆和召回。
备用方案:通过 ov-install 安装
当 ClawHub 不可用时:
bash
npm install -g openclaw-openviking-setup-helper
ov-install --base-url http://your-server:1933常用参数:
| 参数 | 含义 |
|---|---|
--workdir PATH | OpenClaw 数据目录(默认 ~/.openclaw) |
--plugin-version=VER | 插件版本:npm 版本、dist-tag 或 Git ref |
--base-url URL | OpenViking 服务地址 |
--api-key KEY | OpenViking 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 已经写好。
| 参数 | 默认值 | 含义 |
|---|---|---|
baseUrl | http://127.0.0.1:1933 | OpenViking 服务端点 |
apiKey | 空 | OpenViking API Key |
peer_prefix | 空 | peer_role=assistant 时 assistant peer 身份的可选前缀 |
autoRecallTimeoutMs | 5000 | 整个 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参见
- 完整安装指南 — 所有安装路径与参数
- 插件设计说明 — 架构、身份与路由、hook 生命周期
- Agent 操作指南 — 给代用户执行安装的 agent 看
