这个项目能做什么
# opencode-supermemory
**由[Supermemory](https://supermemory.ai)驱动的OpenCode持久记忆**
该插件为OpenCode代理提供跨会话和项目的持久记忆。它自动注入相关上下文、捕获对话轮次,并提供存储和检索记忆的工具。
## 安装
```bash
bunx opencode-supermemory@latest install
bunx opencode-supermemory@latest login # 或设置SUPERMEMORY_API_KEY
bunx opencode-supermemory@latest status # 随时检查连接状态
```
或者将其粘贴到OpenCode中:`Install opencode-supermemory by following https://raw.githubusercontent.com/supermemoryai/opencode-supermemory/main/README.md`
聊天内命令:`/supermemory-init`、`/supermemory-login`、`/supermemory-logout`、`/supermemory-status`。
## 功能
- **上下文注入**:在会话的第一条消息中,代理会收到您的个人资料、项目知识,以及可选的个人记忆语义搜索。
- **理性回忆**:每一轮,代理在回答前决定回忆记忆是否有帮助,仅在需要时通过`supermemory`工具进行搜索。
- **自动捕获**:完成的对话轮次每`captureEveryNTurns`轮保存一次,会话结束时刷新剩余部分。`<private>`内容会被编辑。
- **关键词检测**:说出"记住"、"保存这个"、"别忘了"(或自定义模式)会提示代理保存到记忆。
- **代码库索引**:`/supermemory-init`探索并记忆代码库结构、模式和约定。
- **预防性压缩**:在上下文容量达到80%时,触发摘要生成,将项目记忆注入摘要,并将摘要保存为记忆。
- **隐私**:包裹在`<private>...</private>`中的内容永远不会被存储。
- **更新通知**:会话开始时检查npm是否有新版本。
## 工具使用
`supermemory`工具支持模式:`add`、`search`、`profile`、`list`、`forget`、`help`。范围:`user`(个人)和`project`(默认)。类型包括`project-config`、`architecture`、`error-solution`、`preference`、`learned-pattern`、`conversation`。
## 记忆范围
记忆被标记为`repo_{项目名}__{仓库哈希}`和元数据`sm_scope`(个人或项目)。哈希来自规范化的Git origin远程地址,因此Claude Code、Codex、Cursor和OpenCode对同一仓库共享相同的容器。旧版本的遗留容器仍然可读。
## 配置
环境变量:`SUPERMEMORY_API_KEY`、`SUPERMEMORY_API_URL`/`SUPERMEMORY_BASE_URL`、`SUPERMEMORY_AUTH_URL`、`SUPERMEMORY_AUTH_TIMEOUT`、`SUPERMEMORY_REPO_TAG`、`SUPERMEMORY_ISOLATE_WORKTREES`、`SUPERMEMORY_DEBUG`。
配置文件`~/.config/opencode/supermemory.jsonc`支持选项,如`similarityThreshold`、`maxMemories`、`injectProfile`、`autoRecallEveryPrompt`、`keywordPatterns`、`compactionThreshold`、`captureEveryNTurns`、`recallMode`(direct/advisory/off)以及容器标签覆盖。
## 与Oh My OpenCode一起使用
禁用其自动压缩钩子以避免冲突:将`{"disabled_hooks": ["anthropic-context-window-limit-recovery"]}`添加到`~/.config/opencode/oh-my-opencode.json`。
## 开发
```bash
bun install
bun run build
bun run typecheck
```
日志:`tail -f ~/.opencode-supermemory.log`
## 许可证
MIT
评论
0 评分人数达到10人后显示
登录后参与讨论。