Skip to content

About

OpenViking personal onboarding companion for Volcengine, powered by the official memory plugin

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

OpenViking Codex App

让 Codex 记住已有背景,带上过去的工作,并在需要时回顾进展、查找资料、整理报告。

连接你的火山 OpenViking 个人空间,在对话中完成接入,日常在 Codex 右侧打开工作台。

  • 带入已有工作:按时间、项目或描述选择历史,确认清单后导入。
  • 接着上次的进度:查看云端会话的最新工作概览,回顾决定、待办和下一步。
  • 随时查看与整理:浏览目录和资料,让 Codex 按需生成日报、周报或知识洞察。
  • 绑定与切换用户:保留多个 OpenViking 用户连接,在工作台或对话中切换,选择后续任务使用哪个用户。

本页截图使用示例数据,由当前插件界面渲染。接入卡片截图来自模拟 MCP Apps 宿主,不代表 Codex 原生宿主验收;实际展示方式随宿主版本变化。

开始使用

准备好火山 OpenViking 个人版的 API Key,以及 Python 3.10+、Node.js 22+、Git、Codex CLI。当前已完成 macOS 安装验证,其他系统尚未完成真实安装验收。

**最方便的方式:**把 安装指令 复制给 Codex,让它完成安装。也可以自己在终端执行:

git clone https://github.com/zhangxiaoyan1081/openviking-developer-codex-app.git
cd openviking-developer-codex-app
python3 install.py --companion-only

安装后新开一个 Codex 任务,发送:

使用 openviking-codex-app 接入 OpenViking。

更新 App 默认保留已安装的官方插件、Node 启动路径和信任设置;官方插件独立升级。首次安装才使用仓库锁定版本并配置 Node 绝对路径,避免桌面环境找不到 Node。

0.2.6 修复普通任务中查询用户绑定时意外弹出卡片的问题。后台查询静默返回,仅主动查看用户绑定时展示卡片。

支持 Codex 更新后的程序路径自动发现。已保存用户绑定因本机检查失败而无法启用时,更新 App 后可继续,无需重新提交 Key。见 更新与排查。

这个命令安装交互插件;后续接入流程会检查并按需安装官方 openviking-memory,分别验证连接与记忆能力。分发包包含打包后的界面,使用者无需执行 npm install。

如果你已从火山控制台复制了含 API Key 的接入指令,直接交给 Codex 即可,无需再次填写 Key。控制台集成见 接入指令模板。

第一次接入会经历什么

1. 连接你的 OpenViking

没有提供 API Key 时,先输入 Key;设备上已有连接时,选择使用当前连接或更换 Key。Codex 验证连接后继续,必要时引导你批准官方记忆插件的 Hook 或重新打开任务。

已有连接时,选择使用当前连接或更换 API Key

2. 选择记忆方式

  • 自动记忆(推荐):启用官方 Hooks,自动召回相关内容、保存对话。已有召回足够时不重复检索。
  • 按需使用:需要时检索,按约定保存资料,关闭普通对话的自动回流。

首次安装官方插件后,Codex 会先引导你在 /hooks 中启用并信任,再检查状态。选择按需使用时,会先确认 Hooks 已关闭。配置就绪不等于实际采集和抽取已验证。

选择自动记忆或按需使用

3. 确认今后如何协作

确认 Codex 何时参考记忆、保存哪些重要进展与交付物,以及如何说明信息的使用。你可以采用建议,也可以调整。

已有协作规则时,也会让你确认沿用或调整。新增规则在你确认后写入相应的 AGENTS.md,保留原有内容;沿用已有规则无需重写。

确认长期协作方式及规则生效范围

4. 选择是否带入过去的工作

可以选择最近 7 天、1 个月、3 个月的工作,选择一个或多个项目,或者用自己的话描述范围,例如:

带入最近一个月与个人网站改版有关的讨论和交付物。

Codex 先整理可读取的历史清单,说明覆盖范围与缺口,等你确认后再同步。也可以选择从现在开始,无需导入历史。

按时间、项目或自然语言选择历史范围,也可以从现在开始

5. 查看同步进度,回顾已有工作

确认导入后,可以查看写入、读回核对与记忆整理的状态。云端抽取可能需要时间;已有可读取的概览或核对过的原始对话时,Codex 可以先帮你恢复工作背景。

同步进度:已保存的历史与云端记忆整理状态

随后查看工作摘要:做到哪里、有哪些决定、还缺什么、接下来可以怎么推进。点击回顾这项工作只总结进展并建议方向,等待你的下一条指令再执行任务。

回顾工作:当前进展、已确定事项、待处理问题与建议下一步

