opencode-session-renamer 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joseph Han
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,171 @@
+# opencode-session-renamer
+
+Chinese version: [简体中文](#简体中文)
+
+Automatically generates a session title from the user's first message and renames the OpenCode session (with a timestamp suffix).
+
+## Install
+
+Add the plugin to your `~/.config/opencode/opencode.jsonc`:
+
+```jsonc
+{
+  "plugin": ["opencode-session-renamer"]
+}
+```
+
+Restart OpenCode after installation.
+
+## Development Install
+
+For development or contributing, you can install from source:
+
+### Option 1: Symlink to Plugin Directory
+
+```bash
+# Clone the repo
+git clone https://github.com/joseph-bing-han/opencode-session-renamer.git
+cd opencode-session-renamer
+
+# Install dependencies and build
+bun install
+bun run build
+
+# Create symlink
+ln -sf $(pwd)/src/index.ts ~/.config/opencode/plugin/session-renamer.ts
+```
+
+### Option 2: Configure Local Path
+
+Add the local path to `~/.config/opencode/opencode.jsonc`:
+
+```jsonc
+{
+  "plugin": [
+    "/path/to/opencode-session-renamer/dist/index.js"
+  ]
+}
+```
+
+## Configuration
+
+The plugin loads config files in this order (first match wins):
+
+1. `<project>/.opencode/session-renamer.jsonc`
+2. `<project>/.opencode/session-renamer.json`
+3. `~/.config/opencode/session-renamer.jsonc`
+4. `~/.config/opencode/session-renamer.json`
+
+Example:
+
+```jsonc
+{
+  "model": "opencode/grok-code",
+  "titleMaxLength": 20,
+  "dateFormat": "YY-MM-DD HH:mm",
+  "minMessageLength": 5,
+  "debug": false
+}
+```
+
+Fields:
+
+- `model`: Model used for title generation in `providerID/modelID` format. Default: `opencode/grok-code`.
+- `titleMaxLength`: Maximum title length (excluding the timestamp suffix).
+- `dateFormat`: Date format (currently supports: `YYYY` / `YY` / `MM` / `DD` / `HH` / `mm`).
+- `minMessageLength`: Minimum message length to trigger rename (to avoid renaming on very short messages).
+- `debug`: Enable debug logs (prefixed with `[session-renamer]`).
+
+## FAQ
+
+### 1) Why do I get `ProviderModelNotFoundError`?
+
+This usually means `model` is set to a model ID that doesn't exist in your current OpenCode provider list. Change it to a valid model (e.g. `opencode/grok-code` or `opencode/glm-4.7-free`).
+
+The plugin also tries to fetch available models from OpenCode `/config/providers` and fall back automatically, but the most reliable approach is still to set `model` to an ID that is available in your environment.
+
+---
+
+## 简体中文
+
+自动根据用户第一条消息内容，为 OpenCode 的会话生成标题并重命名（附带时间后缀）。
+
+### 安装
+
+在 `~/.config/opencode/opencode.jsonc` 中添加插件：
+
+```jsonc
+{
+  "plugin": ["opencode-session-renamer"]
+}
+```
+
+安装后需要重启 OpenCode。
+
+### 开发安装
+
+如需开发或贡献代码，可以从源码安装：
+
+#### 方式一：符号链接到插件目录
+
+```bash
+# 克隆仓库
+git clone https://github.com/joseph-bing-han/opencode-session-renamer.git
+cd opencode-session-renamer
+
+# 安装依赖并构建
+bun install
+bun run build
+
+# 创建符号链接
+ln -sf $(pwd)/src/index.ts ~/.config/opencode/plugin/session-renamer.ts
+```
+
+#### 方式二：配置本地路径
+
+在 `~/.config/opencode/opencode.jsonc` 中添加本地路径：
+
+```jsonc
+{
+  "plugin": [
+    "/path/to/opencode-session-renamer/dist/index.js"
+  ]
+}
+```
+
+### 配置
+
+插件会按以下顺序加载配置文件（先找到的优先）：
+
+1. `<project>/.opencode/session-renamer.jsonc`
+2. `<project>/.opencode/session-renamer.json`
+3. `~/.config/opencode/session-renamer.jsonc`
+4. `~/.config/opencode/session-renamer.json`
+
+示例：
+
+```jsonc
+{
+  "model": "opencode/grok-code",
+  "titleMaxLength": 20,
+  "dateFormat": "YY-MM-DD HH:mm",
+  "minMessageLength": 5,
+  "debug": false
+}
+```
+
+字段说明：
+
+- `model`: 生成标题使用的模型，格式为 `providerID/modelID`。默认 `opencode/grok-code`。
+- `titleMaxLength`: 标题最大长度（不含日期后缀）。
+- `dateFormat`: 日期格式（当前实现支持：`YYYY` / `YY` / `MM` / `DD` / `HH` / `mm`）。
+- `minMessageLength`: 触发重命名的最小消息长度（避免过短消息触发）。
+- `debug`: 开启后输出调试日志（前缀为 `[session-renamer]`）。
+
+### 常见问题
+
+#### 1) 为什么报 `ProviderModelNotFoundError`？
+
+通常是 `model` 配置了不存在的模型 ID。请改成真实存在的模型（例如 `opencode/grok-code` 或 `opencode/glm-4.7-free`）。
+
+插件内部也会尝试从 OpenCode 的 `/config/providers` 获取可用模型并自动回退，但最稳妥的方式仍是把 `model` 配置成你当前环境确实可用的 ID。

package/dist/config.d.ts

@@ -0,0 +1,10 @@
+export interface SessionRenamerConfig {
+    model: string;
+    titleMaxLength: number;
+    dateFormat: string;
+    minMessageLength: number;
+    debug: boolean;
+}
+export declare const DEFAULT_CONFIG: SessionRenamerConfig;
+export declare function loadConfig(directory: string): SessionRenamerConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,oBAAoB;IAGnC,KAAK,EAAE,MAAM,CAAC;IAGd,cAAc,EAAE,MAAM,CAAC;IAIvB,UAAU,EAAE,MAAM,CAAC;IAGnB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,eAAO,MAAM,cAAc,EAAE,oBAM5B,CAAC;AAUF,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,oBAAoB,CAqBlE"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import type { Plugin } from "@opencode-ai/plugin";
+declare const plugin: Plugin;
+export declare const sessionRenamer: Plugin;
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAkRlD,QAAA,MAAM,MAAM,EAAE,MAyEb,CAAC;AAGF,eAAO,MAAM,cAAc,QAAS,CAAC;AAGrC,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,307 @@
+// @bun
+// src/config.ts
+import { readFileSync, existsSync } from "fs";
+import { join } from "path";
+var DEFAULT_CONFIG = {
+  model: "opencode/grok-code",
+  titleMaxLength: 20,
+  dateFormat: "YY-MM-DD HH:mm",
+  minMessageLength: 5,
+  debug: false
+};
+function parseJsonc(content) {
+  const stripped = content.replace(/\/\/.*$/gm, "").replace(/\/\*[\s\S]*?\*\//g, "").replace(/,(\s*[}\]])/g, "$1");
+  return JSON.parse(stripped);
+}
+function loadConfig(directory) {
+  const configPaths = [
+    join(directory, ".opencode", "session-renamer.jsonc"),
+    join(directory, ".opencode", "session-renamer.json"),
+    join(process.env.HOME || "~", ".config", "opencode", "session-renamer.jsonc"),
+    join(process.env.HOME || "~", ".config", "opencode", "session-renamer.json")
+  ];
+  for (const configPath of configPaths) {
+    if (existsSync(configPath)) {
+      try {
+        const content = readFileSync(configPath, "utf-8");
+        const userConfig = parseJsonc(content);
+        return { ...DEFAULT_CONFIG, ...userConfig };
+      } catch (error) {
+        console.error(`[session-renamer] Failed to parse config at ${configPath}:`, error);
+      }
+    }
+  }
+  return DEFAULT_CONFIG;
+}
+
+// src/index.ts
+var SYSTEM_PROMPT = `You are a session title generator. Generate a concise, descriptive title for a coding session based on the user's first message.
+
+Rules:
+- Title must be in the same language as the user's message
+- Title should capture the main task/topic
+- Keep it short and descriptive (max {maxLength} characters)
+- No quotes, no punctuation at the end
+- Just output the title, nothing else
+
+Examples:
+- User: "Help me fix the login bug in auth.ts" -> "Fix login bug"
+- User: "I want to refactor the database module" -> "Refactor database module"
+- User: "Please optimize this React component's performance" -> "Optimize React component performance"`;
+var renamedSessions = new Set;
+var tempSessions = new Set;
+var providersConfigPromise = null;
+function formatDate(format) {
+  const now = new Date;
+  const pad = (n) => n.toString().padStart(2, "0");
+  const year = now.getFullYear();
+  const month = pad(now.getMonth() + 1);
+  const day = pad(now.getDate());
+  const hours = pad(now.getHours());
+  const minutes = pad(now.getMinutes());
+  return format.replace("YYYY", year.toString()).replace("YY", year.toString().slice(-2)).replace("MM", month).replace("DD", day).replace("HH", hours).replace("mm", minutes);
+}
+function parseModelString(modelStr) {
+  const parts = modelStr.split("/");
+  if (parts.length >= 2) {
+    return { providerID: parts[0], modelID: parts.slice(1).join("/") };
+  }
+  return { providerID: "opencode", modelID: modelStr };
+}
+function normalizeConfiguredModel(modelStr) {
+  const trimmed = modelStr.trim();
+  if (!trimmed) {
+    return null;
+  }
+  const parts = trimmed.split("/");
+  if (parts.length >= 2) {
+    const providerID = parts[0]?.trim();
+    const modelID = parts.slice(1).join("/").trim();
+    if (!providerID || !modelID) {
+      return null;
+    }
+    return { providerID, modelID };
+  }
+  return parseModelString(trimmed);
+}
+function isProviderModelNotFoundError(error) {
+  if (!error || typeof error !== "object") {
+    return false;
+  }
+  const err = error;
+  const name = err.name;
+  if (typeof name === "string" && name.toLowerCase().includes("modelnotfound")) {
+    return true;
+  }
+  const message = err.message;
+  if (typeof message === "string" && message.toLowerCase().includes("modelnotfound")) {
+    return true;
+  }
+  const data = err.data;
+  if (data && typeof data === "object") {
+    const d = data;
+    return typeof d.providerID === "string" && typeof d.modelID === "string";
+  }
+  return false;
+}
+async function getProvidersConfig(client, directory) {
+  if (!providersConfigPromise) {
+    providersConfigPromise = client.config.providers({ query: { directory } }).then((res) => res.data ?? null).catch(() => null);
+  }
+  return providersConfigPromise;
+}
+async function resolveModelForPrompt(client, directory, configModel) {
+  const requested = normalizeConfiguredModel(configModel);
+  const providersConfig = await getProvidersConfig(client, directory);
+  if (!providersConfig) {
+    return requested ?? undefined;
+  }
+  if (!requested) {
+    const opencodeProvider2 = providersConfig.providers.find((p) => p.id === "opencode");
+    if (opencodeProvider2) {
+      const defaultModelID = providersConfig.default?.[opencodeProvider2.id];
+      if (defaultModelID && opencodeProvider2.models?.[defaultModelID]) {
+        return { providerID: opencodeProvider2.id, modelID: defaultModelID };
+      }
+      const firstModelID = Object.keys(opencodeProvider2.models ?? {})[0];
+      if (firstModelID) {
+        return { providerID: opencodeProvider2.id, modelID: firstModelID };
+      }
+    }
+    for (const provider2 of providersConfig.providers) {
+      const defaultModelID = providersConfig.default?.[provider2.id];
+      if (defaultModelID && provider2.models?.[defaultModelID]) {
+        return { providerID: provider2.id, modelID: defaultModelID };
+      }
+    }
+    for (const provider2 of providersConfig.providers) {
+      const firstModelID = Object.keys(provider2.models ?? {})[0];
+      if (firstModelID) {
+        return { providerID: provider2.id, modelID: firstModelID };
+      }
+    }
+    return;
+  }
+  const provider = providersConfig.providers.find((p) => p.id === requested.providerID);
+  if (provider?.models?.[requested.modelID]) {
+    return requested;
+  }
+  if (provider) {
+    const defaultModelID = providersConfig.default?.[provider.id];
+    if (defaultModelID && provider.models?.[defaultModelID]) {
+      return { providerID: provider.id, modelID: defaultModelID };
+    }
+    const firstModelID = Object.keys(provider.models ?? {})[0];
+    if (firstModelID) {
+      return { providerID: provider.id, modelID: firstModelID };
+    }
+  }
+  const opencodeProvider = providersConfig.providers.find((p) => p.id === "opencode");
+  if (opencodeProvider) {
+    const defaultModelID = providersConfig.default?.[opencodeProvider.id];
+    if (defaultModelID && opencodeProvider.models?.[defaultModelID]) {
+      return { providerID: opencodeProvider.id, modelID: defaultModelID };
+    }
+    const firstModelID = Object.keys(opencodeProvider.models ?? {})[0];
+    if (firstModelID) {
+      return { providerID: opencodeProvider.id, modelID: firstModelID };
+    }
+  }
+  return;
+}
+function log(config, ...args) {
+  if (config.debug) {
+    console.log("[session-renamer]", ...args);
+  }
+}
+async function generateTitle(client, config, userMessage, directory) {
+  try {
+    const resolvedModel = await resolveModelForPrompt(client, directory, config.model);
+    if (resolvedModel) {
+      log(config, "Using model:", `${resolvedModel.providerID}/${resolvedModel.modelID}`);
+    } else {
+      log(config, "Using server default model (no explicit model override)");
+    }
+    const tempSession = await client.session.create({
+      body: {}
+    });
+    if (!tempSession.data?.id) {
+      console.error("[session-renamer] Failed to create temp session");
+      return null;
+    }
+    const tempSessionId = tempSession.data.id;
+    tempSessions.add(tempSessionId);
+    try {
+      const promptBodyBase = {
+        system: SYSTEM_PROMPT.replace("{maxLength}", config.titleMaxLength.toString()),
+        parts: [
+          {
+            type: "text",
+            text: `Generate a title for this message:
+
+${userMessage}`
+          }
+        ]
+      };
+      const doPrompt = async (modelOverride) => client.session.prompt({
+        path: { id: tempSessionId },
+        body: modelOverride ? { ...promptBodyBase, model: modelOverride } : promptBodyBase
+      });
+      let response;
+      try {
+        response = await doPrompt(resolvedModel);
+      } catch (error) {
+        if (isProviderModelNotFoundError(error)) {
+          log(config, "Configured model unavailable, retrying with server default model");
+          response = await doPrompt(undefined);
+        } else {
+          throw error;
+        }
+      }
+      if (!response.data) {
+        return null;
+      }
+      const textPart = response.data.parts?.find((p) => p.type === "text");
+      if (!textPart || textPart.type !== "text") {
+        return null;
+      }
+      let title = textPart.text.trim();
+      if (title.length > config.titleMaxLength) {
+        title = title.slice(0, config.titleMaxLength);
+      }
+      return title;
+    } finally {
+      await client.session.delete({ path: { id: tempSessionId } }).catch(() => {});
+    }
+  } catch (error) {
+    console.error("[session-renamer] Failed to generate title:", error);
+    return null;
+  }
+}
+var plugin = async (ctx) => {
+  const config = loadConfig(ctx.directory);
+  log(config, "Plugin loaded with config:", config);
+  return {
+    "chat.message": async (input, output) => {
+      const { sessionID } = input;
+      const { message, parts } = output;
+      log(config, "chat.message hook triggered for session:", sessionID);
+      if (tempSessions.has(sessionID)) {
+        log(config, "Temp session, skipping:", sessionID);
+        return;
+      }
+      if (renamedSessions.has(sessionID)) {
+        log(config, "Session already renamed, skipping:", sessionID);
+        return;
+      }
+      let userMessage = null;
+      if (message.summary?.title) {
+        userMessage = message.summary.title;
+        log(config, "Using message summary title:", userMessage.slice(0, 50) + "...");
+      } else if (message.summary?.body) {
+        userMessage = message.summary.body;
+        log(config, "Using message summary body:", userMessage.slice(0, 50) + "...");
+      } else {
+        const textPart = parts.find((p) => p.type === "text");
+        if (textPart && textPart.type === "text" && "text" in textPart) {
+          userMessage = textPart.text;
+          log(config, "Using assistant response:", userMessage.slice(0, 50) + "...");
+        }
+      }
+      if (!userMessage) {
+        log(config, "No content found for title generation");
+        return;
+      }
+      if (userMessage.length < config.minMessageLength) {
+        log(config, "Message too short, skipping");
+        return;
+      }
+      renamedSessions.add(sessionID);
+      setImmediate(async () => {
+        try {
+          const title = await generateTitle(ctx.client, config, userMessage, ctx.directory);
+          if (!title) {
+            log(config, "Failed to generate title for session:", sessionID);
+            return;
+          }
+          const dateStr = formatDate(config.dateFormat);
+          const fullTitle = `${title}(${dateStr})`;
+          await ctx.client.session.update({
+            path: { id: sessionID },
+            body: { title: fullTitle }
+          });
+          log(config, "Renamed session:", sessionID, "->", fullTitle);
+        } catch (error) {
+          console.error("[session-renamer] Failed to rename session:", error);
+          renamedSessions.delete(sessionID);
+        }
+      });
+    }
+  };
+};
+var sessionRenamer = plugin;
+var src_default = plugin;
+export {
+  sessionRenamer,
+  src_default as default
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "opencode-session-renamer",
+  "version": "1.0.0",
+  "description": "Auto-rename opencode sessions based on conversation content",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "session-renamer.example.jsonc"
+  ],
+  "keywords": [
+    "opencode",
+    "plugin",
+    "session",
+    "rename",
+    "ai"
+  ],
+  "author": "Joseph Han",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joseph-bing-han/opencode-session-renamer"
+  },
+  "scripts": {
+    "build": "bun build src/index.ts --outdir dist --target bun && tsc --emitDeclarationOnly --declaration --outDir dist",
+    "dev": "bun run --watch src/index.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "dependencies": {
+    "@opencode-ai/plugin": "latest"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@opencode-ai/plugin": "*"
+  }
+}

package/session-renamer.example.jsonc

@@ -0,0 +1,16 @@
+{
+  // 用于生成标题的 LLM 模型，格式： "providerID/modelID"；留空表示使用服务端默认模型
+  "model": "opencode/grok-code",
+
+  // 标题最大长度（不含日期后缀）
+  "titleMaxLength": 20,
+
+  // 日期格式：YY=年，MM=月，DD=日，HH=小时，mm=分钟
+  "dateFormat": "YY-MM-DD HH:mm",
+
+  // 触发重命名的最小消息长度
+  "minMessageLength": 5,
+
+  // 是否开启调试日志
+  "debug": false
+}