Skip to content

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

docs: refresh agent access guide cards (#4804)

ManAsWind0cd847aa4fa4
diff --git a/docs/images/agents/en/claude-code.md b/docs/images/agents/en/claude-code.md
index 3f40236ff..cb6deb34a 100644
--- a/docs/images/agents/en/claude-code.md
+++ b/docs/images/agents/en/claude-code.md
@@ -1,18 +1,50 @@
## Step 1: Install
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness claude --dist tos
-```
+Because Claude Code may block installation scripts from unknown sources, automatic setup may not complete. We recommend running the manual terminal steps below.
-Select **Volcengine OpenViking Cloud**. Paste the API key:
+1. Run the installer in your terminal:
+
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness claude --dist tos
+ ```
+
+2. The installer will ask for language (English / Chinese), OpenViking credentials, and whether to enable the Statusline.
+3. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
+
+4. OpenViking StatusLine is the status strip under the input box. It shows the memory plugin runtime status in real time. Enable or skip it based on your preference. Example:
+
+ ```text
+ OV ✓ │ Fable 5 · ctx 42% │ ↪ 6 mem (0.92) · 50ms │ ✎ 573/20k · 2 arch
+ ```
## Step 2: Verify
-Restart Claude Code, then:
+1. Restart Claude Code.
+2. Run `/plugins` and confirm the installed list shows `openviking-memory`, and the `openviking` MCP is connected:
+
+ ```text
+ User
+ ❯ openviking-memory Plugin · openviking · ✔ enabled
+ └ openviking MCP · ✔ connected
+ ```
+
+3. Run `/mcp` and confirm it shows:
+
+ ```text
+ Built-in MCPs (always available)
+ ❯ plugin:openviking-memory:openviking · ✔ connected · 10 tools
+ ```
+
+4. Run `/openviking-memory:ov` and confirm the service status is healthy:
-- `/plugins` → **openviking-memory** is installed, **openviking** MCP is connected
-- `/mcp` → shows the cloud URL and valid auth
-- `/openviking-memory:ov` → server is healthy
+ ```text
+ OpenViking Memory Status
+ ✅ Status: OpenViking server is healthy and running
+ ```
## Troubleshoot
diff --git a/docs/images/agents/en/codex.md b/docs/images/agents/en/codex.md
index 3de04ee0f..bc9a45454 100644
--- a/docs/images/agents/en/codex.md
+++ b/docs/images/agents/en/codex.md
@@ -1,14 +1,36 @@
## Step 1: Install
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness codex --dist tos
-```
+1. Run the installer in your terminal:
-Select **Volcengine OpenViking Cloud**. Paste the API key:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness codex --dist tos
+ ```
+
+2. The installer will ask for language (English / Chinese) and OpenViking credentials. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## Step 2: Verify
-Launch `codex`. Approve hooks once with `/hooks`. The first prompt should load your profile.
+1. Start Codex.
+2. Approve Hooks: enter `/hooks`. Codex should show a prompt similar to `4 hooks need review`; approve them one by one. The four OpenViking hooks are:
+
+ ```text
+ SessionStart
+ UserPromptSubmit
+ Stop
+ PreCompact
+ ```
+
+3. Verify Profile loading: after approval, submit your first Prompt. Any prompt is fine. The plugin should load your Profile automatically. If the beginning of the conversation contains recalled memory context, the integration is working:
+
+ ```text
+ • UserPromptSubmit hook (completed)
+ hook context: <openviking-context source="auto-recall" format="digest">
+ OpenViking memory digest:
+ ```
## Troubleshoot
diff --git a/docs/images/agents/en/cursor.md b/docs/images/agents/en/cursor.md
index 2c7088a92..71d0c4063 100644
--- a/docs/images/agents/en/cursor.md
+++ b/docs/images/agents/en/cursor.md
@@ -1,18 +1,21 @@
## Step 1: Install
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness cursor --dist tos
-```
+1. Run the installer in your terminal:
-Select **Volcengine OpenViking Cloud**. Paste the API key:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh)
+ ```
-{{OPENVIKING_API_KEY_BLOCK}}
+2. The installer will ask for language (English / Chinese) and OpenViking credentials. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## Step 2: Verify
-1. Restart Cursor and start a new Agent session.
-2. **Cursor Settings → Hooks**: lifecycle hooks run `cursor-hook.mjs`.
-3. **Cursor Settings → Tools & MCPs**: `openviking` is connected.
+1. Open **Customize → MCPs** and confirm both **openviking User** and **openviking Plugin** are visible.
+2. Open **Customize → Hooks** and confirm the **openviking-memory** entry is visible.
## Troubleshoot
diff --git a/docs/images/agents/en/hermes.md b/docs/images/agents/en/hermes.md
index d7ffc27c0..6dd23831e 100644
--- a/docs/images/agents/en/hermes.md
+++ b/docs/images/agents/en/hermes.md
@@ -1,20 +1,99 @@
## Step 1: Install
-```bash
-hermes memory setup openviking
-```
+1. Run the following command to start the OpenViking memory setup wizard:
-Keep **OpenViking Service (VolcEngine Cloud)**. Paste the API key:
+ ```bash
+ hermes memory setup openviking
+ ```
-{{OPENVIKING_API_KEY_BLOCK}}
+2. The wizard first asks for the configuration source:
+
+ ```text
+ OpenViking config source
+ ↑↓ navigate ENTER/SPACE select ESC cancel
+ → (●) Use existing OpenViking profile - choose from detected ovcli.conf profiles
+ (○) Create new OpenViking profile - enter a new URL/API key
+ ```
+
+ Options:
+
+ - Reuse an existing Profile: read the OpenViking URL and secret from a local `ovcli.conf`, with no need to enter them again.
+ - Create a new Profile: manually enter the OpenViking service URL and API key. Use this for first-time setup or when connecting to a new instance.
+
+3. If you choose **Create new OpenViking profile**, select **OpenViking Service (VolcEngine Cloud)** when asked for the connection type:
+
+ ```text
+ OpenViking connection
+ ↑↓ navigate ENTER/SPACE select ESC cancel
+
+ → (●) OpenViking Service (VolcEngine Cloud) - use the managed OpenViking endpoint
+ (○) Custom - use a local, VPS, or self-hosted OpenViking server
+ ```
+
+4. Enter the API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
+
+5. Fill in **Hermes peer ID in OpenViking**. This identifies the Hermes Agent in OpenViking so memories produced by different Agents can be separated. Press Enter to use the default `hermes`, or enter a custom value.
+6. Choose how to save the configuration. We recommend **Mirror to OpenViking store**:
+
+ ```text
+ Save OpenViking config
+ ↑↓ navigate ENTER/SPACE select ESC cancel
+ (○) Keep in Hermes only - write values only to Hermes .env
+ → (●) Mirror to OpenViking store - write ~/.openviking/ovcli.conf.<name> and link it
+ ```
+
+7. Fill in **OpenViking profile name**. Hermes' multi-tenant capabilities can isolate models, memories, configuration, and credentials across Profiles. We recommend configuring an independent OpenViking environment or identity for each Hermes Profile, and using an easy-to-recognize local name here. This name is local only; it does not create a new user or change account identity or permissions.
+8. When setup completes, Hermes shows:
+
+ ```text
+ OpenViking memory is ready
+ Created and linked OpenViking profile.
+ Config file: ~/.openviking/ovcli.conf.hermes
+ Start a new Hermes session to activate.
+ ```
## Step 2: Verify
-```bash
-hermes memory status
-```
+1. Check the memory plugin status:
+
+ ```bash
+ hermes memory status
+ ```
+
+2. A result similar to the following means the integration is successful:
+
+ ```text
+ Memory status
+ ────────────────────────────────────────
+ Built-in (MEMORY.md / USER.md):
+ Memory injection: enabled ✓
+ User profile: enabled ✓
+ Memory tool: enabled ✓
+ Provider: openviking
+
+ openviking config:
+ use_ovcli_config: True
+ ovcli_config_path: ~/.openviking/ovcli.conf.hermes
+ endpoint: `https://api.vikingdb.cn-beijing.volces.com/openviking`
+ agent: hermes
+
+ Plugin: installed ✓
+ Status: available ✓
-Expect `Provider: openviking` and `Status: available`. Start a new Hermes session.
+ Installed plugins:
+ • byterover (API key / local)
+ • hindsight (API key / local)
+ • holographic (local)
+ • honcho (API key / local)
+ • mem0 (API key / local)
+ • openviking (API key / local) ← active
+ • retaindb (API key / local)
+ • supermemory (requires API key)
+ ```
## Troubleshoot
diff --git a/docs/images/agents/en/openclaw.md b/docs/images/agents/en/openclaw.md
index 8fbf3fad2..17d4126a8 100644
--- a/docs/images/agents/en/openclaw.md
+++ b/docs/images/agents/en/openclaw.md
@@ -1,20 +1,53 @@
## Step 1: Install
-Copy the API key:
+1. Install the OpenViking plugin:
-{{OPENVIKING_API_KEY_BLOCK}}
+ ```bash
+ openclaw plugins install clawhub:@openviking/openclaw-plugin
+ ```
-```bash
-openclaw plugins install clawhub:@openviking/openclaw-plugin
-openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <API-key>
-openclaw gateway restart
-```
+2. Connect OpenClaw to the VolcEngine-hosted OpenViking service:
+
+ ```bash
+ openclaw openviking setup --base-url https://api.vikingdb.cn-beijing.volces.com/openviking --api-key <$OPENVIKING_API_KEY>
+ ```
+
+3. Configure `peer_role`: `peer_role` identifies the type of conversation participant. It is not a permission role. `assistant` represents agents, tools, or models; `person` represents human participants. After the setup above, `peer_role` defaults to `none`. To change `peer_role`, run:
+
+ ```bash
+ openclaw openviking setup --reconfigure
+ ```
+
+4. Restart the Gateway to apply the configuration:
+
+ ```bash
+ openclaw gateway restart
+ ```
## Step 2: Verify
-```bash
-openclaw openviking status
-```
+1. Check the integration status in your terminal:
+
+ ```bash
+ openclaw openviking status
+ ```
+
+2. A result similar to the following means the integration is successful:
+
+ ```text
+ 🦣 OpenViking Plugin Status
+
+ Status: Configured
+ mode: remote
+ baseUrl: `https://api.vikingdb.cn-beijing.volces.com/openviking`
+ apiKey: set
+ peer_role: none
+ accountId: not set
+ userId: not set
+ slot: active
+
+ ✓ Server reachable (version: v0.x.xx.x)
+ ```
## Troubleshoot
diff --git a/docs/images/agents/en/opencode.md b/docs/images/agents/en/opencode.md
index 00eb291af..b33b38d12 100644
--- a/docs/images/agents/en/opencode.md
+++ b/docs/images/agents/en/opencode.md
@@ -1,14 +1,22 @@
## Step 1: Install
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness opencode --dist tos
-```
+1. Run the installer in your terminal:
-Select **Volcengine OpenViking Cloud**. Paste the API key:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness opencode --dist tos
+ ```
+
+2. The installer will ask for language (English / Chinese) and OpenViking credentials. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## Step 2: Verify
-Restart OpenCode. Ask it to search OpenViking memory. Tools look like `openviking_search`, `openviking_read`, `openviking_remember`.
+1. Restart OpenCode.
+2. Run `/mcps` and confirm the list shows `openviking connected`.
+3. Ask OpenCode to recall related memories in a conversation, and verify that it can automatically call tools such as `openviking_search`, `openviking_read`, and `openviking_remember`.
## Troubleshoot
diff --git a/docs/images/agents/en/trae.md b/docs/images/agents/en/trae.md
index 56998ebe3..f29f8a9a3 100644
--- a/docs/images/agents/en/trae.md
+++ b/docs/images/agents/en/trae.md
@@ -1,20 +1,28 @@
## Step 1: Install
-```bash
-# TRAE
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae --dist tos
+1. Run the command that matches your TRAE version:
-# TRAE CN
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae-cn --dist tos
-```
+ **Trae International**
-Select **Volcengine OpenViking Cloud**. Paste the API key:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae --dist tos
+ ```
-{{OPENVIKING_API_KEY_BLOCK}}
+ **Trae China**
+
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae-cn --dist tos
+ ```
+
+2. The installer will ask for language (English / Chinese) and OpenViking credentials. In the OpenViking credential step, choose **VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com]** and enter the API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## Step 2: Verify
-Restart TRAE. Confirm `openviking` is connected in settings.
+Open **Settings → MCP → Configured MCP Servers** and confirm that the `openviking` entry is visible.
## Troubleshoot
diff --git a/docs/images/agents/zh/claude-code.md b/docs/images/agents/zh/claude-code.md
index ee33d03b0..6fb7a1f62 100644
--- a/docs/images/agents/zh/claude-code.md
+++ b/docs/images/agents/zh/claude-code.md
@@ -1,18 +1,50 @@
## 步骤1:安装
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness claude --dist tos
-```
+由于 Claude Code 安全策略限制,可能无法自动完成配置,推荐在终端中手动执行以下步骤。
-选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
+1. 在终端执行如下安装命令:
+
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness claude --dist tos
+ ```
+
+2. 安装器会依次询问以下信息:语言(English / 中文)、OpenViking 凭据、是否开启 Statusline 状态栏。
+3. 在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
+
+4. OpenViking StatusLine 是输入框下方的一行状态提示栏,用于实时展示 OpenViking 记忆插件的运行状态。可根据个人需要选择「开启」或「跳过」。状态提示栏示例如下:
+
+ ```text
+ OV ✓ │ Fable 5 · ctx 42% │ ↪ 6 mem (0.92) · 50ms │ ✎ 573/20k · 2 arch
+ ```
## 步骤2:验证
-重启 Claude Code,然后:
+1. 重启 Claude Code。
+2. 执行 `/plugins` 命令,确认 installed 列表中显示 `openviking-memory` 已安装,且 `openviking` MCP 已连接:
+
+ ```text
+ User
+ ❯ openviking-memory Plugin · openviking · ✔ enabled
+ └ openviking MCP · ✔ connected
+ ```
+
+3. 执行 `/mcp` 命令,确认显示如下信息:
+
+ ```text
+ Built-in MCPs (always available)
+ ❯ plugin:openviking-memory:openviking · ✔ connected · 10 tools
+ ```
+
+4. 执行 `/openviking-memory:ov` 命令,确认服务状态正常:
-- `/plugins` → **openviking-memory** 已安装,**openviking** MCP 已连接
-- `/mcp` → 显示云端 URL 且鉴权有效
-- `/openviking-memory:ov` → 服务健康
+ ```text
+ OpenViking Memory Status
+ ✅ Status: OpenViking server is healthy and running
+ ```
## 故障排查
diff --git a/docs/images/agents/zh/cli.md b/docs/images/agents/zh/cli.md
index 18b858cf6..343e31e03 100644
--- a/docs/images/agents/zh/cli.md
+++ b/docs/images/agents/zh/cli.md
@@ -18,6 +18,8 @@ npm i -g @openviking/cli && ov config
{{OPENVIKING_API_KEY_BLOCK}}
+{{OPENVIKING_API_KEY_BLOCK}}
+
### 步骤3:配置完成后,可运行以下命令查看 CLI 用法:
diff --git a/docs/images/agents/zh/codex.md b/docs/images/agents/zh/codex.md
index 288db95ac..302be607f 100644
--- a/docs/images/agents/zh/codex.md
+++ b/docs/images/agents/zh/codex.md
@@ -1,14 +1,36 @@
## 步骤1:安装
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness codex --dist tos
-```
+1. 在终端执行如下安装命令:
-选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness codex --dist tos
+ ```
+
+2. 安装器会依次询问以下信息:语言(English / 中文)、OpenViking 凭据。在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## 步骤2:验证
-启动 `codex`,用 `/hooks` 审批一次。第一次提交 prompt 时应加载 profile。
+1. 启动 Codex。
+2. 审批 Hooks:输入 `/hooks`,系统将提示类似 `4 hooks need review` 的信息,逐一审批通过。其中 OpenViking 相关的 4 个 Hook 为:
+
+ ```text
+ SessionStart
+ UserPromptSubmit
+ Stop
+ PreCompact
+ ```
+
+3. 验证 Profile 加载:审批完成后,提交第一条 Prompt(内容随意即可)。此时插件应自动加载 Profile——若对话开头出现记忆召回内容,则表明接入成功:
+
+ ```text
+ • UserPromptSubmit hook (completed)
+ hook context: <openviking-context source="auto-recall" format="digest">
+ OpenViking memory digest:
+ ```
## 故障排查
diff --git a/docs/images/agents/zh/cursor.md b/docs/images/agents/zh/cursor.md
index 6bd4968ce..55f230f25 100644
--- a/docs/images/agents/zh/cursor.md
+++ b/docs/images/agents/zh/cursor.md
@@ -1,18 +1,21 @@
## 步骤1:安装
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness cursor --dist tos
-```
+1. 在终端执行如下安装命令:
-选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh)
+ ```
-{{OPENVIKING_API_KEY_BLOCK}}
+2. 安装器会依次询问以下信息:语言(English / 中文)、OpenViking 凭据。在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## 步骤2:验证
-1. 重启 Cursor,新建 Agent 会话。
-2. **Cursor Settings → Hooks**:生命周期 Hook 执行 `cursor-hook.mjs`。
-3. **Cursor Settings → Tools & MCPs**:`openviking` 已连接。
+1. 点击「Customize → MCPs」,确认可以看到「openviking User」和「openviking Plugin」两项。
+2. 点击「Customize → Hooks」,确认可以看到「openviking-memory」条目。
## 故障排查
diff --git a/docs/images/agents/zh/hermes.md b/docs/images/agents/zh/hermes.md
index 95d1b5842..f8dc58ba9 100644
--- a/docs/images/agents/zh/hermes.md
+++ b/docs/images/agents/zh/hermes.md
@@ -1,20 +1,99 @@
## 步骤1:安装
-```bash
-hermes memory setup openviking
-```
+1. 在终端执行如下命令,启动 OpenViking 记忆配置向导:
-保持 **OpenViking Service (VolcEngine Cloud)**,把 API Key 贴进去:
+ ```bash
+ hermes memory setup openviking
+ ```
-{{OPENVIKING_API_KEY_BLOCK}}
+2. 执行后将出现配置来源选择界面:
+
+ ```text
+ OpenViking config source
+ ↑↓ navigate ENTER/SPACE select ESC cancel
+ → (●) Use existing OpenViking profile - choose from detected ovcli.conf profiles
+ (○) Create new OpenViking profile - enter a new URL/API key
+ ```
+
+ 选项说明:
+
+ - 复用现有 Profile:直接读取本地已有的 `ovcli.conf` 中的 OpenViking 地址和密钥,无需重复填写。
+ - 新建 Profile:需手动输入 OpenViking 服务的访问 URL 和 API 密钥,适合首次配置或连接新实例的场景。
+
+3. 若选择「Create new OpenViking profile」,将出现连接方式选择,请选择「OpenViking Service (VolcEngine Cloud)」:
+
+ ```text
+ OpenViking connection
+ ↑↓ navigate ENTER/SPACE select ESC cancel
+
+ → (●) OpenViking Service (VolcEngine Cloud) - use the managed OpenViking endpoint
+ (○) Custom - use a local, VPS, or self-hosted OpenViking server
+ ```
+
+4. 填入 API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
+
+5. 填写「Hermes peer ID in OpenViking」:该字段为 Hermes 在 OpenViking 中的 Agent 身份标识,用于区分不同 Agent 产生的记忆。可直接按 Enter 使用默认值「hermes」,也可自定义填写。
+6. 选择配置保存方式,建议选择「Mirror to OpenViking store」:
+
+ ```text
+ Save OpenViking config
+ ↑↓ navigate ENTER/SPACE select ESC cancel
+ (○) Keep in Hermes only - write values only to Hermes .env
+ → (●) Mirror to OpenViking store - write ~/.openviking/ovcli.conf.<name> and link it
+ ```
+
+7. 填写「OpenViking profile name」:Hermes 的多租户能力可隔离不同 Profile 的模型、记忆、配置及凭据。建议为每个 Hermes Profile 配置独立的 OpenViking 环境或身份,并在此填写一个便于识别的本地配置名称,以区分对应的 OpenViking 配置。该名称仅用于本地标识,不会创建新用户,也不会改变账号身份或权限。
+8. 配置完成后将显示如下确认信息:
+
+ ```text
+ OpenViking memory is ready
+ Created and linked OpenViking profile.
+ Config file: ~/.openviking/ovcli.conf.hermes
+ Start a new Hermes session to activate.
+ ```
## 步骤2:验证
-```bash
-hermes memory status
-```
+1. 执行以下命令验证记忆插件状态:
+
+ ```bash
+ hermes memory status
+ ```
+
+2. 返回如下结果即表示接入成功:
+
+ ```text
+ Memory status
+ ────────────────────────────────────────
+ Built-in (MEMORY.md / USER.md):
+ Memory injection: enabled ✓
+ User profile: enabled ✓
+ Memory tool: enabled ✓
+ Provider: openviking
+
+ openviking config:
+ use_ovcli_config: True
+ ovcli_config_path: ~/.openviking/ovcli.conf.hermes
+ endpoint: `https://api.vikingdb.cn-beijing.volces.com/openviking`
+ agent: hermes
+
+ Plugin: installed ✓
+ Status: available ✓
-应看到 `Provider: openviking` 且 `Status: available`。然后开一轮新会话。
+ Installed plugins:
+ • byterover (API key / local)
+ • hindsight (API key / local)
+ • holographic (local)
+ • honcho (API key / local)
+ • mem0 (API key / local)
+ • openviking (API key / local) ← active
+ • retaindb (API key / local)
+ • supermemory (requires API key)
+ ```
## 故障排查
diff --git a/docs/images/agents/zh/index.json b/docs/images/agents/zh/index.json
index e68260aff..f08ab40cd 100644
--- a/docs/images/agents/zh/index.json
+++ b/docs/images/agents/zh/index.json
@@ -40,6 +40,22 @@
}
],
"agents": [
+ {
+ "id": "openclaw",
+ "name": "OpenClaw",
+ "tags": ["Plugin"],
+ "logo": "https://lf3-static.bytednsdoc.com/obj/eden-cn/lm_sth/ljhwZthlaukjlkulzlp/agent_logo/OpenClaw.png",
+ "summary": "Plugin 接入,作为 OpenClaw 的 context engine,支持多 Agent 跨会话记忆与自迭代,通过 npm 安装助手工具一键完成配置",
+ "detailPath": "https://docs.openviking.net/agents/zh/openclaw.md"
+ },
+ {
+ "id": "hermes",
+ "name": "Hermes Agent",
+ "tags": ["Provider"],
+ "logo": "https://lf3-static.bytednsdoc.com/obj/eden-cn/lm_sth/ljhwZthlaukjlkulzlp/agent_logo/Hermes-Agent.png",
+ "summary": "Hermes 官方内置 OpenViking。跑 hermes memory setup openviking,默认选火山云,再贴上 API Key 即可",
+ "detailPath": "https://docs.openviking.net/agents/zh/hermes.md"
+ },
{
"id": "claude-code",
"name": "Claude Code",
diff --git a/docs/images/agents/zh/openclaw.md b/docs/images/agents/zh/openclaw.md
index fe8b58d4b..25190b856 100644
--- a/docs/images/agents/zh/openclaw.md
+++ b/docs/images/agents/zh/openclaw.md
@@ -1,20 +1,53 @@
## 步骤1:安装
-复制 API Key:
+1. 安装 OpenViking 插件:
-{{OPENVIKING_API_KEY_BLOCK}}
+ ```bash
+ openclaw plugins install clawhub:@openviking/openclaw-plugin
+ ```
-```bash
-openclaw plugins install clawhub:@openviking/openclaw-plugin
-openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <API-Key>
-openclaw gateway restart
-```
+2. 将 OpenClaw 连接至火山引擎托管的 OpenViking 服务:
+
+ ```bash
+ openclaw openviking setup --base-url https://api.vikingdb.cn-beijing.volces.com/openviking --api-key <$OPENVIKING_API_KEY>
+ ```
+
+3. 配置 `peer_role`:`peer_role` 用于标识对话参与者的类型,并非权限角色。其中,`assistant` 表示不同的 Agent、工具或模型,`person` 表示不同的人类参与者。完成上述配置后,`peer_role` 默认为 `none`。如需调整 `peer_role`,可执行以下命令:
+
+ ```bash
+ openclaw openviking setup --reconfigure
+ ```
+
+4. 重启 Gateway 使配置生效:
+
+ ```bash
+ openclaw gateway restart
+ ```
## 步骤2:验证
-```bash
-openclaw openviking status
-```
+1. 在终端执行如下命令检查接入状态:
+
+ ```bash
+ openclaw openviking status
+ ```
+
+2. 返回如下结果即表示接入成功:
+
+ ```text
+ 🦣 OpenViking Plugin Status
+
+ Status: Configured
+ mode: remote
+ baseUrl: `https://api.vikingdb.cn-beijing.volces.com/openviking`
+ apiKey: set
+ peer_role: none
+ accountId: not set
+ userId: not set
+ slot: active
+
+ ✓ Server reachable (version: v0.x.xx.x)
+ ```
## 故障排查
diff --git a/docs/images/agents/zh/opencode.md b/docs/images/agents/zh/opencode.md
index 3157266ca..f11c1d31c 100644
--- a/docs/images/agents/zh/opencode.md
+++ b/docs/images/agents/zh/opencode.md
@@ -1,14 +1,22 @@
## 步骤1:安装
-```bash
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness opencode --dist tos
-```
+1. 在终端执行以下安装命令:
-选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness opencode --dist tos
+ ```
+
+2. 安装器会依次询问以下信息:语言(English / 中文)、OpenViking 凭据。在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## 步骤2:验证
-重启 OpenCode,让它搜索 OpenViking 记忆。工具名类似 `openviking_search`、`openviking_read`、`openviking_remember`。
+1. 重启 OpenCode。
+2. 输入 `/mcps` 命令,确认列表中显示 `openviking connected`。
+3. 在对话中请求 OpenCode 召回相关记忆,验证是否会自动调用 `openviking_search`、`openviking_read`、`openviking_remember` 等工具。
## 故障排查
diff --git a/docs/images/agents/zh/trae.md b/docs/images/agents/zh/trae.md
index 83e545c6d..5b2a6847a 100644
--- a/docs/images/agents/zh/trae.md
+++ b/docs/images/agents/zh/trae.md
@@ -1,20 +1,28 @@
## 步骤1:安装
-```bash
-# TRAE
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae --dist tos
+1. 根据所使用的版本,在终端执行对应的安装命令:
-# TRAE CN
-bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae-cn --dist tos
-```
+ **Trae 国际版**
-选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae --dist tos
+ ```
-{{OPENVIKING_API_KEY_BLOCK}}
+ **Trae 中国版**
+
+ ```bash
+ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae-cn --dist tos
+ ```
+
+2. 安装器会依次询问以下信息:语言(English / 中文)、OpenViking 凭据。在 OpenViking 凭据配置中,选择连接至「火山引擎 OpenViking 云服务 [api.vikingdb.cn-beijing.volces.com]」,并填入 API KEY:
+
+ ```text
+ {{OPENVIKING_API_KEY}}
+ ```
## 步骤2:验证
-重启 TRAE。在设置里确认 `openviking` 已连接。
+在「设置 → MCP → 已配置的 MCP Servers」中确认能够看到 `openviking` 条目即表示接入成功。
## 故障排查