选择不导入历史,也会说明当前协作状态,以及如何开始新工作或保存一份资料。接入中断后,可以在新任务中说:

使用 openviking-codex-app 继续接入 OpenViking,从已保存的步骤继续。

支持 MCP Apps 的 Codex 桌面宿主可使用交互卡片;CLI 或不支持卡片的宿主通过选项和文字完成相同步骤。

绑定与切换 OpenViking 用户

你可以保留多个 OpenViking 用户连接,例如个人空间和有权访问的工作空间。新增绑定会保留原连接;切换已有绑定无需重复输入 Key。

在工作台中管理用户

点击工作台顶部的当前用户,查看已绑定的服务展示名、User ID、Account 和可用的库 ID:

  • 切换用户:点击另一个绑定。验证成功后,目录、工作进展和报告立即刷新为该用户的数据;验证失败保留原连接。
  • 新增用户:点击「新增用户 → 在新对话中接入」。Codex 保留旧绑定,验证新 API Key,再引导核对 Hooks、记忆方式、长期协作规则和历史导入范围。
  • 回到工作台:返回页面或点击「刷新」,即可看到在对话中保存的新绑定,不需要再录一次 Key。保存了绑定不代表所有接入步骤都已完成;尚未完成时在原接入对话继续。

新对话入口需要宿主支持。右侧本地网页或不支持的宿主提供「复制接入指令」,粘贴到 Codex 新对话即可。工作台不会自动导入历史或替你确认协作方式。

切换更新设备默认连接。**新对话使用目标用户;已有对话保留原连接。**若宿主仍复用旧 MCP 连接,重启 Codex 后再开新对话。连接隔离组件未就绪时会阻止切换,按提示修复后重试。

工作台顶部的用户切换菜单(虚构验收数据)

新增一个用户绑定

在 Codex 中发送:

帮我新增一个 OpenViking user 绑定。
  1. 在卡片中选择使用已安装插件;需要升级或修复时,也可选择更新插件 App或重新安装插件 App。
  2. 输入新连接的 API Key,可填写服务展示名,例如“个人空间”或“工作空间”,然后点击验证并使用新用户。User ID 和 Account 以服务端验证结果为准;库 ID 未返回时无需补填。
  3. 按提示新开 Codex 任务,继续该用户的接入:选择记忆方式、核对 Hooks、确认长期协作方式、选择是否导入历史,最后查看工作摘要或开始使用的指引。
  4. 完成后查看绑定列表,确认服务展示名、User ID 和当前默认连接。原有用户及其云端内容保留。

首次使用多用户切换时,Codex 需要配置连接隔离组件,并提示重启一次;Hook 命令发生变化时,按提示重新审核信任。如果绑定已经保存但暂时无法启用,修复后继续启用即可,无需重复提交 Key。

查看已绑定的用户

查看已绑定的 OpenViking 用户。

用户卡片展示服务展示名、User ID、Account、可用的库 ID 和设备默认连接,也可从这里点击新增用户绑定。普通任务中的后台身份查询不会自动展示这张卡片。

切换到已有用户

把下面的 <User ID> 替换为绑定列表中的实际值:

切换 OpenViking user 为 <User ID>。

也可以用绑定时填写的服务展示名,例如:

切换到服务展示名为“工作空间”的 OpenViking 用户。

同一 User ID 对应多个连接时,Codex 会让你进一步选择。尚未绑定的用户需先完成新增绑定;切回原用户也使用同样的指令。

**收到切换完成提示后,新开任务再使用目标用户。**切换改变设备默认连接,已运行任务仍保留原连接,不会全部跟着切换。若新任务仍复用旧连接,重启 Codex 后再打开新任务;不要通过复制或 fork 旧对话来跨用户接续。

切换已有绑定不默认重走 onboarding,也不自动迁移或上传历史。需要继续未完成的接入时,再明确说“继续接入 OpenViking”。查看当前任务的实际身份时,以该任务的云端身份校验为准,不能仅凭绑定列表里的“当前使用”判断。

日常工作台

在 Codex 中发送:

打开我的 OpenViking 工作台。

工作台直接在 Codex 右侧面板打开,按「目录 → 工作进展 → 报告与洞察」排列。

左侧导航入口(本地原型)

v0.2.8 为工作台增加 OpenAI MCP Extensions 的全局入口,不需要先提交官方公共插件目录。更新安装后,支持此扩展的桌面宿主可在左侧显示 OpenViking,点击直接打开工作台;无需先发起对话。

python3 install.py --companion-only

安装后重启桌面客户端以重新发现入口。工作台默认打开目录,也可查看工作进展和已生成报告。尚未连接时会提示在对话中完成接入;打开页面不会替用户确认连接、推进 onboarding 或开启历史导入。接续工作使用“复制接续指令”,报告仍在对话中按需生成。

