Skip to content

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

docs(plugins): point READMEs at the one-line installer (#5994)

t0saki172d4d9e2e1f
diff --git a/examples/agent-hook-plugin/README.md b/examples/agent-hook-plugin/README.md
index 6658e34cd..cd07b31e3 100644
--- a/examples/agent-hook-plugin/README.md
+++ b/examples/agent-hook-plugin/README.md
@@ -3,12 +3,11 @@
Cursor, TRAE, TRAE CN and ZCode use host configuration files. Kimi Code uses its native managed-plugin directory. They share the same dispatcher and memory runtime; the installer assembles the runtime at install time rather than committing a copy per host.
```bash
-bash examples/memory-plugin-shared/install.sh --harness cursor
-bash examples/memory-plugin-shared/install.sh --harness trae,trae-cn
-bash examples/memory-plugin-shared/install.sh --harness zcode
-bash examples/memory-plugin-shared/install.sh --harness kimicode
+curl -fsSL https://openviking.ai/install | bash
```
+The installer asks which harnesses to install and for your OpenViking credentials. To install from a repository checkout instead, run `bash examples/memory-plugin-shared/install.sh --harness <cursor|trae|trae-cn|zcode|kimicode>` from its root.
+
> **Requires an OpenViking server with `viking://~` home-alias support.** Recall targets the caller's own context space through `viking://~/memories` and `viking://~/skills`; the uid-less `viking://user/memories` shorthand is rejected by newer servers.
## What the hooks do
diff --git a/examples/agent-hook-plugin/README_CN.md b/examples/agent-hook-plugin/README_CN.md
index d8229c62a..c14be7f9d 100644
--- a/examples/agent-hook-plugin/README_CN.md
+++ b/examples/agent-hook-plugin/README_CN.md
@@ -3,12 +3,11 @@
Cursor、TRAE、TRAE CN 与 ZCode 使用宿主配置文件;Kimi Code 使用原生托管插件目录。它们共用同一个 dispatcher 和记忆运行时,安装脚本在安装时组装依赖,不在仓库里为每个宿主提交共享代码副本。
```bash
-bash examples/memory-plugin-shared/install.sh --harness cursor
-bash examples/memory-plugin-shared/install.sh --harness trae,trae-cn
-bash examples/memory-plugin-shared/install.sh --harness zcode
-bash examples/memory-plugin-shared/install.sh --harness kimicode
+curl -fsSL https://openviking.ai/install | bash
```
+安装脚本会询问要安装哪些宿主以及 OpenViking 连接信息。要从仓库 checkout 安装,在仓库根目录运行 `bash examples/memory-plugin-shared/install.sh --harness <cursor|trae|trae-cn|zcode|kimicode>`。
+
> **需要支持 `viking://~` home alias 的 OpenViking 服务端。** 召回通过 `viking://~/memories` 与 `viking://~/skills` 指向调用者自己的上下文空间;不带 uid 的 `viking://user/memories` 简写会被较新的服务端拒绝。
## Hook 做什么
diff --git a/examples/agent-hook-plugin/hosts/cursor/openviking.integration.json b/examples/agent-hook-plugin/hosts/cursor/openviking.integration.json
index af22f33b5..7d7b18b9f 100644
--- a/examples/agent-hook-plugin/hosts/cursor/openviking.integration.json
+++ b/examples/agent-hook-plugin/hosts/cursor/openviking.integration.json
@@ -1,7 +1,7 @@
{
"schemaVersion": 1,
"id": "openviking-memory",
- "version": "0.5.18",
+ "version": "0.5.19",
"clients": [
"cursor"
],
diff --git a/examples/agent-hook-plugin/hosts/kimicode/kimi.plugin.json b/examples/agent-hook-plugin/hosts/kimicode/kimi.plugin.json
index 7f5008087..9eb30d9e4 100644
--- a/examples/agent-hook-plugin/hosts/kimicode/kimi.plugin.json
+++ b/examples/agent-hook-plugin/hosts/kimicode/kimi.plugin.json
@@ -1,6 +1,6 @@
{
"name": "openviking-memory",
- "version": "0.5.18",
+ "version": "0.5.19",
"description": "Long-term semantic memory for Kimi Code CLI, powered by OpenViking.",
"author": {
"name": "OpenViking",
diff --git a/examples/agent-hook-plugin/hosts/kimicode/openviking.integration.json b/examples/agent-hook-plugin/hosts/kimicode/openviking.integration.json
index a5b02bd0f..6ac56bfaf 100644
--- a/examples/agent-hook-plugin/hosts/kimicode/openviking.integration.json
+++ b/examples/agent-hook-plugin/hosts/kimicode/openviking.integration.json
@@ -1,7 +1,7 @@
{
"schemaVersion": 1,
"id": "openviking-memory",
- "version": "0.5.18",
+ "version": "0.5.19",
"clients": [
"kimicode"
],
diff --git a/examples/agent-hook-plugin/hosts/trae/openviking.integration.json b/examples/agent-hook-plugin/hosts/trae/openviking.integration.json
index b82ce6880..f748d0a24 100644
--- a/examples/agent-hook-plugin/hosts/trae/openviking.integration.json
+++ b/examples/agent-hook-plugin/hosts/trae/openviking.integration.json
@@ -1,7 +1,7 @@
{
"schemaVersion": 1,
"id": "openviking-memory",
- "version": "0.5.18",
+ "version": "0.5.19",
"clients": [
"trae",
"trae-cn"
diff --git a/examples/agent-hook-plugin/hosts/zcode/openviking.integration.json b/examples/agent-hook-plugin/hosts/zcode/openviking.integration.json
index 87690e1bc..ab494e00b 100644
--- a/examples/agent-hook-plugin/hosts/zcode/openviking.integration.json
+++ b/examples/agent-hook-plugin/hosts/zcode/openviking.integration.json
@@ -1,7 +1,7 @@
{
"schemaVersion": 1,
"id": "openviking-memory",
- "version": "0.5.18",
+ "version": "0.5.19",
"clients": [
"zcode"
],
diff --git a/examples/agent-hook-plugin/plugin.json b/examples/agent-hook-plugin/plugin.json
index 13bc87b76..711307aee 100644
--- a/examples/agent-hook-plugin/plugin.json
+++ b/examples/agent-hook-plugin/plugin.json
@@ -1,6 +1,6 @@
{
"name": "agent-hook-plugin",
- "version": "0.5.18",
+ "version": "0.5.19",
"description": "Long-term semantic memory for Cursor, TRAE, TRAE CN, ZCode and Kimi Code — powered by OpenViking. Auto-recall relevant memories and capture the conversation as it happens.",
"author": {
"name": "OpenViking",
diff --git a/examples/opencode-plugin/INSTALL-ZH.md b/examples/opencode-plugin/INSTALL-ZH.md
index 551964964..fa779ad3a 100644
--- a/examples/opencode-plugin/INSTALL-ZH.md
+++ b/examples/opencode-plugin/INSTALL-ZH.md
@@ -28,9 +28,19 @@ openviking-server --config ~/.openviking/ov.conf
curl http://localhost:1933/health
```
-## 安装方式一:发布包安装
+## 安装方式一:一键安装(推荐)
-普通用户推荐通过 OpenCode 的 package plugin 机制启用:
+OpenCode 与其他记忆插件共用同一个安装器。它会询问要安装的宿主和 OpenViking 凭据:
+
+```bash
+curl -fsSL https://openviking.ai/install | bash
+```
+
+安装器会把插件作为本地文件插件复制到 `~/.config/opencode/plugins/`,把 `openviking` MCP server 条目写进 `~/.config/opencode/opencode.json`,并配置 `~/.openviking/ovcli.conf`。
+
+## 安装方式二:发布包安装
+
+也可以通过 OpenCode 的 package plugin 机制启用:
```json
{
@@ -40,7 +50,7 @@ curl http://localhost:1933/health
这份 `plugin` 配置同时兼容 v1 和 v2;v2 会在加载时规范化为原生的 `plugins`,无需手工迁移配置。
-## 安装方式二:源码安装
+## 安装方式三:源码安装
用于开发调试或 PR 测试。OpenCode 推荐插件目录:
diff --git a/examples/opencode-plugin/INSTALL.md b/examples/opencode-plugin/INSTALL.md
index 9971787f4..b90bf80a2 100644
--- a/examples/opencode-plugin/INSTALL.md
+++ b/examples/opencode-plugin/INSTALL.md
@@ -28,9 +28,19 @@ Check the service:
curl http://localhost:1933/health
```
-## Installation Method 1: Published Package
+## Installation Method 1: One-line Installer (Recommended)
-Normal users are recommended to enable it through OpenCode's package plugin mechanism:
+OpenCode shares the unified installer with the other memory plugins. It asks which harnesses to install and for your OpenViking credentials:
+
+```bash
+curl -fsSL https://openviking.ai/install | bash
+```
+
+The installer copies the plugin into `~/.config/opencode/plugins/` as a local file plugin, writes the `openviking` MCP server entry into `~/.config/opencode/opencode.json`, and configures `~/.openviking/ovcli.conf`.
+
+## Installation Method 2: Published Package
+
+To enable it through OpenCode's package plugin mechanism instead:
```json
{
@@ -40,7 +50,7 @@ Normal users are recommended to enable it through OpenCode's package plugin mech
This `plugin` entry works on both v1 and v2. OpenCode v2 normalizes it to the native `plugins` form at load time, so no manual config migration is required.
-## Installation Method 2: Source Install
+## Installation Method 3: Source Install
Use this method for development, debugging, or PR testing. OpenCode's recommended plugin directory is:
diff --git a/examples/opencode-plugin/README.md b/examples/opencode-plugin/README.md
index 33e0f94f7..b4655c5ea 100644
--- a/examples/opencode-plugin/README.md
+++ b/examples/opencode-plugin/README.md
@@ -68,9 +68,19 @@ openviking-server --config ~/.openviking/ov.conf
## Installation
+### One-line Installer (Recommended)
+
+OpenCode shares the unified installer with the other memory plugins. It asks which harnesses to install and for your OpenViking credentials:
+
+```bash
+curl -fsSL https://openviking.ai/install | bash
+```
+
+The installer copies the plugin into `~/.config/opencode/plugins/` as a local file plugin, writes the `openviking` MCP server entry into `~/.config/opencode/opencode.json`, and configures `~/.openviking/ovcli.conf`.
+
### Published Package
-Normal users should enable it through OpenCode's package plugin mechanism:
+To enable it through OpenCode's package plugin mechanism instead:
The published npm package is `@openviking/opencode-plugin`; verify availability with:
diff --git a/examples/opencode-plugin/package.json b/examples/opencode-plugin/package.json
index aa50eac87..46bf31f46 100644
--- a/examples/opencode-plugin/package.json
+++ b/examples/opencode-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@openviking/opencode-plugin",
- "version": "0.5.12",
+ "version": "0.5.13",
"author": "@openviking",
"description": "Unified OpenCode plugin for OpenViking repository retrieval and long-term memory",
"type": "module",
diff --git a/examples/pi-coding-agent-extension/README.md b/examples/pi-coding-agent-extension/README.md
index 2658a0af6..62799e5da 100644
--- a/examples/pi-coding-agent-extension/README.md
+++ b/examples/pi-coding-agent-extension/README.md
@@ -30,12 +30,14 @@ curl http://localhost:1933/health # or your remote URL
### 2. Install the extension
-Use the shared installer:
+pi shares the unified installer with the other memory plugins. It asks which harnesses to install and for your OpenViking credentials:
```bash
-bash examples/memory-plugin-shared/install.sh --harness pi
+curl -fsSL https://openviking.ai/install | bash
```
+From a repository checkout, `bash examples/memory-plugin-shared/install.sh --harness pi` installs the checkout's extension instead.
+
The installer installs the locked npm dependencies in a temporary directory before replacing the extension at `~/.pi/agent/extensions/openviking`, which is one of pi's auto-discovery roots, so pi loads it on the next `pi` invocation — no `packages` entry is needed. (Registering the same path with `pi install` would load it twice, so the installer avoids that and clears any stale entry left by older versions.)
For a manual copy, generate the shared runtime first, copy the extension, and install its dependencies:
diff --git a/examples/pi-coding-agent-extension/package-lock.json b/examples/pi-coding-agent-extension/package-lock.json
index 9a1e82b5d..2ea799f70 100644
--- a/examples/pi-coding-agent-extension/package-lock.json
+++ b/examples/pi-coding-agent-extension/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "openviking-pi-extension",
- "version": "0.4.17",
+ "version": "0.4.18",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "openviking-pi-extension",
- "version": "0.4.17",
+ "version": "0.4.18",
"dependencies": {
"@modelcontextprotocol/client": "2.0.0"
},
diff --git a/examples/pi-coding-agent-extension/package.json b/examples/pi-coding-agent-extension/package.json
index 94ebc9c74..d08dc35dc 100644
--- a/examples/pi-coding-agent-extension/package.json
+++ b/examples/pi-coding-agent-extension/package.json
@@ -1,6 +1,6 @@
{
"name": "openviking-pi-extension",
- "version": "0.4.17",
+ "version": "0.4.18",
"description": "OpenViking memory and context extension for the pi coding agent",
"private": true,
"type": "module",