oc-tweaks 0.1.3 → 0.3.0

package/README.md

@@ -11,6 +11,7 @@ A collection of runtime enhancement plugins for [OpenCode](https://opencode.ai/)
 The currently available plugins are:
 - **`notify`**: Sends desktop notifications when a task is completed or an error occurs.
 - **`compaction`**: Injects a language preference prompt during session compaction to ensure summaries are in your preferred language.
+- **`autoMemory`**: Smart memory assistant that injects memory context, detects memory trigger phrases, and supports active memory writes via `remember` tool and `/remember` command.
 - **`backgroundSubagent`**: Adds a system prompt to encourage using background sub-agents for better responsiveness.
 - **`leaderboard`**: Reports token usage to [claudecount.com](https://claudecount.com) for community leaderboards.
 
@@ -96,6 +97,20 @@ This plugin ensures that when OpenCode compacts a session's context, the resulti
 |---|---|---|---|
 | `enabled` | boolean | `true` | Enable or disable the plugin. |
 
+### `autoMemory`
+
+This plugin provides an intelligent memory workflow:
+- Injects global/project memory context into system prompt.
+- Adds trigger phrases (Chinese + English) so the assistant remembers when to persist key information.
+- Registers a custom `remember` tool for active memory writes.
+- Creates `~/.config/opencode/commands/remember.md` automatically (if missing) so users can run `/remember` explicitly.
+
+**Configuration Options:**
+
+| Property | Type | Default | Description |
+|---|---|---|---|
+| `enabled` | boolean | `true` | Enable or disable the plugin. |
+
 ### `backgroundSubagent`
 
 This plugin injects a policy into the system prompt, reminding the AI agent to use `run_in_background=true` by default when dispatching sub-agents. It helps maintain a responsive main conversation. If a foreground task is dispatched, a friendly reminder is shown.
@@ -150,6 +165,9 @@ Here is an example of a `~/.config/opencode/oc-tweaks.json` file with all option
   "compaction": {
     "enabled": true
   },
+  "autoMemory": {
+    "enabled": true
+  },
   "backgroundSubagent": {
     "enabled": true
   },
@@ -179,6 +197,7 @@ Here is an example of a `~/.config/opencode/oc-tweaks.json` file with all option
 目前可用的插件包括：
 - **`notify`**: 在任务完成或发生错误时发送桌面通知。
 - **`compaction`**: 在会话上下文压缩期间注入语言偏好提示，以确保摘要使用你的首选语言。
+- **`autoMemory`**: 智能记忆助手——自动注入 memory 上下文、识别触发词，并支持 `remember` tool 与 `/remember` 命令主动写入。
 - **`backgroundSubagent`**: 添加系统提示，鼓励使用后台子代理以获得更好的响应性。
 - **`leaderboard`**: 向 [claudecount.com](https://claudecount.com) 报告 token 用量，用于社区排行榜。
 
@@ -264,6 +283,20 @@ bunx oc-tweaks init
 |---|---|---|---|
 | `enabled` | boolean | `true` | 启用或禁用此插件。 |
 
+### `autoMemory`
+
+该插件提供智能记忆工作流：
+- 自动把全局/项目 memory 上下文注入 system prompt。
+- 内置中英文触发词，命中后优先执行记忆写入。
+- 注册自定义 `remember` tool，支持 AI 主动写入 memory 文件。
+- 自动创建 `~/.config/opencode/commands/remember.md`（若不存在），支持用户显式输入 `/remember`。
+
+**配置选项:**
+
+| 属性 | 类型 | 默认值 | 描述 |
+|---|---|---|---|
+| `enabled` | boolean | `true` | 启用或禁用此插件。 |
+
 ### `backgroundSubagent`
 
 此插件向系统提示中注入一项策略，提醒 AI 代理在派发子代理时默认使用 `run_in_background=true`。这有助于保持主对话的响应性。如果派发了前台任务，则会显示一个友好的提醒。
@@ -318,6 +351,9 @@ bunx oc-tweaks init
   "compaction": {
     "enabled": true
   },
+  "autoMemory": {
+    "enabled": true
+  },
   "backgroundSubagent": {
     "enabled": true
   },

package/dist/cli/init.js

@@ -7,6 +7,7 @@ import { dirname } from "path";
 var DEFAULT_CONFIG = {
   notify: { enabled: true },
   compaction: { enabled: true },
+  autoMemory: { enabled: true },
   backgroundSubagent: { enabled: true },
   leaderboard: { enabled: false },
   logging: { enabled: false, maxLines: 200 }

package/dist/index.js

@@ -1,3 +1,6 @@
+// src/plugins/auto-memory.ts
+import { mkdir as mkdir2, readdir } from "node:fs/promises";
+
 // src/utils/logger.ts
 import { mkdir } from "node:fs/promises";
 import { dirname } from "node:path";
@@ -59,6 +62,7 @@ async function loadJsonConfig(path, defaults) {
 }
 var DEFAULT_CONFIG = {
   compaction: {},
+  autoMemory: {},
   backgroundSubagent: {},
   leaderboard: {},
   notify: {}
@@ -76,6 +80,186 @@ async function loadOcTweaksConfig() {
     return null;
   }
 }
+// src/plugins/auto-memory.ts
+var TRIGGER_WORDS_CN = ["记住", "保存偏好", "记录一下", "记到memory", "别忘了"];
+var TRIGGER_WORDS_EN = ["remember", "save to memory", "note this down", "don't forget", "record"];
+var REMEMBER_COMMAND_CONTENT = `---
+description: 记忆助手 - 将关键信息写入 memory 文件
+---
+
+当用户希望你记住偏好、决策或长期有价值的信息时，
+直接使用 Write 或 Edit 工具操作 memory 文件。
+
+## 保存位置
+- 全局 memory：\`~/.config/opencode/memory/\`
+- 项目 memory：\`{project}/.opencode/memory/\`
+
+## 保存步骤
+1. 提取要保存的信息（保持原意，不扩写）
+2. 确定文件分类（如 preferences.md、decisions.md、setup.md、notes.md）
+3. 确定 scope（全局 vs 项目级）
+4. 使用 Read 工具检查目标文件是否已存在，读取现有内容
+5. 使用 Edit 工具追加新内容（若文件存在），或用 Write 创建新文件
+
+## 格式规范
+- 使用 markdown bullet points
+- 保持简洁，不扩写
+- 不存临时信息（只存跨会话有价值的内容）
+- 不重复 AGENTS.md / CLAUDE.md 中已有的内容
+
+如有参数，则优先围绕参数提取重点：$ARGUMENTS
+`;
+function getHome2() {
+  return Bun.env?.HOME ?? process.env.HOME ?? "";
+}
+async function listMarkdownFiles(path) {
+  try {
+    const entries = await readdir(path);
+    return entries.filter((item) => item.endsWith(".md")).sort();
+  } catch {
+    return [];
+  }
+}
+async function ensureRememberCommand(home) {
+  const commandDir = `${home}/.config/opencode/commands`;
+  const commandPath = `${commandDir}/remember.md`;
+  const commandFile = Bun.file(commandPath);
+  if (await commandFile.exists()) {
+    try {
+      const existing = await commandFile.text();
+      if (existing.trim() === REMEMBER_COMMAND_CONTENT.trim())
+        return;
+    } catch {}
+  }
+  await mkdir2(commandDir, { recursive: true });
+  await Bun.write(commandPath, REMEMBER_COMMAND_CONTENT);
+}
+async function ensureAutoMemoryInfra(home, projectMemoryDir) {
+  await mkdir2(`${home}/.config/opencode/memory`, { recursive: true });
+  await mkdir2(projectMemoryDir, { recursive: true });
+  await ensureRememberCommand(home);
+}
+function buildMemoryGuide(params) {
+  const globalList = params.globalFiles.length > 0 ? params.globalFiles.map((name) => `- \`${name}\``).join(`
+`) : "- （暂无全局 memory 文件）";
+  const projectList = params.projectFiles.length > 0 ? params.projectFiles.map((name) => `- \`${name}\``).join(`
+`) : "- （暂无项目级 memory 文件）";
+  const injectedContents = params.fileContents.size > 0 ? Array.from(params.fileContents.entries()).sort(([a], [b]) => a.localeCompare(b)).map(([path, content]) => `Contents of ${path}:
+${content}`).join(`
+
+`) : "（暂无可注入的 memory 内容）";
+  return `## \uD83E\uDDE0 Memory 系统指引
+
+Memory 是 AGENTS.md / CLAUDE.md 的**补充**，用于存储跨会话有价值的信息。
+不要将 AGENTS.md / CLAUDE.md 中已有的内容重复写入 memory。
+
+可用记忆层：
+1. 全局 memory：\`${params.globalMemoryDir}\`
+2. 项目 memory：\`${params.projectMemoryDir}\`
+
+### 何时保存 memory
+
+**你必须（MUST）保存 memory 当：**
+- 用户明确要求记住（触发词：${TRIGGER_WORDS_CN.join("、")} / ${TRIGGER_WORDS_EN.join(", ")})
+- 用户纠正了你的行为或表达了明确偏好
+
+**建议保存 memory 当：**
+- 发现了跨会话有用的模式或约定（想想：如果明天从头开始，这个信息有帮助吗？）
+- 用户描述了目标或背景（"我在做..."、"我们在迁移到..."）
+- 找到了可能再次出现的问题的解决方案
+- 用户的工作流、工具、沟通风格偏好
+
+### 不要保存
+
+- 临时的当前任务细节（只在本次对话有用的信息）
+- AGENTS.md 或 CLAUDE.md 中已有的内容（不得重复或矛盾）
+- 可能不完整或未验证的结论（先查证再记录）
+- 机密信息（密码、API key 等）
+
+### 如何保存
+
+直接使用你的内置 Write 或 Edit 工具操作 memory 文件：
+- 全局 memory：\`${params.globalMemoryDir}/\`
+- 项目 memory：\`${params.projectMemoryDir}/\`
+
+文件按主题分类（如 preferences.md、decisions.md、setup.md、notes.md）。
+写入时保持简洁，用 markdown bullet points，保持原意不扩写。
+
+### 如何更新已有 memory
+
+- 更新已有文件时，使用 Edit 工具追加或修改特定段落，不要用 Write 整体覆盖
+- 内容要具体、信息密集（包含文件路径、函数名、具体命令等）
+- 当某个 memory 文件内容过长时，精简旧条目而不是无限追加
+- 更新时保持已有内容的结构完整，不要破坏其他条目
+
+### 当前 Memory 文件
+**全局**
+${globalList}
+
+**项目级**
+${projectList}
+
+### 用户核心 Preferences
+${injectedContents}`;
+}
+var autoMemoryPlugin = async ({ directory }) => {
+  const home = getHome2();
+  const globalMemoryDir = `${home}/.config/opencode/memory`;
+  const projectMemoryDir = `${directory}/.opencode/memory`;
+  try {
+    const config = await loadOcTweaksConfig();
+    if (config?.autoMemory?.enabled === true) {
+      await ensureAutoMemoryInfra(home, projectMemoryDir);
+    }
+  } catch {}
+  return {
+    "experimental.chat.system.transform": safeHook("auto-memory:system.transform", async (_input, output) => {
+      const config = await loadOcTweaksConfig();
+      if (!config || config.autoMemory?.enabled !== true)
+        return;
+      await ensureAutoMemoryInfra(home, projectMemoryDir);
+      const [globalFiles, projectFiles] = await Promise.all([
+        listMarkdownFiles(globalMemoryDir),
+        listMarkdownFiles(projectMemoryDir)
+      ]);
+      const fileContents = new Map;
+      const allPaths = [
+        ...globalFiles.map((name) => ({ dir: globalMemoryDir, name })),
+        ...projectFiles.map((name) => ({ dir: projectMemoryDir, name }))
+      ];
+      await Promise.all(allPaths.map(async ({ dir, name }) => {
+        try {
+          const content = await Bun.file(`${dir}/${name}`).text();
+          if (content.trim())
+            fileContents.set(`${dir}/${name}`, content.trim());
+        } catch {}
+      }));
+      output.system.push(buildMemoryGuide({
+        globalMemoryDir,
+        projectMemoryDir,
+        globalFiles,
+        projectFiles,
+        fileContents
+      }));
+    }),
+    "experimental.session.compacting": safeHook("auto-memory:compacting", async (_input, output) => {
+      const config = await loadOcTweaksConfig();
+      if (!config || config.autoMemory?.enabled !== true)
+        return;
+      await ensureAutoMemoryInfra(home, projectMemoryDir);
+      output.context.push(`## \uD83D\uDCBE Memory 保存提示 (Compaction Phase)
+
+如果本轮对话有值得长期保存的信息，请在摘要中标记：
+
+\`\`\`
+[MEMORY: 文件名.md]
+这里写要保存的内容
+\`\`\`
+
+后续对话中应根据该标记调用内置 Read/Edit/Write 工具写入对应 memory 文件。`);
+    })
+  };
+};
 // src/plugins/background-subagent.ts
 var SUB_AGENT_DISPATCH_PROMPT = `
 ## Sub-Agent Dispatch Policy
@@ -141,7 +325,7 @@ var compactionPlugin = async () => {
   };
 };
 // src/plugins/leaderboard.ts
-function getHome2() {
+function getHome3() {
   return Bun.env?.HOME ?? (globalThis?.process?.env?.HOME ?? "") ?? "";
 }
 var API_ENDPOINT = "https://api.claudecount.com/api/usage/hook";
@@ -185,7 +369,7 @@ async function loadLeaderboardConfig(configPath) {
   if (typeof configPath === "string") {
     return readLeaderboardConfig(configPath);
   }
-  const paths = [`${getHome2()}/.claude/leaderboard.json`, `${getHome2()}/.config/claude/leaderboard.json`];
+  const paths = [`${getHome3()}/.claude/leaderboard.json`, `${getHome3()}/.config/claude/leaderboard.json`];
   for (const path of paths) {
     const config = await readLeaderboardConfig(path);
     if (config)
@@ -550,5 +734,6 @@ export {
   notifyPlugin,
   leaderboardPlugin,
   compactionPlugin,
-  backgroundSubagentPlugin
+  backgroundSubagentPlugin,
+  autoMemoryPlugin
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oc-tweaks",
-  "version": "0.1.3",
+  "version": "0.3.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js"