kiokuko-ai

中文文档
0.2.16发布于 2026/11/04TypeScriptES Module

External memory for OpenCode

原始使用文档
文档目录6 节
  1. 快速开始
  2. 主要功能
  3. 支持的客户端
  4. 安全性与限制
  5. 详细文档
  6. 添加编排模型

Kiokuko(记忆库)for OpenCode

English | 日本語 | 简体中文 | 한국어

通过 MCP 连接,检索需要的记忆,并在工作后积累知识。

Kiokuko 是面向 OpenCode 的本地外部记忆插件。它把知识保存在 SQLite 中,在下一次任务中检索相关上下文, 并保存可复用的工作结果。

请求 → MCP 连接 → 检索相关记忆 → 完成工作
                              ↓
                         保存可复用知识

记忆分为 Project、Ecosystem 和 Global。当前代码、配置和运行结果优先于历史记忆。

快速开始

需要 Node.js 24.16.0 或更高版本(也支持 Node.js 26.1.0 或更高版本)。

npm install --global kiokuko-ai
kiokuko-ai setup

setup 会初始化数据库、安装标准 Skill,配置 OpenCode MCP 和 npm 插件,并启用本地 semantic 检索。首次运行会下载模型。已运行的 OpenCode 请在设置后重启。 精确配置和恢复规则请参阅英文 Getting started。

使用 kiokuko-ai trace record -- 记录 OpenCode,并在退出后导入最终跟踪。交互式设置可添加 agenticreplay-opencode 快捷命令。同步和恢复方法见 AgenticReplay 集成。

主要功能

  • RAG 记忆(lexical 检索和 setup 启用的本地 semantic 检索)
  • Akinator 让模糊请求先变得具体
  • 役小角(enno-oduno) 负责计划、确认、验证和恢复
  • 本地 Web UI 用于检查和整理记忆
  • 外部 Skill 仅作为经过验证的参考,绝不自动执行

无需另外运行 embeddings setup。若要跳过模型准备,请使用 kiokuko-ai setup --no-embeddings。

它会更新 managed MCP block 和项目 instructions。替换 unmanaged identity 需要交互确认;非交互或 --dry-run --json 执行会在不修改配置的情况下 fail closed。详见英文 semantic retrieval。

支持的客户端

不固定 OpenCode 的运行版本,通过所需的插件和 MCP 功能检查兼容性。设置、重启和 Web UI 的说明请参阅英文 Getting started。 如需继续使用 OpenCode v1,请固定 [email protected];回退时还需恢复备份的 v1 配置。

安全性与限制

Kiokuko 不保存完整对话,并拒绝看起来像密码、API key、token 或私钥的内容。记忆只是参考信息,应以当前代码和运行结果为准。

MCP tool 是否调用由客户端和模型决定,因此不保证模型每一轮都会调用 Kiokuko 的 MCP tool。OpenCode plugin hook 的自动处理与 MCP tool 调用相互独立。信任边界和公开错误请看英文 Security and trust。

详细文档

请从英文文档目录开始;其中链接到 Getting started、Concepts、Enno-Oduno、Semantic retrieval、Security and trust, 以及实现者用的 architecture、database、execution-ledger 和 client-compatibility 文档。

添加编排模型

kiokuko-ai setup 和 kiokuko-ai embeddings setup 会注册固定模型的角色代理。 --enno-oduno ask|on|off 保存偏好,默认为 ask。每个新请求选择普通执行或 役小角(enno-oduno),再选择预设和各角色的模型。小范围README文字修改建议普通执行。 on 仍会询问模型配置;同一请求的后续回复保留选择。

  1. 在OpenCode中用 /connect 连接提供商,用 /models 或 opencode models 确认准确的 provider/model。
  2. 在有效的OpenCode配置(新建时为 ~/.config/opencode/opencode.jsonc)中, 复制生成的 gokiWorker 代理并改名,修改 model,保留角色提示和权限。 将下例中的代理条目合并到已有 agents 对象。将 YOUR_PROVIDER/YOUR_MODEL 替换为确认的模型ID;如需改名,两处 my-orchestration-worker 必须一致。
  3. 将第二个示例合并到已有Kiokuko plugins 条目的 options 对象,在 orchestration.customAgents.gokiWorker 中追加名称。保留已有选项和其他名称, 不要替换整个配置文件或plugin列表。
  4. 重启OpenCode。在新请求中选择役小角及预设,再将worker改为新代理。 再次运行setup会保留自定义定义。
{
  "agents": {
    "my-orchestration-worker": {
      "description": "My Kiokuko worker",
      "mode": "subagent",
      "model": "YOUR_PROVIDER/YOUR_MODEL",
      "system": "Implement only the supplied approved WorkUnit and run its focused verification. Do not delegate or broaden scope. The parent owns the run, leases, and all Kiokuko reports. Do not call Kiokuko tools or change models. Return changed paths and verification evidence.",
      "permissions": [
        { "action": "*", "resource": "*", "effect": "deny" },
        { "action": "read", "resource": "*", "effect": "allow" },
        { "action": "glob", "resource": "*", "effect": "allow" },
        { "action": "grep", "resource": "*", "effect": "allow" },
        { "action": "list", "resource": "*", "effect": "allow" },
        { "action": "skill", "resource": "*", "effect": "allow" },
        { "action": "edit", "resource": "*", "effect": "allow" },
        { "action": "shell", "resource": "*", "effect": "allow" },
        { "action": "kiokuko_*", "resource": "*", "effect": "deny" },
        { "action": "kiokuko_lisp", "resource": "*", "effect": "allow" },
        { "action": "external_directory", "resource": "*", "effect": "ask" }
      ]
    }
  }
}
// 将以下字段合并到现有 Kiokuko plugins 条目的 options 对象中:
// "plugins": [{ "package": "kiokuko-ai@<installed-version>", "options": { ...existing options, ...fields below } }]
{
  "orchestration": {
    "mode": "ask",
    "customAgents": {
      "gokiWorker": ["my-orchestration-worker"]
    }
  }
}

五种角色、混合提供商、权限和故障排查。

版本与发布记录

kiokuko-ai 共发布 42 个版本,首次发布于 2026/09/02;过去 12 个月发布了 42 个版本。

版本发布日期距今
0.2.16latest2026/11/041 天前
0.2.152026/10/314 天前
0.2.142026/10/314 天前
0.2.132026/10/269 天前
0.2.122026/10/1817 天前
0.2.112026/10/1818 天前

关于 kiokuko-ai 的常见问题

kiokuko-ai 是什么?

External memory for OpenCode

如何安装 kiokuko-ai?

在项目目录运行 npm install kiokuko-ai,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 kiokuko-ai,可以用 npx kiokuko-ai 直接运行。

kiokuko-ai 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

kiokuko-ai 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

kiokuko-ai 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24.16.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

kiokuko-ai 可以商用吗?

kiokuko-ai 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

kiokuko-ai 还在维护吗?

最新版本 0.2.16 发布于 2026/11/04(1 天前);至今共发布 42 个版本,其中过去 12 个月发布了 42 个;首次发布于 2026/09/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。