opencode-supermemory

用于持久化内存的 OpenCode 插件，基于 Supermemory。

您的代理能够记住您告诉它的一切——跨会话、跨项目。

安装

对于人类用户

bunx opencode-supermemory@latest install

然后从 app.supermemory.ai 获取 API 密钥，并将其设置为环境变量：

export SUPERMEMORY_API_KEY="sm_..."

或者让您的代理来完成——将以下内容粘贴到 OpenCode 中：

按照 https://raw.githubusercontent.com/supermemoryai/opencode-supermemory/main/README.md 的说明安装 opencode-supermemory。

对于 LLM 代理

bunx opencode-supermemory@latest install --no-tui

cat ~/.config/opencode/opencode.jsonc

{
  "plugin": ["opencode-supermemory"]
}

{
  "plugin": [
    "opencode-supermemory",
    // ... 其他插件
  ],
}

{
  "plugin": ["opencode-supermemory"]
}

export SUPERMEMORY_API_KEY="sm_..."

{
  "apiKey": "sm_...",
}

opencode -c

功能

上下文注入

在第一条消息时，代理会接收到（对用户不可见）：

• 用户档案（跨项目的偏好）
• 项目记忆（所有项目知识）
• 相关的用户记忆（语义搜索）

代理看到的内容示例：

[SUPERMEMORY]

用户档案：
- 喜欢简洁的回答
- TypeScript 专家

项目知识：
- [100%] 使用 Bun，而非 Node.js
- [100%] 构建命令：bun run build

相关记忆：
- [82%] 如果缺少 .env.local，构建会失败

代理会自动使用这些上下文——无需手动提示。

关键词检测

说出“记住”、“保存这个”、“别忘了”等词语时，代理会自动将内容保存到记忆中。

您： “记住这个项目使用 bun”
代理： [保存到项目记忆]

可以通过 keywordPatterns 配置自定义触发词。

代码库索引

运行 /supermemory-init 来探索并记忆您的代码库结构、模式和惯例。

预防性压缩

当上下文达到 80% 的容量时：

1. 触发 OpenCode 的摘要功能
2. 将项目记忆注入到摘要上下文中
3. 将会话摘要保存为记忆

这样可以在多次压缩事件中保留对话上下文。

隐私保护

API 密钥是 <private>sk-abc123</private>

位于 <private> 标签中的内容绝不会被存储。

工具使用

supermemory 工具可供代理使用：

范围： user（跨项目）、project（默认）

类型： project-config、architecture、error-solution、preference、learned-pattern、conversation

内存作用域

配置

创建 ~/.config/opencode/supermemory.jsonc 文件：

{
  // API 密钥（也可以使用 SUPERMEMORY_API_KEY 环境变量）
  "apiKey": "sm_...",

  // 记忆检索的最小相似度阈值（0-1）
  "similarityThreshold": 0.6,

  // 每次请求最多注入的记忆数量
  "maxMemories": 5,

  // 最多列出的项目记忆数量
  "maxProjectMemories": 10,

  // 最多注入的用户档案信息数量
  "maxProfileItems": 5,

  // 是否将用户档案注入上下文
  "injectProfile": true,

  // 容器标签前缀（当未设置 userContainerTag/projectContainerTag 时使用）
  "containerTagPrefix": "opencode",

  // 可选：设置精确的用户容器标签（覆盖自动生成的标签）
  "userContainerTag": "my-custom-user-tag",

  // 可选：设置精确的项目容器标签（覆盖自动生成的标签）
  "projectContainerTag": "my-project-tag",

  // 用于记忆检测的额外关键词模式（正则表达式）
  "keywordPatterns": ["log\\s+this", "write\\s+down"],

  // 触发压缩的上下文使用比例（0-1）
  "compactionThreshold": 0.8,
}

所有字段均为可选。环境变量 SUPERMEMORY_API_KEY 优先于配置文件。

容器标签选择

默认情况下，容器标签会使用 containerTagPrefix 加上哈希值自动生成：

• 用户标签：{prefix}_user_{hash(git_email)}
• 项目标签：{prefix}_project_{hash(directory)}

您可以通过指定精确的容器标签来覆盖此行为：

{
  // 为用户记忆使用特定容器标签
  "userContainerTag": "my-team-workspace",

  // 为项目记忆使用特定容器标签
  "projectContainerTag": "my-awesome-project",
}

这在以下情况下非常有用：

• 在团队成员之间共享记忆（使用相同的 userContainerTag）
• 在不同机器上同步同一项目的记忆
• 使用您自己的命名方案组织记忆
• 与其他工具的 Supermemory 容器标签集成

与 Oh My OpenCode 的配合使用

如果您正在使用 Oh My OpenCode，请禁用其内置的自动压缩钩子，以便让 supermemory 处理上下文压缩：

在 ~/.config/opencode/oh-my-opencode.json 中添加：

{
  "disabled_hooks": ["anthropic-context-window-limit-recovery"]
}

开发

bun install
bun run build
bun run typecheck

本地安装：

{
  "plugin": ["file:///path/to/opencode-supermemory"],
}

日志

tail -f ~/.opencode-supermemory.log

许可证

MIT

opencode-supermemory 快速上手指南

opencode-supermemory 是一个 OpenCode 插件，利用 Supermemory 实现持久化记忆功能。它能让你的 AI 代理跨会话、跨项目记住你提供的信息。

环境准备

• 系统要求：支持 macOS、Linux 或 Windows (WSL)
• 前置依赖：
  • 已安装 Bun (用于运行安装命令)
  • 已安装并配置好 OpenCode
  • Supermemory API Key (需在 app.supermemory.ai 注册获取)

安装步骤

1. 运行安装命令

在终端中执行以下命令安装插件：

bunx opencode-supermemory@latest install

该命令会自动将插件注册到 ~/.config/opencode/opencode.jsonc 并创建初始化命令。

2. 配置 API Key

获取 API Key 后，你有两种方式进行配置：

方式一：设置环境变量（推荐）

export SUPERMEMORY_API_KEY="sm_..."

建议将此命令添加到你的 shell 配置文件（如 ~/.bashrc 或 ~/.zshrc）中以永久生效。

方式二：写入配置文件

创建或编辑 ~/.config/opencode/supermemory.jsonc 文件：

{
  "apiKey": "sm_..."
}

3. 验证安装

重启 OpenCode，运行以下命令检查工具列表：

opencode -c

如果输出中包含 supermemory，则说明安装成功。

基本使用

安装完成后，插件会自动介入工作流程，无需复杂配置即可体验核心功能。

1. 自动上下文注入

当你开始新的对话时，Agent 会自动接收以下隐形上下文（无需手动提示）：

• 用户画像：跨项目的偏好设置（如“偏好简洁回答”、“精通 TypeScript"）。
• 项目记忆：当前项目的关键技术栈和构建命令。
• 相关记忆：基于语义搜索匹配的历史知识。

2. 主动记忆保存

在对话中使用特定关键词，Agent 会自动保存信息到记忆库。

示例：

你：Remember that this project uses bun
Agent: [已保存至项目记忆]

支持的触发词包括："remember", "save this", "don't forget" 等。你也可以在配置文件中通过 keywordPatterns 添加自定义触发规则。

3. 代码库索引（可选）

若要让 Agent 全面理解当前项目结构、模式和规范，可运行以下初始化命令：

/supermemory-init

执行后，Agent 将探索代码库并将其结构化为持久记忆。

4. 隐私保护

任何被 <private> 标签包裹的内容都不会被存储。例如：

API key is <private>sk-abc123</private>