Skip to content

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

docs(readme): improve copy while preserving layout (#4931)

Zayn Jarvis420dfa42b488
diff --git a/README.md b/README.md
index 4944cd3d4..4c8c232cc 100644
--- a/README.md
+++ b/README.md
@@ -31,21 +31,24 @@ English / [中文](README_CN.md) / [日本語](README_JA.md)
## What is OpenViking
-OpenViking is an open-source context database for AI agents. It stores memories, resources, and skills as one virtual filesystem under the `viking://` protocol, so an agent browses its own context with `ls`, `tree`, and `find` instead of querying a black-box vector store. Content is processed into three tiers — L0 abstract, L1 overview, L2 details — and loaded on demand. Every retrieval leaves a trajectory you can watch and debug. Full introduction: [Getting started](https://docs.openviking.ai/en/getting-started/01-introduction).
+OpenViking is an open-source context database for AI agents. It gives agents a place to store knowledge, remember users, and reuse experience across sessions.
-[![OpenViking Studio playground](docs/images/studio-playground.png)](https://openviking.ai/studio)
+OpenViking organizes context as a virtual filesystem under `viking://`. Agents can operate on it like files: use `ls`, `tree`, `read`, and `write` to browse directories, read, create, and edit content, or search within a directory. Directory summaries support on-demand loading.
-*The [OpenViking Studio](https://openviking.ai/studio) playground — a live demo you can open in the browser, no installation required.*
+<a href="https://openviking.ai/studio" target="_blank" rel="noopener noreferrer">
+ <img src="docs/images/studio-playground.png" alt="OpenViking Studio: browse context and try semantic search">
+</a>
+
+[Try OpenViking Studio](https://openviking.ai/studio) in your browser, no installation required. [Self-host Web Studio](web-studio/README.md).
## Why OpenViking
-- **One filesystem for all context.** Memories, resources, and skills each get a `viking://` URI. Agents locate and manipulate context deterministically, like a developer working with files. → [Viking URI](https://docs.openviking.ai/en/concepts/04-viking-uri) · [Context types](https://docs.openviking.ai/en/concepts/02-context-types)
-- **Tiered loading cuts token spend.** Every entry is processed into L0 (abstract), L1 (overview), and L2 (details) on write, then loaded only as deep as the task requires. → [Context layers](https://docs.openviking.ai/en/concepts/03-context-layers)
-- **Directory recursive retrieval.** Vector search first locates the highest-scoring directory, then drills down layer by layer, so results arrive with their surrounding context intact. → [Retrieval](https://docs.openviking.ai/en/concepts/07-retrieval)
-- **Observable retrieval.** Each query preserves its directory-browsing trajectory. When a result looks wrong, you can see exactly which path produced it. → [Retrieval](https://docs.openviking.ai/en/concepts/07-retrieval)
-- **Sessions become memory.** After a session commits, OpenViking asynchronously extracts user preferences and agent experience into long-term memory. → [Session](https://docs.openviking.ai/en/concepts/08-session)
+- **One filesystem for all context.** Resources hold documents and code; memories retain user preferences and experience; skills define how to perform tasks. Each has a `viking://` URI for browsing and retrieval. → [Viking URI](https://docs.openviking.ai/en/concepts/04-viking-uri) · [Context types](https://docs.openviking.ai/en/concepts/02-context-types)
+- **Load only the context you need.** Directory abstracts (L0) and overviews (L1) help agents decide when to read full content (L2). → [Context layers](https://docs.openviking.ai/en/concepts/03-context-layers)
+- **Search within the directory structure.** Vector search finds candidate directories, then explores their contents. `find` runs a query directly; `search` can use session context to plan retrieval. → [Retrieval](https://docs.openviking.ai/en/concepts/07-retrieval)
+- **Turn sessions into memory.** Committing a session archives the conversation and starts background extraction. Memory policies control what is retained; candidates are compared with existing memories for creation, merging, or skipping. With VikingBot enabled, `ov compile` uses a skill to organize source material into a wiki, knowledge graph, or report. → [Sessions](https://docs.openviking.ai/en/concepts/08-session) · [Context compilation](https://docs.openviking.ai/en/context-compilation/01-overview)
-How the pieces fit together: [Architecture](https://docs.openviking.ai/en/concepts/01-architecture). The thinking behind the design: [The Database Paradigm for Context Engineering](https://blog.openviking.ai/post/openviking-context-database/).
+[Architecture](https://docs.openviking.ai/en/concepts/01-architecture) · [Design rationale](https://blog.openviking.ai/post/openviking-context-database/)
```
viking://
@@ -76,15 +79,15 @@ The three loading tiers:
- **L1 (Overview)**: core information and usage scenarios for planning.
- **L2 (Details)**: the full original data, read only when needed.
-Each directory carries its own L0/L1 layers, so relevance can be judged before any full file is read:
+Semantically processed directories carry L0/L1 summaries, so agents can judge relevance before reading full files:
```
viking://resources/my_project/
-├── .abstract # L0: ~100 tokens - quick relevance check
-├── .overview # L1: ~2k tokens - structure and key points
+├── .abstract.md # L0: quick relevance check
+├── .overview.md # L1: structure and key points
└── docs/
- ├── .abstract
- ├── .overview
+ ├── .abstract.md
+ ├── .overview.md
└── api/
├── auth.md # L2: full content, loaded on demand
└── endpoints.md
@@ -106,25 +109,23 @@ The memory evaluation used [Doubao 2.0 Pro](https://console.volcengine.com/ark/r
## Quick start
-> 💡 **Want to see it in action first?** Try [OpenViking Studio](https://openviking.ai/studio) — a live hosted instance with a context playground, semantic search, and a multi-agent hub. No installation required.
-
-Requires Python 3.10 or higher.
+Requires Python 3.10+ and access to an embedding model and a VLM (cloud or local).
```bash
pip install openviking --upgrade
-openviking-server init # interactive wizard: providers, models, ov.conf
-openviking-server doctor # validate setup
-openviking-server # start (background: nohup openviking-server > openviking.log 2>&1 &)
+openviking-server init # configure providers and models
+openviking-server doctor # check configuration and connectivity
+openviking-server # start the server
```
-`init` walks you through provider setup and writes `~/.openviking/ov.conf`. It supports Volcengine, OpenAI, Codex OAuth, Kimi, GLM, and local Ollama — for Ollama it can detect and install the runtime and pull models suited to your hardware. `doctor` checks the config file, Python version, provider connectivity, and disk space without a running server. Manual `ov.conf` templates, per-provider examples, environment variables, and Windows setup: [Configuration guide](https://docs.openviking.ai/en/guides/01-configuration) · [Quick start docs](https://docs.openviking.ai/en/getting-started/02-quickstart).
+`init` writes `~/.openviking/ov.conf`. Supported options include Volcengine, OpenAI, Codex OAuth, Kimi, GLM, and local Ollama. See the [configuration guide](https://docs.openviking.ai/en/guides/01-configuration) for provider setup and the [quick start docs](https://docs.openviking.ai/en/getting-started/02-quickstart) for platform instructions.
-The install already includes the `ov` client CLI. With the server running:
+The package includes the `ov` CLI. In another terminal, import a repository and search it:
```bash
ov status
ov add-resource https://github.com/volcengine/OpenViking
-# Replace TASK_ID with the returned task_id; continue after status is completed
+# Replace TASK_ID with the returned task_id; repeat until status is completed
ov task status TASK_ID
ov ls viking://resources/
ov tree viking://resources/volcengine -L 2
@@ -132,10 +133,9 @@ ov find "what is openviking"
ov grep "openviking" --uri viking://resources/volcengine/OpenViking/docs/en
```
-Next steps:
+`ov find` returns matching context with URIs you can inspect. For client configuration (`ov config`), standalone CLI installs, and index maintenance, see [CLI setup](https://docs.openviking.ai/en/getting-started/05-cli-setup).
-- Client configuration (`ov config`), standalone CLI installs (npm / cargo), and advanced usage such as index rebuilding: [CLI setup](https://docs.openviking.ai/en/getting-started/05-cli-setup)
-- Docker and production deployment: [Deployment guide](https://docs.openviking.ai/en/guides/03-deployment)
+Build your own integration with the [Python](sdk/python/README.md), [Go](sdk/go/README.md), or [TypeScript](sdk/typescript/README.md) SDK, or the [HTTP API](https://docs.openviking.ai/en/api/01-overview).
## Use it with your agent
@@ -145,43 +145,43 @@ Connect your agent to OpenViking for cross-session memory. Choose a native integ
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/02-claude-code"><img src="docs/images/agents/image/claude-code/logo.png" width="32" height="32" alt=""><br><strong>Claude</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/04-codex"><img src="docs/images/integrations/codex.png" width="32" height="32" alt=""><br><strong>Codex</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/12-cursor"><img src="docs/images/agents/image/cursor/logo.png" width="32" height="32" alt=""><br><strong>Cursor</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
</tr>
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/13-trae"><img src="docs/images/agents/image/trae/logo.png" width="32" height="32" alt=""><br><strong>TRAE</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/03-openclaw"><img src="docs/images/integrations/openclaw.jpg" width="24" height="24" alt=""><br><strong>OpenClaw</strong></a><br>
-<sub>Context&nbsp;engine</sub>
+<sub>Context engine</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/05-hermes"><img src="docs/images/integrations/hermes-agent.png" width="24" height="24" alt=""><br><strong>Hermes</strong></a><br>
-<sub>Built-in&nbsp;memory</sub>
+<sub>Built-in memory</sub>
</td>
</tr>
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/10-opencode"><img src="docs/images/agents/image/opencode/logo.png" width="32" height="32" alt=""><br><strong>OpenCode</strong></a><br>
-<sub>Plugin&nbsp;+&nbsp;MCP</sub>
+<sub>Plugin + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/11-pi"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/pi-dark.svg"><img src="docs/images/integrations/pi.svg" width="41" height="41" alt=""></picture><br><strong>pi</strong></a><br>
-<sub>Native&nbsp;extension</sub>
+<sub>Native extension</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="docs/images/agents/en/deerflow-memory-manager.md"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/deerflow-dark.svg"><img src="docs/images/integrations/deerflow.svg" width="19" height="24" alt=""></picture><br><strong>DeerFlow</strong></a><br>
-<sub>Memory&nbsp;+&nbsp;MCP</sub>
+<sub>Plugin + MCP</sub>
</td>
</tr>
</table>
@@ -206,11 +206,7 @@ For setup instructions and integration details, see [Integrations](https://openv
## OpenViking Helper (Beta)
-OpenViking Helper is a desktop console, currently in beta for macOS and Windows x64:
-
-- **Visual local agent setup**: detects OpenViking CLI, Claude Code, Codex, Cursor, Trae, and OpenCode, then configures supported plugin, MCP, Hook, and CLI integrations.
-- **Session trace inspection**: parses Claude Code, Codex, and Trae sessions to show OpenViking recall, prompt injection, MCP calls, capture, and commit events.
-- **Local memory and skill management**: views local memory / rule files and `SKILL.md` skills, then syncs them to OpenViking.
+OpenViking Helper is a desktop console for macOS and Windows x64 (beta). It configures supported local agent integrations, inspects recall and capture events in sessions, and syncs local memories and skills to OpenViking.
Download:
@@ -232,13 +228,11 @@ The official Docker image bundles VikingBot and starts it by default alongside t
## Deploy in production
-For production, run OpenViking as a standalone HTTP service — see [Server deployment](https://docs.openviking.ai/en/getting-started/03-quickstart-server) and the [Deployment guide](https://docs.openviking.ai/en/guides/03-deployment).
-
-## Commercial editions
+Run the open-source server in your own environment under [AGPLv3](LICENSE). It requires no activation key. Start with [server setup](https://docs.openviking.ai/en/getting-started/03-quickstart-server) or the [Docker and deployment guide](https://docs.openviking.ai/en/guides/03-deployment).
-**The open-source edition is not crippled.** OpenViking in this repo is fully open source under AGPLv3: no feature gates, no account required, no activation key. Follow [Deploy in production](#deploy-in-production) above and run it in production yourself — and that will stay true.
+The server supports [accounts and user isolation](https://docs.openviking.ai/en/concepts/11-multi-tenant) and opt-in [resource ACLs](https://docs.openviking.ai/en/concepts/15-acl). Configure [authentication](https://docs.openviking.ai/en/guides/04-authentication) before exposing it beyond localhost.
-The two editions below answer "who operates it and where it runs", not "can I use it".
+## Commercial editions
<table>
<tr>
@@ -247,14 +241,7 @@ The two editions below answer "who operates it and where it runs", not "can I us
<img src="docs/images/commercial-saas.png" alt="Managed SaaS" width="100%" />
<h3>☁️ Managed SaaS</h3>
-<p>Officially hosted on <b>Volcano Engine</b>. Nothing to set up, nothing to operate.</p>
-<ul>
-<li><b>Personal</b> — for individual developers. Free trial for up to 50 files, and scales far beyond local hardware with VikingDB.</li>
-<li><b>Enterprise</b> — multi-user context management, team collaboration and permissions, enterprise SLA and support.</li>
-</ul>
-<p>Existing open-source users can move over with the migration tool.</p>
-<p><a href="https://www.volcengine.com/product/openviking-service"><b>→ Volcano Engine product page</b></a> · <a href="https://docs.volcengine.com/docs/84313/2374478">Documentation</a></p>
-<p><sub>Global hosting for regions outside China is coming to <a href="https://www.byteplus.com">BytePlus</a>.</sub></p>
+<p><a href="https://www.volcengine.com/product/openviking-service">Volcano Engine</a> hosts and operates OpenViking. Personal and Enterprise plans cover individual and team use, with migration tooling for open-source deployments. See the <a href="https://docs.volcengine.com/docs/84313/2374478">service documentation</a> for plans and limits. Hosting outside China is planned on <a href="https://www.byteplus.com">BytePlus</a>.</p>
</td>
<td width="50%" valign="top">
@@ -262,20 +249,12 @@ The two editions below answer "who operates it and where it runs", not "can I us
<img src="docs/images/commercial-self-hosted.png" alt="Self-Managed" width="100%" />
<h3>🏢 Self-Managed</h3>
-<p>Runs <b>inside your own environment</b>. Data never leaves it.</p>
-<ul>
-<li><b>Online</b> — deployed into your own cloud account / VPC, BYOC supported, with outbound access for updates and licensing.</li>
-<li><b>Offline</b> — fully air-gapped environments with no internet access, for regulated industries.</li>
-</ul>
-<p>Adds distributed deployment and official support on top of the open-source edition, activated by license key.</p>
-<p><a href="https://docs.google.com/forms/d/e/1FAIpQLScQqwsm7fvKdjtNiW5rWNXJjoHPtedVzLsKSMJgObtsj2_udA/viewform"><b>→ Talk to us about self-managed deployment</b></a></p>
+<p>Deploy in your own cloud account / VPC (BYOC) or an offline environment. This edition adds distributed deployment and official support, activated by a license key. <a href="https://docs.google.com/forms/d/e/1FAIpQLScQqwsm7fvKdjtNiW5rWNXJjoHPtedVzLsKSMJgObtsj2_udA/viewform">Contact the team</a>.</p>
</td>
</tr>
</table>
-> Just want to run the open-source edition? Go ahead — you don't need to contact anyone. Head to [Quick start](#quick-start).
-
## Research
**Memory that evolves with your agent.** VikingMem develops an event-driven approach to extracting, updating, and consolidating long-term memory, giving stateful agents a way to retain useful experience as interactions accumulate. OpenViking open-sources a subset of these core capabilities.
@@ -301,19 +280,15 @@ The two editions below answer "who operates it and where it runs", not "can I us
## Partner Projects
-OpenViking welcomes collaboration with other open-source projects to build the context data ecosystem. Our confirmed partners include:
-
- [deer-flow](https://github.com/bytedance/deer-flow) - Open-source long-horizon SuperAgent harness
- [NoKV](https://github.com/NoKV-Lab/NoKV) - AI native distributed file system
- [loopx](https://github.com/huangruiteng/loopx) - Lightweight loop engineering state kernel
- [Hermes Agent](https://github.com/NousResearch/hermes-agent) - The agent that grows with you
-Interested in joining our partner list? Please submit an issue to our community to apply.
+To propose a partnership, [open an issue](https://github.com/volcengine/OpenViking/issues).
## Community & contributing
-OpenViking is still in its early stages, and there is plenty left to build.
-
- **Docs**: [docs.openviking.ai](https://docs.openviking.ai/) · [FAQ](https://docs.openviking.ai/en/faq/faq)
- **Blog**: [blog.openviking.ai](https://blog.openviking.ai/)
- **Team**: [About us](https://docs.openviking.ai/en/about/01-about-us)
@@ -322,7 +297,6 @@ OpenViking is still in its early stages, and there is plenty left to build.
## Security and privacy
-This project takes security seriously.
For vulnerability reporting and supported versions, see [SECURITY.md](SECURITY.md)
## License
diff --git a/README_CN.md b/README_CN.md
index ca55c9b44..2e24e2c0b 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -31,21 +31,24 @@
## OpenViking 是什么
-OpenViking 是面向 AI 智能体的开源上下文数据库。记忆、资源、技能统一存放在 `viking://` 协议下的虚拟文件系统里,智能体用 `ls`、`tree`、`find` 浏览自己的上下文,不必去查一个黑盒向量库。内容写入时会处理成三层——L0 摘要、L1 概览、L2 详情——按需加载。每次检索都留下轨迹,可以查看,也可以调试。完整介绍见[入门文档](https://docs.openviking.ai/zh/getting-started/01-introduction)。
+OpenViking 是面向 AI 智能体的开源上下文数据库,用来存储知识、记住用户,并在会话之间复用经验。
-[![OpenViking Studio playground](docs/images/studio-playground.png)](https://openviking.ai/studio)
+OpenViking 将上下文组织成 `viking://` 虚拟文件系统。Agent 可以像操作文件一样,通过 `ls`、`tree`、`read`、`write` 等操作浏览目录、读取、创建和编辑内容,也可以在目录内检索。目录摘要支持按需加载。
-*[OpenViking Studio](https://openviking.ai/studio) 实验场——在线 Demo,打开浏览器就能试,无需安装。*
+<a href="https://openviking.ai/studio" target="_blank" rel="noopener noreferrer">
+ <img src="docs/images/studio-playground.png" alt="OpenViking Studio:浏览上下文,体验语义检索">
+</a>
+
+[在线体验 OpenViking Studio](https://openviking.ai/studio),无需安装。 [自行部署 Web Studio](web-studio/README_CN.md)。
## 为什么用 OpenViking
-- **一个文件系统装下所有上下文。** 记忆、资源、技能各有一个 `viking://` URI。智能体像开发者操作文件一样,确定地定位和操作上下文。→ [Viking URI](https://docs.openviking.ai/zh/concepts/04-viking-uri) · [上下文类型](https://docs.openviking.ai/zh/concepts/02-context-types)
-- **分层加载省 token。** 每条内容写入时生成 L0(摘要)、L1(概览)、L2(详情)三层,任务需要多深就加载多深。→ [上下文分层](https://docs.openviking.ai/zh/concepts/03-context-layers)
-- **目录递归检索。** 向量检索先定位得分最高的目录,再逐层向下探索,结果连同周边上下文一起返回。→ [检索机制](https://docs.openviking.ai/zh/concepts/07-retrieval)
-- **检索过程可观察。** 每次查询都保留目录浏览轨迹。结果不对时,能看到它出自哪条路径。→ [检索机制](https://docs.openviking.ai/zh/concepts/07-retrieval)
-- **会话沉淀为记忆。** 会话提交后,OpenViking 异步提取用户偏好和智能体经验,写入长期记忆。→ [会话管理](https://docs.openviking.ai/zh/concepts/08-session)
+- **用文件系统组织上下文。** 资源存放文档和代码,记忆保留用户偏好与经验,技能定义任务执行方式。每项上下文都有 `viking://` URI,供 Agent 浏览和检索。→ [Viking URI](https://docs.openviking.ai/zh/concepts/04-viking-uri) · [上下文类型](https://docs.openviking.ai/zh/concepts/02-context-types)
+- **按需加载上下文。** 目录摘要(L0)和概览(L1)帮助 Agent 判断何时读取完整内容(L2)。→ [上下文分层](https://docs.openviking.ai/zh/concepts/03-context-layers)
+- **沿目录结构检索。** 向量检索先找到候选目录,再探索其中的内容。`find` 直接执行查询,`search` 可以结合会话上下文规划检索。→ [检索机制](https://docs.openviking.ai/zh/concepts/07-retrieval)
+- **从会话提取记忆。** 提交 Session 后,会话被归档,后台按记忆策略提取内容,与已有记忆比较后新建、合并或跳过。启用 VikingBot 后,还可用 `ov compile` 配合技能,将资料整理成 Wiki、知识图谱或报告。→ [会话管理](https://docs.openviking.ai/zh/concepts/08-session) · [上下文编译](https://docs.openviking.ai/zh/context-compilation/01-overview)
-各部分如何配合:见[架构](https://docs.openviking.ai/zh/concepts/01-architecture)。设计思路:[The Database Paradigm for Context Engineering](https://blog.openviking.ai/post/openviking-context-database/)(页内可切换中文)。
+[架构](https://docs.openviking.ai/zh/concepts/01-architecture) · [设计思路](https://blog.openviking.ai/post/openviking-context-database/)
```
viking://
@@ -76,15 +79,15 @@ viking://
- **L1(概览)**:核心信息和使用场景,供规划阶段决策。
- **L2(详情)**:完整原始数据,只在需要时读取。
-每个目录都带自己的 L0/L1 层,读完整文件之前就能判断相关性:
+经过语义处理的目录带有 L0/L1 摘要,Agent 可以先判断相关性,再读取全文:
```
viking://resources/my_project/
-├── .abstract # L0:约 100 tokens——快速判断相关性
-├── .overview # L1:约 2k tokens——结构和要点
+├── .abstract.md # L0:约 100 tokens——快速判断相关性
+├── .overview.md # L1:约 2k tokens——结构和要点
└── docs/
- ├── .abstract
- ├── .overview
+ ├── .abstract.md
+ ├── .overview.md
└── api/
├── auth.md # L2:完整内容,按需加载
└── endpoints.md
@@ -106,33 +109,23 @@ OpenViking 0.3.22 的评测覆盖长对话用户记忆(LoCoMo)和多轮智
## 快速开始
-> 💡 **想先看看实际效果?** 试试 [OpenViking Studio](https://openviking.ai/studio)——官方托管的在线实例,带上下文实验场、语义检索和多智能体 Hub,无需安装。
-
-需要 Python 3.10 或更高版本。
+需要 Python 3.10+,以及可调用的 Embedding 模型和 VLM(云端或本地)。
```bash
pip install openviking --upgrade
-openviking-server init # 交互式向导:提供商、模型、ov.conf
-openviking-server doctor # 校验配置
-openviking-server # 启动
-```
-
-或者在后台运行:
-
-```bash
-nohup openviking-server > /data/log/openviking.log 2>&1 &
+openviking-server init # 配置模型与提供商
+openviking-server doctor # 检查配置与连通性
+openviking-server # 启动服务器
```
-`init` 引导你完成提供商配置,并写入 `~/.openviking/ov.conf`。它支持火山引擎、OpenAI、Codex OAuth、Kimi、GLM 和本地 Ollama——选 Ollama 时还能检测并安装运行时,按你的硬件拉取合适的模型。`doctor` 检查配置文件、Python 版本、提供商连通性和磁盘空间,不需要先启动服务器。
-
-手写 `ov.conf` 的模板、各提供商示例、环境变量、Windows 配置和 CLI/客户端配置,见[配置指南](https://docs.openviking.ai/zh/guides/01-configuration)和[快速入门文档](https://docs.openviking.ai/zh/getting-started/02-quickstart)。
+`init` 将配置写入 `~/.openviking/ov.conf`,支持火山引擎、OpenAI、Codex OAuth、Kimi、GLM 和本地 Ollama 等选项。模型配置见[配置指南](https://docs.openviking.ai/zh/guides/01-configuration),各平台安装说明见[快速入门文档](https://docs.openviking.ai/zh/getting-started/02-quickstart)。
-服务器跑起来之后:
+安装包包含 `ov` CLI。在另一个终端导入代码库并检索:
```bash
ov status
ov add-resource https://github.com/volcengine/OpenViking
-# 将 TASK_ID 替换为提交时返回的任务 ID;状态为 completed 后再执行后续命令
+# 将 TASK_ID 替换为返回的 task_id;重复查询,直到状态为 completed
ov task status TASK_ID
ov ls viking://resources/
ov tree viking://resources/volcengine -L 2
@@ -140,11 +133,9 @@ ov find "what is openviking"
ov grep "openviking" --uri viking://resources/volcengine/OpenViking/docs/zh
```
-重建已有索引:`ov reindex <uri> --mode vectors_only` 只刷新向量;`--mode semantic_and_vectors` 先重新生成语义产物(`.abstract.md`、`.overview.md`)再刷新向量;添加 `--recursive=false` 可只刷新目标目录自身的语义产物及 L0/L1 向量;`--mode prune_orphans` 清理源文件已不存在的向量记录(加 `--dry-run` 可预览)。没有 `semantic` 或 `full` 这样的模式别名。
+`ov find` 返回匹配的上下文及其 URI,可继续查看内容。客户端配置(`ov config`)、CLI 独立安装和索引维护,见 [CLI 安装](https://docs.openviking.ai/zh/getting-started/05-cli-setup)。
-客户端配置可以用 `ov config` 交互式初始化;有多台服务器时,用 `ov config switch` 切换。
-
-Rust CLI 通过 `npm i -g @openviking/cli` 安装,也可以从源码构建:`cargo install --git https://github.com/volcengine/OpenViking ov_cli`,见 [CLI 安装](https://docs.openviking.ai/zh/getting-started/05-cli-setup)。官方 Docker 镜像也已提供,见[部署指南](https://docs.openviking.ai/zh/guides/03-deployment)。
+构建自己的应用,可使用 [Python](sdk/python/README_CN.md)、[Go](sdk/go/README_CN.md)、[TypeScript](sdk/typescript/README_CN.md) SDK 或 [HTTP API](https://docs.openviking.ai/zh/api/01-overview)。
## 接入你的 Agent
@@ -154,21 +145,21 @@ Rust CLI 通过 `npm i -g @openviking/cli` 安装,也可以从源码构建:`
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/zh/agent-integrations/02-claude-code"><img src="docs/images/agents/image/claude-code/logo.png" width="32" height="32" alt=""><br><strong>Claude</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/zh/agent-integrations/04-codex"><img src="docs/images/integrations/codex.png" width="32" height="32" alt=""><br><strong>Codex</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/zh/agent-integrations/12-cursor"><img src="docs/images/agents/image/cursor/logo.png" width="32" height="32" alt=""><br><strong>Cursor</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
</tr>
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/zh/agent-integrations/13-trae"><img src="docs/images/agents/image/trae/logo.png" width="32" height="32" alt=""><br><strong>TRAE</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/zh/agent-integrations/03-openclaw"><img src="docs/images/integrations/openclaw.jpg" width="24" height="24" alt=""><br><strong>OpenClaw</strong></a><br>
@@ -182,7 +173,7 @@ Rust CLI 通过 `npm i -g @openviking/cli` 安装,也可以从源码构建:`
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/zh/agent-integrations/10-opencode"><img src="docs/images/agents/image/opencode/logo.png" width="32" height="32" alt=""><br><strong>OpenCode</strong></a><br>
-<sub>Plugin&nbsp;+&nbsp;MCP</sub>
+<sub>Plugin + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/zh/agent-integrations/11-pi"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/pi-dark.svg"><img src="docs/images/integrations/pi.svg" width="41" height="41" alt=""></picture><br><strong>pi</strong></a><br>
@@ -190,7 +181,7 @@ Rust CLI 通过 `npm i -g @openviking/cli` 安装,也可以从源码构建:`
</td>
<td align="center" valign="bottom" width="33%">
<a href="docs/images/agents/zh/deerflow-memory-manager.md"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/deerflow-dark.svg"><img src="docs/images/integrations/deerflow.svg" width="19" height="24" alt=""></picture><br><strong>DeerFlow</strong></a><br>
-<sub>Memory&nbsp;+&nbsp;MCP</sub>
+<sub>Plugin + MCP</sub>
</td>
</tr>
</table>
@@ -215,11 +206,7 @@ Rust CLI 通过 `npm i -g @openviking/cli` 安装,也可以从源码构建:`
## OpenViking Helper(Beta)
-OpenViking Helper 是一个桌面控制台,目前处于 Beta 阶段,支持 macOS 和 Windows x64:
-
-- **可视化接入本地 Agent**:检测 OpenViking CLI、Claude Code、Codex、Cursor、Trae 和 OpenCode,并配置支持的插件、MCP、Hook 和 CLI 接入。
-- **查看会话轨迹**:解析 Claude Code、Codex 和 Trae 的会话,展示 OpenViking 的召回、Prompt 注入、MCP 调用、捕获和提交事件。
-- **管理本地记忆与技能**:查看本地 memory / rule 文件和 `SKILL.md` 技能,并同步到 OpenViking。
+OpenViking Helper 是面向 macOS 和 Windows x64 的桌面控制台(Beta),用于配置支持的本地 Agent 接入、查看会话中的召回与捕获事件,并将本地记忆和技能同步到 OpenViking。
下载:
@@ -241,13 +228,11 @@ ov chat # 在另一个终端运行
## 生产部署
-生产环境建议把 OpenViking 作为独立 HTTP 服务运行——见[服务器部署](https://docs.openviking.ai/zh/getting-started/03-quickstart-server)和[部署指南](https://docs.openviking.ai/zh/guides/03-deployment)。
-
-## 商业版本
+开源服务器采用 [AGPLv3](LICENSE),可在自己的环境部署,无需激活码。见[服务器配置](https://docs.openviking.ai/zh/getting-started/03-quickstart-server)和 [Docker 与部署指南](https://docs.openviking.ai/zh/guides/03-deployment)。
-**开源版本不会被削弱。** 本仓库的 OpenViking 以 AGPLv3 完整开源:不锁功能、不需要注册账号、不需要激活码,按上面的[生产部署](#生产部署)自行部署即可用于生产环境,并且会一直如此。
+服务器支持[账号与用户隔离](https://docs.openviking.ai/zh/concepts/11-multi-tenant),并可按需启用[资源 ACL](https://docs.openviking.ai/zh/concepts/15-acl)。开放非本机访问前,需配置[身份认证](https://docs.openviking.ai/zh/guides/04-authentication)。
-下面两个版本解决的是「谁来运维、部署在哪」,不是「能不能用」。
+## 商业版本
<table>
<tr>
@@ -256,14 +241,7 @@ ov chat # 在另一个终端运行
<img src="docs/images/commercial-saas.png" alt="商业化 SaaS 版" width="100%" />
<h3>☁️ 商业化 SaaS 版</h3>
-<p>由<b>火山引擎</b>官方托管,开箱即用,不用自建也不用运维。</p>
-<ul>
-<li><b>个人版</b> — 面向个人开发者,最多 50 个文件免费试用,借助 VikingDB 获得远超本地硬件的扩展能力。</li>
-<li><b>企业版</b> — 面向团队的多用户上下文管理、协作与权限、企业级 SLA 与技术支持。</li>
-</ul>
-<p>开源版用户可以用迁移工具平滑迁入。</p>
-<p><a href="https://www.volcengine.com/product/openviking-service"><b>→ 火山引擎产品页</b></a> · <a href="https://docs.volcengine.com/docs/84313/2374478">使用文档</a></p>
-<p><sub>面向中国以外地区的全球托管服务将在 <a href="https://www.byteplus.com">BytePlus</a> 上线。</sub></p>
+<p>由<a href="https://www.volcengine.com/product/openviking-service">火山引擎</a>托管和运维,提供个人版、企业版,以及开源部署的迁移工具。套餐与额度见<a href="https://docs.volcengine.com/docs/84313/2374478">服务文档</a>。中国以外地区的托管服务计划在 <a href="https://www.byteplus.com">BytePlus</a> 上线。</p>
</td>
<td width="50%" valign="top">
@@ -271,20 +249,12 @@ ov chat # 在另一个终端运行
<img src="docs/images/commercial-self-hosted.png" alt="私有化部署版" width="100%" />
<h3>🏢 私有化部署版</h3>
-<p>部署在<b>你自己的环境</b>里,数据不出域。</p>
-<ul>
-<li><b>在线部署</b> — 部署到你自己的云账号 / VPC,支持 BYOC,可连公网获取更新与授权。</li>
-<li><b>离线部署</b> — 完全内网、无外网连接的环境,适用于政企、金融、制造等强合规场景。</li>
-</ul>
-<p>在开源版基础上增加分布式部署能力与官方技术支持,通过激活码激活。</p>
-<p><a href="https://my.feishu.cn/share/base/form/shrcnMFqymCd9sq77sLk34Krxoc"><b>→ 提交私有化部署咨询</b></a></p>
+<p>部署在自己的云账号 / VPC(BYOC)或离线环境中,提供分布式部署和官方技术支持,通过激活码启用。<a href="https://my.feishu.cn/share/base/form/shrcnMFqymCd9sq77sLk34Krxoc">咨询私有化部署</a>。</p>
</td>
</tr>
</table>
-> 只想自己跑开源版?完全没问题,不需要联系任何人,直接看[快速开始](#快速开始)。
-
## 研究
**让 Agent 的记忆随交互演化。** VikingMem 以事件驱动长期记忆的提取、更新与整合,让有状态 Agent 在持续交互中积累可复用的经验。OpenViking 开源了其中的部分核心能力。
@@ -310,19 +280,15 @@ ov chat # 在另一个终端运行
## 合作伙伴
-OpenViking 欢迎与其他开源项目合作建设上下文数据生态。目前已确认的合作项目包括:
-
- [deer-flow](https://github.com/bytedance/deer-flow) - 开源的长周期 SuperAgent 框架
- [NoKV](https://github.com/NoKV-Lab/NoKV) - AI 原生的分布式文件系统
- [loopx](https://github.com/huangruiteng/loopx) - 轻量级循环工程状态内核
- [Hermes Agent](https://github.com/NousResearch/hermes-agent) - 与用户共同成长的智能体
-有兴趣加入我们的合作伙伴列表?请在社区提交 issue 来申请加入。
+合作提议请[提交 issue](https://github.com/volcengine/OpenViking/issues)。
## 社区与贡献
-OpenViking 还在早期阶段,要做的事还很多。
-
- **文档**:[docs.openviking.ai](https://docs.openviking.ai/) · [FAQ](https://docs.openviking.ai/zh/faq/faq)
- **博客**:[blog.openviking.ai](https://blog.openviking.ai/)
- **团队**:[关于我们](https://docs.openviking.ai/zh/about/01-about-us)
@@ -331,7 +297,6 @@ OpenViking 还在早期阶段,要做的事还很多。
## 安全与隐私
-本项目重视安全问题。
漏洞报告方式和受支持的版本,见 [SECURITY.md](SECURITY.md)
## 许可证
diff --git a/README_JA.md b/README_JA.md
index d8dd27f89..db222b799 100644
--- a/README_JA.md
+++ b/README_JA.md
@@ -31,21 +31,24 @@
## OpenVikingとは
-OpenVikingは、AIエージェントのためのオープンソースのコンテキストデータベースです。メモリ、リソース、スキルを `viking://` プロトコル配下の1つの仮想ファイルシステムとして保存するため、エージェントはブラックボックスのベクトルストアに問い合わせる代わりに、`ls`、`tree`、`find` で自分のコンテキストを閲覧できます。コンテンツは L0(abstract)、L1(overview)、L2(details)の3階層に処理され、必要に応じてロードされます。すべての検索は、観察してデバッグできる軌跡を残します。詳しい紹介はこちら: [Getting started](https://docs.openviking.ai/en/getting-started/01-introduction)。
+OpenVikingは、AIエージェントのためのオープンソースのコンテキストデータベースです。知識やユーザー情報を保存し、セッションをまたいで経験を再利用できます。
-[![OpenViking Studio playground](docs/images/studio-playground.png)](https://openviking.ai/studio)
+OpenViking はコンテキストを `viking://` 仮想ファイルシステムとして整理します。エージェントはファイルと同じように、`ls`、`tree`、`read`、`write` などでディレクトリの閲覧、内容の読み取り、作成、編集を行い、ディレクトリ内を検索できます。ディレクトリの要約により、必要に応じて内容を読み込めます。
-*[OpenViking Studio](https://openviking.ai/studio) のプレイグラウンド — インストール不要でブラウザから試せるライブデモです。*
+<a href="https://openviking.ai/studio" target="_blank" rel="noopener noreferrer">
+ <img src="docs/images/studio-playground.png" alt="OpenViking Studio:コンテキストの閲覧と意味検索">
+</a>
+
+[OpenViking Studioを試す](https://openviking.ai/studio)。ブラウザから利用でき、インストールは不要です。 [Web Studioを自分の環境にデプロイ](web-studio/README.md)。
## OpenVikingを選ぶ理由
-- **すべてのコンテキストを1つのファイルシステムに。** メモリ、リソース、スキルにはそれぞれ `viking://` URI が与えられます。エージェントは、ファイルを扱う開発者のように、コンテキストを決定論的に特定・操作できます。→ [Viking URI](https://docs.openviking.ai/en/concepts/04-viking-uri) · [Context types](https://docs.openviking.ai/en/concepts/02-context-types)
-- **階層型ローディングで token 消費を削減。** すべてのエントリは書き込み時に L0(abstract)、L1(overview)、L2(details)へ処理され、タスクが必要とする深さまでだけロードされます。→ [Context layers](https://docs.openviking.ai/en/concepts/03-context-layers)
-- **ディレクトリ再帰検索。** ベクトル検索でまず最高スコアのディレクトリを特定し、そこから層ごとに掘り下げるため、結果は周辺のコンテキストを保ったまま返ってきます。→ [Retrieval](https://docs.openviking.ai/en/concepts/07-retrieval)
-- **観察可能な検索。** 各クエリはディレクトリ閲覧の軌跡を保存します。結果がおかしいときは、どのパスがその結果を生んだのかを正確に確認できます。→ [Retrieval](https://docs.openviking.ai/en/concepts/07-retrieval)
-- **セッションはメモリになる。** セッションのコミット後、OpenVikingはユーザーの好みとエージェントの経験を非同期に抽出し、長期メモリとして保存します。→ [Session](https://docs.openviking.ai/en/concepts/08-session)
+- **ファイルシステムでコンテキストを整理。** リソースは文書やコード、メモリはユーザーの好みや経験、スキルはタスクの実行方法を保存します。それぞれに `viking://` URI があり、閲覧や検索に使えます。→ [Viking URI](https://docs.openviking.ai/en/concepts/04-viking-uri) · [Context types](https://docs.openviking.ai/en/concepts/02-context-types)
+- **必要なコンテキストを読み込む。** ディレクトリの要約(L0)と概要(L1)を使い、全文(L2)を読むか判断します。→ [Context layers](https://docs.openviking.ai/en/concepts/03-context-layers)
+- **ディレクトリ構造に沿って検索。** ベクトル検索で候補のディレクトリを見つけ、その内容を探索します。`find` はクエリを直接実行し、`search` はセッションのコンテキストを使って検索を計画できます。→ [Retrieval](https://docs.openviking.ai/en/concepts/07-retrieval)
+- **セッションからメモリを抽出。** コミットすると会話をアーカイブし、メモリポリシーに従ってバックグラウンドで抽出します。候補を既存のメモリと比較し、新規作成、統合、スキップを判断します。VikingBot を有効にすると、`ov compile` とスキルで資料を Wiki、知識グラフ、レポートに整理できます。→ [Session](https://docs.openviking.ai/en/concepts/08-session) · [Context compilation](https://docs.openviking.ai/en/context-compilation/01-overview)
-各要素がどう組み合わさるか: [Architecture](https://docs.openviking.ai/en/concepts/01-architecture)。設計思想: [The Database Paradigm for Context Engineering](https://blog.openviking.ai/post/openviking-context-database/)。
+[Architecture](https://docs.openviking.ai/en/concepts/01-architecture) · [設計の背景](https://blog.openviking.ai/post/openviking-context-database/)
```
viking://
@@ -76,15 +79,15 @@ viking://
- **L1(Overview)**: 計画立案のためのコア情報と使用シナリオ。
- **L2(Details)**: 完全なオリジナルデータ。必要な場合にのみ読み込まれます。
-各ディレクトリが自身の L0/L1 レイヤーを持つため、ファイル全体を読む前に関連性を判断できます:
+意味処理を終えたディレクトリには L0/L1 の要約があり、全文を読む前に関連性を判断できます。
```
viking://resources/my_project/
-├── .abstract # L0: 〜100 tokens - 迅速な関連性チェック
-├── .overview # L1: 〜2k tokens - 構造とキーポイント
+├── .abstract.md # L0: 〜100 tokens - 迅速な関連性チェック
+├── .overview.md # L1: 〜2k tokens - 構造とキーポイント
└── docs/
- ├── .abstract
- ├── .overview
+ ├── .abstract.md
+ ├── .overview.md
└── api/
├── auth.md # L2: 完全なコンテンツ、オンデマンドでロード
└── endpoints.md
@@ -106,33 +109,23 @@ OpenViking 0.3.22 は、長い会話でのユーザーメモリ(LoCoMo)と
## クイックスタート
-> 💡 **まず動くところを見たい方へ**: [OpenViking Studio](https://openviking.ai/studio) をお試しください。コンテキストプレイグラウンド、セマンティック検索、マルチエージェント Hub を備えたライブホスト版インスタンスで、インストールは不要です。
-
-Python 3.10 以上が必要です。
+Python 3.10+ と、Embedding モデルおよび VLM(クラウドまたはローカル)へのアクセスが必要です。
```bash
pip install openviking --upgrade
-openviking-server init # 対話式ウィザード: プロバイダー、モデル、ov.conf
-openviking-server doctor # セットアップを検証
-openviking-server # 起動
-```
-
-または、サーバーをバックグラウンドで実行します:
-
-```bash
-nohup openviking-server > /data/log/openviking.log 2>&1 &
+openviking-server init # プロバイダーとモデルを設定
+openviking-server doctor # 設定と接続を確認
+openviking-server # サーバーを起動
```
-`init` はプロバイダー設定を対話的に進め、`~/.openviking/ov.conf` を書き出します。Volcengine、OpenAI、Codex OAuth、Kimi、GLM、ローカルの Ollama をサポートし、Ollama についてはランタイムの検出とインストール、ハードウェアに適したモデルの取得も行えます。`doctor` は、サーバーを起動せずに設定ファイル、Python バージョン、プロバイダーへの接続性、ディスク容量をチェックします。
-
-手動で書く `ov.conf` テンプレート、プロバイダーごとの設定例、環境変数、Windows でのセットアップ、CLI/クライアント設定は、[Configuration guide](https://docs.openviking.ai/en/guides/01-configuration) と [Quick start docs](https://docs.openviking.ai/en/getting-started/02-quickstart) にあります。
+`init` は `~/.openviking/ov.conf` に設定を書き込みます。Volcengine、OpenAI、Codex OAuth、Kimi、GLM、ローカルの Ollama などに対応しています。モデルの設定は[設定ガイド](https://docs.openviking.ai/en/guides/01-configuration)、プラットフォーム別の手順は[クイックスタート文書](https://docs.openviking.ai/en/getting-started/02-quickstart)を参照してください。
-サーバーが起動したら:
+パッケージには `ov` CLI が含まれます。別のターミナルでリポジトリを取り込み、検索します。
```bash
ov status
ov add-resource https://github.com/volcengine/OpenViking
-# TASK_ID を返されたタスク ID に置き換え、completed を確認してから後続のコマンドを実行します
+# TASK_ID を返された task_id に置き換え、status が completed になるまで確認
ov task status TASK_ID
ov ls viking://resources/
ov tree viking://resources/volcengine -L 2
@@ -140,11 +133,9 @@ ov find "what is openviking"
ov grep "openviking" --uri viking://resources/volcengine/OpenViking/docs/en
```
-既存インデックスの再構築: `ov reindex <uri> --mode vectors_only` はベクトルのみ更新します。`--mode semantic_and_vectors` はセマンティック生成物(`.abstract.md`、`.overview.md`)を再生成してからベクトルを更新し、`--mode prune_orphans` はソースファイルが存在しないベクトルレコードを削除します(`--dry-run` でプレビュー可能)。`semantic` や `full` というモードエイリアスはありません。
+`ov find` は一致したコンテキストと URI を返します。クライアント設定(`ov config`)、CLI の単体インストール、インデックス管理は [CLI セットアップ](https://docs.openviking.ai/en/getting-started/05-cli-setup)を参照してください。
-クライアント設定は `ov config` で対話的に初期化できます。複数のサーバーを運用する場合は `ov config switch` で切り替えます。
-
-Rust CLI は `npm i -g @openviking/cli` でインストールできます。ソースからのビルドは `cargo install --git https://github.com/volcengine/OpenViking ov_cli` を使います — [CLI setup](https://docs.openviking.ai/en/getting-started/05-cli-setup) を参照してください。公式 Docker イメージもあります。[Deployment guide](https://docs.openviking.ai/en/guides/03-deployment) を参照してください。
+独自のアプリには [Python](sdk/python/README.md)、[Go](sdk/go/README.md)、[TypeScript](sdk/typescript/README.md) SDK、または [HTTP API](https://docs.openviking.ai/en/api/01-overview) を使えます。
## エージェントと組み合わせて使う
@@ -154,21 +145,21 @@ OpenViking を接続して、セッションをまたいで記憶を引き継ぎ
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/02-claude-code"><img src="docs/images/agents/image/claude-code/logo.png" width="32" height="32" alt=""><br><strong>Claude</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/04-codex"><img src="docs/images/integrations/codex.png" width="32" height="32" alt=""><br><strong>Codex</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/12-cursor"><img src="docs/images/agents/image/cursor/logo.png" width="32" height="32" alt=""><br><strong>Cursor</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
</tr>
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/13-trae"><img src="docs/images/agents/image/trae/logo.png" width="32" height="32" alt=""><br><strong>TRAE</strong></a><br>
-<sub>Hooks&nbsp;+&nbsp;MCP</sub>
+<sub>Hooks + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/03-openclaw"><img src="docs/images/integrations/openclaw.jpg" width="24" height="24" alt=""><br><strong>OpenClaw</strong></a><br>
@@ -182,7 +173,7 @@ OpenViking を接続して、セッションをまたいで記憶を引き継ぎ
<tr>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/10-opencode"><img src="docs/images/agents/image/opencode/logo.png" width="32" height="32" alt=""><br><strong>OpenCode</strong></a><br>
-<sub>Plugin&nbsp;+&nbsp;MCP</sub>
+<sub>Plugin + MCP</sub>
</td>
<td align="center" valign="bottom" width="33%">
<a href="https://docs.openviking.ai/en/agent-integrations/11-pi"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/pi-dark.svg"><img src="docs/images/integrations/pi.svg" width="41" height="41" alt=""></picture><br><strong>pi</strong></a><br>
@@ -190,7 +181,7 @@ OpenViking を接続して、セッションをまたいで記憶を引き継ぎ
</td>
<td align="center" valign="bottom" width="33%">
<a href="docs/images/agents/en/deerflow-memory-manager.md"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/deerflow-dark.svg"><img src="docs/images/integrations/deerflow.svg" width="19" height="24" alt=""></picture><br><strong>DeerFlow</strong></a><br>
-<sub>Memory&nbsp;+&nbsp;MCP</sub>
+<sub>Plugin + MCP</sub>
</td>
</tr>
</table>
@@ -215,11 +206,7 @@ OpenViking を接続して、セッションをまたいで記憶を引き継ぎ
## OpenViking Helper(Beta)
-OpenViking Helper はデスクトップコンソールで、現在 macOS と Windows x64 向けの Beta 版として提供しています:
-
-- **ローカルエージェント設定の可視化**: OpenViking CLI、Claude Code、Codex、Cursor、Trae、OpenCode を検出し、対応する plugin、MCP、Hook、CLI 統合を設定します。
-- **セッショントレースの確認**: Claude Code、Codex、Trae のセッションを解析し、OpenViking の recall、プロンプト注入、MCP 呼び出し、capture、commit の各イベントを表示します。
-- **ローカルメモリとスキルの管理**: ローカルの memory / rule ファイルと `SKILL.md` スキルを確認し、OpenViking に同期します。
+OpenViking Helper は macOS と Windows x64 向けのデスクトップコンソール(Beta)です。対応するローカルエージェントとの連携を設定し、セッションのリコールやキャプチャを確認して、ローカルのメモリとスキルを OpenViking に同期できます。
ダウンロード:
@@ -241,13 +228,11 @@ ov chat # 別のターミナルで実行
## 本番環境へのデプロイ
-本番環境では、OpenViking をスタンドアロンの HTTP サービスとして実行してください — [Server deployment](https://docs.openviking.ai/en/getting-started/03-quickstart-server) と [Deployment guide](https://docs.openviking.ai/en/guides/03-deployment) を参照してください。
-
-## 商用版
+オープンソースのサーバーは [AGPLv3](LICENSE) のもとで自分の環境にデプロイでき、アクティベーションキーは不要です。[サーバー設定](https://docs.openviking.ai/en/getting-started/03-quickstart-server) · [Docker とデプロイのガイド](https://docs.openviking.ai/en/guides/03-deployment)
-**オープンソース版が機能制限されることはありません。** 本リポジトリの OpenViking は AGPLv3 で完全にオープンソースです。機能ロックなし、アカウント登録なし、アクティベーションコードなしで、上記の[本番環境へのデプロイ](#本番環境へのデプロイ)に従って自分で本番運用できます。今後もそれは変わりません。
+サーバーは[アカウントとユーザーの分離](https://docs.openviking.ai/en/concepts/11-multi-tenant)に対応し、[リソース ACL](https://docs.openviking.ai/en/concepts/15-acl)を必要に応じて有効にできます。localhost 以外から接続する前に[認証](https://docs.openviking.ai/en/guides/04-authentication)を設定してください。
-以下の 2 つの版が解決するのは「誰が運用し、どこで動かすか」であって、「使えるかどうか」ではありません。
+## 商用版
<table>
<tr>
@@ -256,14 +241,7 @@ ov chat # 別のターミナルで実行
<img src="docs/images/commercial-saas.png" alt="マネージド SaaS 版" width="100%" />
<h3>☁️ マネージド SaaS 版</h3>
-<p><b>Volcano Engine</b> 上で公式にホスティングされ、構築も運用も不要です。</p>
-<ul>
-<li><b>Personal</b> — 個人開発者向け。最大 50 ファイルまで無料トライアル、VikingDB によりローカルハードウェアを超えてスケールします。</li>
-<li><b>Enterprise</b> — チーム向けのマルチユーザー管理、権限管理、エンタープライズ SLA とサポート。</li>
-</ul>
-<p>オープンソース版のユーザーは移行ツールでそのまま移行できます。</p>
-<p><a href="https://www.volcengine.com/product/openviking-service"><b>→ Volcano Engine 製品ページ</b></a> · <a href="https://docs.volcengine.com/docs/84313/2374478">ドキュメント</a></p>
-<p><sub>中国以外の地域向けグローバルホスティングは <a href="https://www.byteplus.com">BytePlus</a> で提供予定です。</sub></p>
+<p><a href="https://www.volcengine.com/product/openviking-service">Volcano Engine</a> がホスティングと運用を担当します。個人向けと企業向けのプラン、オープンソース環境からの移行ツールを提供します。プランと制限は<a href="https://docs.volcengine.com/docs/84313/2374478">サービス文書</a>を参照してください。中国以外でのホスティングは <a href="https://www.byteplus.com">BytePlus</a> で予定されています。</p>
</td>
<td width="50%" valign="top">
@@ -271,20 +249,12 @@ ov chat # 別のターミナルで実行
<img src="docs/images/commercial-self-hosted.png" alt="プライベートデプロイ版" width="100%" />
<h3>🏢 プライベートデプロイ版</h3>
-<p><b>自社環境内</b>で動作し、データは外部に出ません。</p>
-<ul>
-<li><b>オンライン</b> — 自社のクラウドアカウント / VPC にデプロイ。BYOC 対応、更新とライセンス取得のため外部接続あり。</li>
-<li><b>オフライン</b> — 外部接続のない完全な閉域環境向け。規制産業に対応します。</li>
-</ul>
-<p>オープンソース版に加えて分散デプロイと公式サポートを提供し、アクティベーションコードで有効化します。</p>
-<p><a href="https://docs.google.com/forms/d/e/1FAIpQLScQqwsm7fvKdjtNiW5rWNXJjoHPtedVzLsKSMJgObtsj2_udA/viewform"><b>→ プライベートデプロイのお問い合わせ</b></a></p>
+<p>自社のクラウドアカウント / VPC(BYOC)、またはオフライン環境にデプロイできます。分散デプロイと公式サポートを提供し、ライセンスキーで有効化します。<a href="https://docs.google.com/forms/d/e/1FAIpQLScQqwsm7fvKdjtNiW5rWNXJjoHPtedVzLsKSMJgObtsj2_udA/viewform">チームに問い合わせる</a>。</p>
</td>
</tr>
</table>
-> オープンソース版を自分で動かしたいだけですか?問題ありません。誰にも連絡する必要はなく、[クイックスタート](#クイックスタート)へどうぞ。
-
## 研究
**対話とともに進化するエージェントの記憶。** VikingMem は、イベントを起点に長期記憶を抽出・更新・統合し、状態を持つエージェントが対話を通じて再利用できる経験を蓄積する仕組みを示しています。OpenViking は、そのコア機能の一部をオープンソースとして公開しています。
@@ -310,19 +280,15 @@ ov chat # 別のターミナルで実行
## パートナープロジェクト
-OpenViking は、コンテキストデータエコシステムを構築するために他のオープンソースプロジェクトとのコラボレーションを歓迎します。確認済みのパートナーは以下の通りです:
-
- [deer-flow](https://github.com/bytedance/deer-flow) - オープンソースの長時間 SuperAgent フレームワーク
- [NoKV](https://github.com/NoKV-Lab/NoKV) - AI ネイティブの分散ファイルシステム
- [loopx](https://github.com/huangruiteng/loopx) - 軽量なループエンジニアリング状態カーネル
- [Hermes Agent](https://github.com/NousResearch/hermes-agent) - あなたと共に成長するエージェント
-パートナーリストへの参加に興味がありますか?コミュニティに issue を提出して申請してください。
+提携の提案は [issue](https://github.com/volcengine/OpenViking/issues) で受け付けています。
## コミュニティとコントリビューション
-OpenViking はまだ初期段階にあり、作るべきものが数多く残っています。
-
- **ドキュメント**: [docs.openviking.ai](https://docs.openviking.ai/) · [FAQ](https://docs.openviking.ai/en/faq/faq)
- **ブログ**: [blog.openviking.ai](https://blog.openviking.ai/)
- **チーム**: [About us](https://docs.openviking.ai/en/about/01-about-us)
@@ -331,7 +297,6 @@ OpenViking はまだ初期段階にあり、作るべきものが数多く残っ
## セキュリティとプライバシー
-このプロジェクトはセキュリティを重視しています。
脆弱性の報告方法とサポート対象バージョンについては、[SECURITY.md](SECURITY.md) を参照してください
## ライセンス