这是本地入口原型:MCP 声明、独立启动和页面交互有自动测试,真实 Codex 左栏展示与点击尚待人工确认。若宿主未显示入口,仍可使用上面的对话指令打开右侧工作台。详见 分发与桌面入口。

目录:浏览你的云端资料

从 viking:// 根目录浏览当前 Key 有权访问的目录,保留 user/default/... 等实际层级,优先展示 user,随后是 resources。

  • 展开目录树,选择文件即可预览。
  • 选择文件夹,查看 L0 摘要与 L1 概览。
  • 在预览、源码和路径之间切换,支持 Markdown、JSON、文本及接口返回的图片等内容。

目录交互参考 OpenViking Web Studio,不包含 VikingBot 操作。

目录工作台:完整目录树,以及 L0 摘要、L1 概览和预览、源码、路径切换

工作进展:看看每项工作做到哪里

基于 OpenViking 当前用户 sessions/ 下的所有 Session,读取各会话最新 archive 的 L1 概览,展示云端已有的工作进展,不局限于这次接入导入的历史。

每张横向卡片包含 Session Title、Current State、上次抽取记忆时间;时间取自最新归档 L1 文件的更新时间。会话多时可搜索和分页,点击「展开概览」查看全文。尚无归档或读取失败的会话会保留状态提示。

工作进展列表:搜索会话、展开完整概览、复制接续指令

想继续某项工作,点击复制接续指令并粘贴到 Codex。Codex 会读取对应概览,先总结进展、建议推进方向,等你决定下一步。

报告与洞察:按需要整理工作成果

在对话中告诉 Codex 你想看什么,例如:

根据最近 7 天的工作生成周报,列出已完成、进行中、下一步和来源。
回顾最近一个月的产品调研,整理反复出现的问题和可复用的经验,注明来源。

Codex 读取实际资料,说明时间范围与缺口,生成日报、周报、工作汇总或知识洞察。报告正文保存到个人 OpenViking 资源目录并读回核对后,可在工作台查看报告内容和来源。

报告详情:时间范围、覆盖的工作、总结正文与来源入口

报告按需生成;不会默认开启定时任务。侧边工作台用于浏览,生成新报告仍在对话中发出请求。

更新与分享

已安装的用户,在仓库目录执行:

git pull --ff-only
python3 install.py --companion-only

随后新开 Codex 任务加载新版。更新交互插件不会重新安装官方记忆插件;已有任务可能继续运行原版本。

仓库已公开,可以直接把本 README 或 安装指令 分享给同事。每个人配置自己的火山 API Key。更多说明见 团队试用 和 分发说明。

当前支持范围

  • 接入与工作台以火山 OpenViking 个人版体验为主,复用官方 openviking-memory。支持多个有权访问的用户连接;不安装本地 OpenViking 服务端,不按 Key 自动识别套餐或分流企业版,也不提供团队管理界面。
  • 自动记忆取决于官方插件与 Hook 的实际启用状态;连接成功不等于所有记忆能力已验证。
  • 历史导入以宿主工具可读取或用户提供的内容为准;不扫描宿主私有数据库,不采集 Computer History。附件原件是否同步会单独说明。
  • 工作台服务运行在用户本机,使用已配置的公有云连接;远程 HTTPS MCP 服务尚未部署。改造思路见 远程 MCP 方案。

开发与验证

查看源码入口、验证命令与验收边界
模块 入口
MCP Apps 工具与资源 src/server.mjs
对话卡片与工作台界面 src/ui.mjs、src/panel.mjs
云端目录浏览 src/explorer.mjs、目录说明
云端 Session 工作进展 src/progress.mjs、工作进展说明
接入、同步与长期协作 插件技能、流程契约
官方依赖固定版本 upstream.lock.json
npm ci --ignore-scripts
npx playwright install chrome
npm test
# 安装后检查实际启动配置与宿主注册
npm run check:installed
npm run check:codex-host

npm test 覆盖 Python、stdio MCP、卡片消息桥、接入状态、目录预览与工作进展等回归;使用隔离的示例资料。模拟宿主测试和配置检查不等于 Codex 对话中的真实卡片验收,后者还需核对显示、点击回传与流程推进。详见 验收记录。

交互参考 OpenViking Web Studio 与 MCP Apps。第三方依赖许可见插件内的 THIRD_PARTY_NOTICES.txt。本仓库尚未指定项目开源许可证,公开可访问不等于授予任意再分发许可。

About

OpenViking personal onboarding companion for Volcengine, powered by the official memory plugin

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages