Skip to content

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

docs: refine Chinese agent integration copy (#4194)

ManAsWindc92ad738c1b0
diff --git a/docs/images/agents/en/claude-code.md b/docs/images/agents/en/claude-code.md
index 12df7451c..3f40236ff 100644
--- a/docs/images/agents/en/claude-code.md
+++ b/docs/images/agents/en/claude-code.md
@@ -1,12 +1,12 @@
-## Install
+## Step 1: Install
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness claude --dist tos
```
-Select **Volcengine OpenViking Cloud**. Paste the API key from this page.
+Select **Volcengine OpenViking Cloud**. Paste the API key:
-## Verify
+## Step 2: Verify
Restart Claude Code, then:
@@ -20,7 +20,7 @@ Restart Claude Code, then:
|---|---|
| Plugin is not active | Re-run Install, or check `~/.openviking/ovcli.conf` |
| Recall is empty | `curl "$(jq -r '.url' ~/.openviking/ovcli.conf)/health"` |
-| 401 / 403 | Paste the API key from this page again |
+| 401 / 403 | Paste the API key again |
| Need logs | `OPENVIKING_DEBUG=1` and `~/.openviking/logs/cc-hooks.log` |
## Reference
diff --git a/docs/images/agents/en/codex.md b/docs/images/agents/en/codex.md
index 60b621a6a..3de04ee0f 100644
--- a/docs/images/agents/en/codex.md
+++ b/docs/images/agents/en/codex.md
@@ -1,12 +1,12 @@
-## Install
+## Step 1: Install
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness codex --dist tos
```
-Select **Volcengine OpenViking Cloud**. Paste the API key from this page.
+Select **Volcengine OpenViking Cloud**. Paste the API key:
-## Verify
+## Step 2: Verify
Launch `codex`. Approve hooks once with `/hooks`. The first prompt should load your profile.
diff --git a/docs/images/agents/en/cursor.md b/docs/images/agents/en/cursor.md
index 467dce037..2c7088a92 100644
--- a/docs/images/agents/en/cursor.md
+++ b/docs/images/agents/en/cursor.md
@@ -1,16 +1,14 @@
-## Install
+## Step 1: Install
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness cursor --dist tos
```
-Select **Volcengine OpenViking Cloud**. Paste the API key from this page.
-
-API Key: Copy the API Key shown on the page and paste it when the installer prompts for it.
+Select **Volcengine OpenViking Cloud**. Paste the API key:
{{OPENVIKING_API_KEY_BLOCK}}
-## Verify
+## Step 2: Verify
1. Restart Cursor and start a new Agent session.
2. **Cursor Settings → Hooks**: lifecycle hooks run `cursor-hook.mjs`.
diff --git a/docs/images/agents/en/deerflow-mcp.md b/docs/images/agents/en/deerflow-mcp.md
index 1f6eb2ddd..0cb17bdb3 100644
--- a/docs/images/agents/en/deerflow-mcp.md
+++ b/docs/images/agents/en/deerflow-mcp.md
@@ -2,11 +2,9 @@ DeerFlow can connect to OpenViking through an MCP Server. MCP integration lets D
## Step 1: Configure OpenViking credentials
-Edit the `.env` file in the DeerFlow project root and add the API key from this page:
+Edit the `.env` file in the DeerFlow project root and add the API key:
-```bash
-OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}
-```
+{{OPENVIKING_API_KEY_BLOCK}}
## Step 2: Create an MCP configuration file
diff --git a/docs/images/agents/en/deerflow-memory-manager.md b/docs/images/agents/en/deerflow-memory-manager.md
index d0c0e828a..15236923b 100644
--- a/docs/images/agents/en/deerflow-memory-manager.md
+++ b/docs/images/agents/en/deerflow-memory-manager.md
@@ -2,11 +2,9 @@ DeerFlow can use OpenViking as a long-term memory backend through MemoryManager.
## Step 1: Configure OpenViking credentials
-Edit the `.env` file in the DeerFlow project root and add the API key from this page:
+Edit the `.env` file in the DeerFlow project root and add the API key:
-```bash
-OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}
-```
+{{OPENVIKING_API_KEY_BLOCK}}
## Step 2: Update DeerFlow memory configuration
diff --git a/docs/images/agents/en/hermes.md b/docs/images/agents/en/hermes.md
index f144ddcbf..d7ffc27c0 100644
--- a/docs/images/agents/en/hermes.md
+++ b/docs/images/agents/en/hermes.md
@@ -1,14 +1,14 @@
-## Install
+## Step 1: Install
```bash
hermes memory setup openviking
```
-Keep **OpenViking Service (VolcEngine Cloud)**. Paste the API key from this page:
+Keep **OpenViking Service (VolcEngine Cloud)**. Paste the API key:
{{OPENVIKING_API_KEY_BLOCK}}
-## Verify
+## Step 2: Verify
```bash
hermes memory status
@@ -21,7 +21,7 @@ Expect `Provider: openviking` and `Status: available`. Start a new Hermes sessio
| Problem | Fix |
|---|---|
| Provider is not openviking | Re-run `hermes memory setup openviking` |
-| Status is not available | Check the API key from this page |
+| Status is not available | Check the API key |
## Reference
diff --git a/docs/images/agents/en/openclaw.md b/docs/images/agents/en/openclaw.md
index d4d0f79fb..8fbf3fad2 100644
--- a/docs/images/agents/en/openclaw.md
+++ b/docs/images/agents/en/openclaw.md
@@ -1,16 +1,16 @@
-## Install
+## Step 1: Install
-Copy the API key from this page:
+Copy the API key:
{{OPENVIKING_API_KEY_BLOCK}}
```bash
openclaw plugins install clawhub:@openviking/openclaw-plugin
-openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <API-key-from-this-page>
+openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <API-key>
openclaw gateway restart
```
-## Verify
+## Step 2: Verify
```bash
openclaw openviking status
@@ -21,7 +21,7 @@ openclaw openviking status
| Problem | Fix |
|---|---|
| Plugin not active | Re-run Install, then `openclaw gateway restart` |
-| 401 / 403 | Paste the API key from this page again |
+| 401 / 403 | Paste the API key again |
## Reference
diff --git a/docs/images/agents/en/opencode.md b/docs/images/agents/en/opencode.md
index fcb0b1d4e..00eb291af 100644
--- a/docs/images/agents/en/opencode.md
+++ b/docs/images/agents/en/opencode.md
@@ -1,12 +1,12 @@
-## Install
+## Step 1: Install
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness opencode --dist tos
```
-Select **Volcengine OpenViking Cloud**. Paste the API key from this page.
+Select **Volcengine OpenViking Cloud**. Paste the API key:
-## Verify
+## Step 2: Verify
Restart OpenCode. Ask it to search OpenViking memory. Tools look like `openviking_search`, `openviking_read`, `openviking_remember`.
@@ -15,7 +15,7 @@ Restart OpenCode. Ask it to search OpenViking memory. Tools look like `openvikin
| Problem | Fix |
|---|---|
| Plugin is not loaded | Check `~/.config/opencode/opencode.json` includes `@openviking/opencode-plugin` |
-| Wrong server / 401 | Check `~/.openviking/ovcli.conf` and the API key from this page |
+| Wrong server / 401 | Check `~/.openviking/ovcli.conf` and the API key |
| Recall is empty | Confirm the cloud instance has memories |
## Reference
diff --git a/docs/images/agents/en/trae.md b/docs/images/agents/en/trae.md
index 42740ce2c..56998ebe3 100644
--- a/docs/images/agents/en/trae.md
+++ b/docs/images/agents/en/trae.md
@@ -1,4 +1,4 @@
-## Install
+## Step 1: Install
```bash
# TRAE
@@ -8,13 +8,11 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shar
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae-cn --dist tos
```
-Select **Volcengine OpenViking Cloud**. Paste the API key from this page.
-
-API Key: Copy the API Key shown on the page and paste it when the installer prompts for it.
+Select **Volcengine OpenViking Cloud**. Paste the API key:
{{OPENVIKING_API_KEY_BLOCK}}
-## Verify
+## Step 2: Verify
Restart TRAE. Confirm `openviking` is connected in settings.
diff --git a/docs/images/agents/zh/claude-code.md b/docs/images/agents/zh/claude-code.md
index a26b2a0bc..ee33d03b0 100644
--- a/docs/images/agents/zh/claude-code.md
+++ b/docs/images/agents/zh/claude-code.md
@@ -1,12 +1,12 @@
-## 安装
+## 步骤1:安装
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness claude --dist tos
```
-选 **火山引擎 OpenViking 云服务**,把本页 API Key 贴进去。
+选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
-## 验证
+## 步骤2:验证
重启 Claude Code,然后:
@@ -20,7 +20,7 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shar
|---|---|
| 插件未激活 | 重跑安装,或检查 `~/.openviking/ovcli.conf` |
| 召回为空 | `curl "$(jq -r '.url' ~/.openviking/ovcli.conf)/health"` |
-| 401 / 403 | 重新粘贴本页 API Key |
+| 401 / 403 | 重新粘贴 API Key |
| 需要日志 | `OPENVIKING_DEBUG=1`,看 `~/.openviking/logs/cc-hooks.log` |
## 参考
diff --git a/docs/images/agents/zh/cli.md b/docs/images/agents/zh/cli.md
index e40958de5..343e31e03 100644
--- a/docs/images/agents/zh/cli.md
+++ b/docs/images/agents/zh/cli.md
@@ -14,7 +14,9 @@ npm i -g @openviking/cli && ov config
```text
{{OPENVIKING_BASE_URL}}
```
-- API Key: 把本页展示的 API Key 粘贴到终端
+- API Key: 把 API Key 粘贴到终端
+
+{{OPENVIKING_API_KEY_BLOCK}}
{{OPENVIKING_API_KEY_BLOCK}}
diff --git a/docs/images/agents/zh/codex.md b/docs/images/agents/zh/codex.md
index 38c0872cf..288db95ac 100644
--- a/docs/images/agents/zh/codex.md
+++ b/docs/images/agents/zh/codex.md
@@ -1,12 +1,12 @@
-## 安装
+## 步骤1:安装
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness codex --dist tos
```
-选 **火山引擎 OpenViking 云服务**,把本页 API Key 贴进去。
+选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
-## 验证
+## 步骤2:验证
启动 `codex`,用 `/hooks` 审批一次。第一次提交 prompt 时应加载 profile。
diff --git a/docs/images/agents/zh/cursor.md b/docs/images/agents/zh/cursor.md
index 41ebc783d..6bd4968ce 100644
--- a/docs/images/agents/zh/cursor.md
+++ b/docs/images/agents/zh/cursor.md
@@ -1,16 +1,14 @@
-## 安装
+## 步骤1:安装
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness cursor --dist tos
```
-选 **火山引擎 OpenViking 云服务**,把本页 API Key 贴进去。
-
-API Key:复制页面中展示的 API Key,并在安装器提示时粘贴。
+选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
{{OPENVIKING_API_KEY_BLOCK}}
-## 验证
+## 步骤2:验证
1. 重启 Cursor,新建 Agent 会话。
2. **Cursor Settings → Hooks**:生命周期 Hook 执行 `cursor-hook.mjs`。
diff --git a/docs/images/agents/zh/deerflow-mcp.md b/docs/images/agents/zh/deerflow-mcp.md
index 607568006..2f31deeaa 100644
--- a/docs/images/agents/zh/deerflow-mcp.md
+++ b/docs/images/agents/zh/deerflow-mcp.md
@@ -2,11 +2,9 @@ DeerFlow 支持通过 MCP Server 接入 OpenViking。MCP 接入的核心价值
## 步骤 1:配置 OpenViking 鉴权信息
-在 DeerFlow 项目根目录下编辑 `.env` 文件,把本页的 API Key 填进去:
+在 DeerFlow 项目根目录下编辑 `.env` 文件,把 API Key 填进去:
-```bash
-OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}
-```
+{{OPENVIKING_API_KEY_BLOCK}}
## 步骤 2:创建 MCP 配置文件
diff --git a/docs/images/agents/zh/deerflow-memory-manager.md b/docs/images/agents/zh/deerflow-memory-manager.md
index 1df5f52cc..dda1715b1 100644
--- a/docs/images/agents/zh/deerflow-memory-manager.md
+++ b/docs/images/agents/zh/deerflow-memory-manager.md
@@ -2,11 +2,9 @@ DeerFlow 支持通过 MemoryManager 接入 OpenViking 作为长期记忆后端
## 步骤 1:配置 OpenViking 鉴权信息
-在 DeerFlow 项目根目录下编辑 `.env` 文件,把本页的 API Key 填进去:
+在 DeerFlow 项目根目录下编辑 `.env` 文件,把 API Key 填进去:
-```bash
-OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}
-```
+{{OPENVIKING_API_KEY_BLOCK}}
## 步骤 2:修改 DeerFlow 的 memory 配置
diff --git a/docs/images/agents/zh/hermes.md b/docs/images/agents/zh/hermes.md
index 07df95bf9..95d1b5842 100644
--- a/docs/images/agents/zh/hermes.md
+++ b/docs/images/agents/zh/hermes.md
@@ -1,14 +1,14 @@
-## 安装
+## 步骤1:安装
```bash
hermes memory setup openviking
```
-保持 **OpenViking Service (VolcEngine Cloud)**,把本页 API Key 贴进去:
+保持 **OpenViking Service (VolcEngine Cloud)**,把 API Key 贴进去:
{{OPENVIKING_API_KEY_BLOCK}}
-## 验证
+## 步骤2:验证
```bash
hermes memory status
@@ -21,7 +21,7 @@ hermes memory status
| 问题 | 处理 |
|---|---|
| Provider 不是 openviking | 重跑 `hermes memory setup openviking` |
-| Status 不是 available | 检查本页 API Key |
+| Status 不是 available | 检查 API Key |
## 参考
diff --git a/docs/images/agents/zh/index.json b/docs/images/agents/zh/index.json
index c242631e7..fe3a1803e 100644
--- a/docs/images/agents/zh/index.json
+++ b/docs/images/agents/zh/index.json
@@ -53,7 +53,7 @@
"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 即可",
+ "summary": "Hermes 官方内置 OpenViking。跑 hermes memory setup openviking,默认选火山云,再贴上 API Key 即可",
"detailPath": "https://docs.openviking.net/agents/zh/hermes.md"
},
{
diff --git a/docs/images/agents/zh/openclaw.md b/docs/images/agents/zh/openclaw.md
index ff0813848..cb57a15c4 100644
--- a/docs/images/agents/zh/openclaw.md
+++ b/docs/images/agents/zh/openclaw.md
@@ -1,4 +1,8 @@
-## 安装
+## 步骤1:安装
+
+复制 API Key:
+
+{{OPENVIKING_API_KEY_BLOCK}}
复制本页 API Key:
@@ -6,11 +10,11 @@
```bash
openclaw plugins install clawhub:@openviking/openclaw-plugin
-openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <本页的-API-Key>
+openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <API-Key>
openclaw gateway restart
```
-## 验证
+## 步骤2:验证
```bash
openclaw openviking status
@@ -21,7 +25,7 @@ openclaw openviking status
| 问题 | 处理 |
|---|---|
| 插件未生效 | 重跑安装,再执行 `openclaw gateway restart` |
-| 401 / 403 | 重新粘贴本页 API Key |
+| 401 / 403 | 重新粘贴 API Key |
## 参考
diff --git a/docs/images/agents/zh/opencode.md b/docs/images/agents/zh/opencode.md
index d28177dff..3157266ca 100644
--- a/docs/images/agents/zh/opencode.md
+++ b/docs/images/agents/zh/opencode.md
@@ -1,12 +1,12 @@
-## 安装
+## 步骤1:安装
```bash
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness opencode --dist tos
```
-选 **火山引擎 OpenViking 云服务**,把本页 API Key 贴进去。
+选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
-## 验证
+## 步骤2:验证
重启 OpenCode,让它搜索 OpenViking 记忆。工具名类似 `openviking_search`、`openviking_read`、`openviking_remember`。
@@ -15,7 +15,7 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shar
| 问题 | 处理 |
|---|---|
| 插件没加载 | 检查 `~/.config/opencode/opencode.json` 是否包含 `@openviking/opencode-plugin` |
-| 连错服务 / 401 | 检查 `~/.openviking/ovcli.conf` 和本页 API Key |
+| 连错服务 / 401 | 检查 `~/.openviking/ovcli.conf` 和 API Key |
| 召回为空 | 确认云端实例里已有记忆 |
## 参考
diff --git a/docs/images/agents/zh/trae.md b/docs/images/agents/zh/trae.md
index eee2695e6..83e545c6d 100644
--- a/docs/images/agents/zh/trae.md
+++ b/docs/images/agents/zh/trae.md
@@ -1,4 +1,4 @@
-## 安装
+## 步骤1:安装
```bash
# TRAE
@@ -8,13 +8,11 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shar
bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shared/install.sh) --harness trae-cn --dist tos
```
-选 **火山引擎 OpenViking 云服务**,把本页 API Key 贴进去。
-
-API Key:复制页面中展示的 API Key,并在安装器提示时粘贴。
+选 **火山引擎 OpenViking 云服务**,把 API Key 贴进去:
{{OPENVIKING_API_KEY_BLOCK}}
-## 验证
+## 步骤2:验证
重启 TRAE。在设置里确认 `openviking` 已连接。