Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
docs(agents): sync latest zh follow-ups and fix agent-cli rendering (#2432)
Lilimamama925cbcfcfa46
diff --git a/docs/images/agents/en/agent-cli.md b/docs/images/agents/en/agent-cli.mdindex f0f1e017b..78c3a600c 100644--- a/docs/images/agents/en/agent-cli.md+++ b/docs/images/agents/en/agent-cli.md@@ -1,12 +1,15 @@-# Agent CLI Integration--For AI agents. Send the following instruction to your agent so it can install and configure OpenViking CLI, then learn how to use it.+Copy the following prompt to your AI assistant (Claude Code, Codex, Cursor, Trae, and so on). It will automatically complete OpenViking CLI installation, configuration, and usage learning:```text-Write the following content to ~/.openviking/ovcli.conf:-{"url":"https://api.vikingdb.cn-beijing.volces.com/openviking","api_key":"Please ask user for Volcengine OpenViking API key."}+First ask the user for the OpenViking API Key and store it as OPENVIKING_API_KEY.++Write the following content to ~/.openviking/ovcli.conf, replacing ${OPENVIKING_API_KEY} with the actual value provided by the user:+{+ "url": "https://api.vikingdb.cn-beijing.volces.com/openviking",+ "api_key": "${OPENVIKING_API_KEY}"+}-Ask the user for the API Key. If ~/.openviking/ovcli.conf already exists and the content conflicts, ask the user whether to back up the original file before overwriting it.+If ~/.openviking/ovcli.conf already exists and the content conflicts, ask the user whether to back up the original file before overwriting it.Install OpenViking CLI:npm i -g @openviking/clidiff --git a/docs/images/agents/en/cli.md b/docs/images/agents/en/cli.mdindex e728a2f36..3456af220 100644--- a/docs/images/agents/en/cli.md+++ b/docs/images/agents/en/cli.md@@ -1,17 +1,20 @@-For developers who want to install, configure, and use OpenViking CLI directly from a local terminal.+Copy and run the following commands step by step in your terminal to complete OpenViking CLI installation, configuration, and usage:-### Step 1: Run the following command in your terminal to install OpenViking CLI and enter the configuration flow:+### Step 1: Install OpenViking CLI and enter the configuration flow:```bashnpm i -g @openviking/cli && ov config```-### Step 2: When prompted, enter the OpenViking service URL and API Key. You can use the following service URL:+### Step 2: When prompted, enter the OpenViking Base URL and API Key+- Base URL: Copy the following Base URL into your terminal```texthttps://api.vikingdb.cn-beijing.volces.com/openviking```+- API Key: Copy the API Key shown on the page into your terminal+### Step 3: After configuration, run the following command to view CLI usage:```bashdiff --git a/docs/images/agents/en/hermes.md b/docs/images/agents/en/hermes.mdindex a065ec639..05bfdb8a1 100644--- a/docs/images/agents/en/hermes.md+++ b/docs/images/agents/en/hermes.md@@ -6,15 +6,20 @@hermes memory setup```-The wizard asks for:+## Step 2: Copy the Base URL and API Key-- **OpenViking service URL** - A self-hosted server (default `http://127.0.0.1:1933`) or Volcengine OpenViking Cloud-- **API Key** - Leave empty for local development mode-- **Tenant account / user / agent ID** - Used for multi-tenant deployments+After running the setup command, Hermes prompts for the Base URL and API Key. Copy them and paste them into Hermes:++- Base URL: Copy the following Base URL into Hermes:+```text+https://api.vikingdb.cn-beijing.volces.com/openviking+```+- API Key: Copy the API Key shown on the page into your Hermes terminal+- Tenant account / user / agent ID: Used for multi-tenant deploymentsThe configuration is saved to Hermes `config.yaml` and `.env` files.-## Step 2: Verify Hermes memory status+## Step 3: Verify Hermes memory status```bashhermes memory statusdiff --git a/docs/images/agents/zh/agent-cli.md b/docs/images/agents/zh/agent-cli.mdindex 59567e7a6..b748ad401 100644--- a/docs/images/agents/zh/agent-cli.md+++ b/docs/images/agents/zh/agent-cli.md@@ -1,12 +1,16 @@-# Agent CLI 接入-面向 AI Agent 使用。把下面的指令发送给你的 Agent,让它完成 OpenViking CLI 安装、配置和用法学习。+将下方提示词复制给你的 AI 助手(Claude Code、Codex、Cursor、Trae 等),它会自动完成 OpenViking CLI 安装、配置和用法学习:```text-请在 ~/.openviking/ovcli.conf 写入以下内容:-{"url":"https://api.vikingdb.cn-beijing.volces.com/openviking","api_key":"Please ask user for Volcengine OpenViking API key."}+请先向用户询问 OpenViking API Key,并记为 OPENVIKING_API_KEY。-请向用户询问 API Key。如发现 ~/.openviking/ovcli.conf 已存在且内容冲突,请先询问用户是否备份原文件,并在得到确认后再覆盖。+请在 ~/.openviking/ovcli.conf 写入以下内容(将 ${OPENVIKING_API_KEY} 替换为用户提供的实际值):+{+ "url": "https://api.vikingdb.cn-beijing.volces.com/openviking",+ "api_key": "${OPENVIKING_API_KEY}"+}++如发现 ~/.openviking/ovcli.conf 已存在且内容冲突,请先询问用户是否备份原文件,并在得到确认后再覆盖。请安装 OpenViking CLI:npm i -g @openviking/clidiff --git a/docs/images/agents/zh/cli.md b/docs/images/agents/zh/cli.mdindex a278454ec..0c19fac72 100644--- a/docs/images/agents/zh/cli.md+++ b/docs/images/agents/zh/cli.md@@ -1,18 +1,20 @@-面向开发者在本地终端直接安装、配置和使用 OpenViking CLI。+按步骤复制以下命令到你的终端,运行即可完成安装、配置和使用 OpenViking CLI:-### 步骤1:在终端执行以下命令安装 OpenViking CLI,并进入配置流程:+### 步骤1:安装 OpenViking CLI,并进入配置流程:```bashnpm i -g @openviking/cli && ov config```-### 步骤2:按提示填写 OpenViking 服务地址和 API Key。服务地址可使用:+### 步骤2:按提示填写 OpenViking Base URL 和 API Key+- Base URL: 复制以下 Base URL 到你的终端```texthttps://api.vikingdb.cn-beijing.volces.com/openviking```+- API Key: 复制以下 API Key 到你的终端### 步骤3:配置完成后,可运行以下命令查看 CLI 用法:diff --git a/docs/images/agents/zh/hermes.md b/docs/images/agents/zh/hermes.mdindex 2ae60b7a1..cc6b79848 100644--- a/docs/images/agents/zh/hermes.md+++ b/docs/images/agents/zh/hermes.md@@ -7,16 +7,20 @@hermes memory setup```-向导会询问:+## 步骤 2:复制 Base URL 和 API Key+执行 setup 命令后会依次提示输入 Base URL 和 API Key,可复制后粘贴到你的 Hermes:-- **OpenViking 服务 URL** — 自托管服务器(默认 `http://127.0.0.1:1933`)或火山引擎 OpenViking Cloud-- **API Key** — 本地开发模式留空-- **租户 account / user / agent ID** — 多租户部署时使用+- Base URL: 复制以下 Base URL 到你的 Hermes:+```text+https://api.vikingdb.cn-beijing.volces.com/openviking+```+- API Key: 复制页面中展示的 API Key 到你的 Hermes 终端+- 租户 account / user / agent ID:多租户部署时使用配置保存在 Hermes 的 `config.yaml` 和 `.env` 文件中。-## 步骤 2:验证 Hermes 记忆状态+## 步骤 3:验证 Hermes 记忆状态```bashhermes memory status