opencode-diff-viewer 1.0.7 → 1.0.9

package/README.md

@@ -3,49 +3,18 @@
 [![npm version](https://img.shields.io/npm/v/opencode-diff-viewer.svg)](https://www.npmjs.com/package/opencode-diff-viewer)
 [![npm downloads](https://img.shields.io/npm/dm/opencode-diff-viewer.svg)](https://www.npmjs.com/package/opencode-diff-viewer)
 
-一个 OpenCode 插件，使用 [lumen](https://github.com/jnsahaj/lumen) 提供美观的 TUI diff 查看功能。
+一个 OpenCode 插件，使用 [lumen](https://github.com/jnsahaj/lumen) + [tmux](https://github.com/tmux/tmux) 提供美观的 TUI diff 查看功能。
 
 ## 功能特性
 
-- ✨ **自动安装 lumen** - 插件会自动检测并安装 lumen 依赖
+- ✨ **自动安装 tmux 和 lumen** - 插件会自动检测并安装依赖
 - 🚀 **一键查看 diff** - 使用 `/diff` 命令快速查看代码变更
-- 🔧 **智能终端适配** - 自动检测操作系统，打开新终端窗口展示 diff
+- 🔧 **tmux 集成** - 在后台 tmux 会话中运行 lumen
 - 🤖 **LLM 工具集成** - LLM 可自动调用 `view_diff` 工具
 
-## 前置条件
-
-### 1. 安装 lumen
-
-插件会自动尝试安装 lumen，如果自动安装失败，需要手动安装：
-
-**macOS / Linux (Homebrew)**:
-```bash
-brew install jnsahaj/lumen/lumen
-```
-
-**Bun**:
-```bash
-bun install jnsahaj/lumen/lumen
-```
-
-**Cargo (Rust)**:
-```bash
-cargo install lumen
-```
-
-**Windows**:
-下载 [lumen releases](https://github.com/jnsahaj/lumen/releases) 并添加到 PATH
+## 快速开始
 
-### 2. Git 仓库
-
-确保项目是 git 仓库，并且有修改的文件：
-```bash
-git status  # 查看修改的文件
-```
-
-## 安装（全局配置）
-
-### 1. 安装 npm 包
+### 1. 安装插件
 
 ```bash
 # npm
@@ -58,7 +27,7 @@ pnpm add -g opencode-diff-viewer
 bun add -g opencode-diff-viewer
 ```
 
-### 2. 配置全局 opencode.json
+### 2. 配置 OpenCode
 
 创建或编辑 `~/.config/opencode/opencode.json`：
 
@@ -68,7 +37,7 @@ cat > ~/.config/opencode/opencode.json << 'EOF'
 {
   "command": {
     "diff": {
-      "template": "View git diff using lumen TUI.",
+      "template": "View git diff using lumen in tmux.",
       "description": "View diff of modified files using lumen TUI"
     }
   },
@@ -77,28 +46,53 @@ cat > ~/.config/opencode/opencode.json << 'EOF'
 EOF
 ```
 
-### 3. 重启 OpenCode
+### 3. 启动 OpenCode（使用启动脚本）
+
+```bash
+# 使用启动脚本自动在 tmux 中启动 OpenCode
+opencode-diff-viewer
 
-安装完成后重启 OpenCode TUI，插件会自动加载。
+# 或手动运行
+./start-opencode.sh
+```
+
+启动脚本会自动：
+- 检查并安装 tmux（如果未安装）
+- 在 tmux 会话中启动 OpenCode
+- 附加到 tmux 会话
 
 ## 使用方法
 
-### 通过命令
+### 在 OpenCode 中使用 /diff
 
-在 OpenCode TUI 中直接输入：
+在 OpenCode TUI 中输入：
 
 ```bash
 /diff              # 查看所有修改文件的 diff
 /diff src/app.ts   # 查看指定文件的 diff
 ```
 
-### 通过 LLM
+执行后，lumen 会在 tmux 会话 `opencode-diff-viewer` 中运行。
 
-LLM 可以自动调用 `view_diff` 工具来展示代码变更。无需手动操作，LLM 会根据对话上下文智能判断何时需要展示 diff。
+### 查看 lumen diff
 
-## lumen 快捷键
+**新开一个终端窗口**，运行：
 
-在 lumen diff 查看器中：
+```bash
+tmux attach -t opencode-diff-viewer
+```
+
+查看完成后，按 `Ctrl+B` 然后 `D` 分离 tmux 会话，回到 OpenCode。
+
+## tmux 快捷键
+
+| 快捷键 | 功能 |
+|--------|------|
+| `Ctrl+B` 然后 `D` | 分离会话（回到终端） |
+| `Ctrl+B` 然后 `?` | 查看所有快捷键 |
+| `Ctrl+C` | 终止当前会话 |
+
+## lumen 快捷键
 
 | 快捷键 | 功能 |
 |--------|------|
@@ -108,63 +102,71 @@ LLM 可以自动调用 `view_diff` 工具来展示代码变更。无需手动操
 | `e` | 在编辑器中打开文件 |
 | `q` | 退出 |
 
-## 故障排除
+## 前置条件
 
-### 1. lumen 未安装
+### tmux
 
+启动脚本会自动安装 tmux。如果失败，手动安装：
+
+```bash
+brew install tmux
+# or
+apt install tmux
 ```
-❌ lumen is not installed
+
+### lumen
+
+插件会自动安装 lumen。如果失败，手动安装：
+
+```bash
+brew install jnsahaj/lumen/lumen
+# or
+cargo install lumen
 ```
 
-**解决方案**: 手动安装 lumen（见上方前置条件）
+## 故障排除
 
-### 2. 没有修改的文件
+### 1. 没有修改的文件
 
 ```
 📝 No modified files
 ```
 
 **解决方案**: 确保文件已修改并暂存：
+
 ```bash
 git add .
 ```
 
-### 3. 新终端未打开
-
-检查终端模拟器是否支持：
-- macOS: Terminal.app
-- Linux: gnome-terminal 或 xterm
+### 2. 插件未加载
 
-### 4. 插件未加载
+检查配置：
 
-检查全局配置文件是否正确：
 ```bash
 cat ~/.config/opencode/opencode.json
 ```
 
-确保配置正确：
-```json
-{
-  "command": {
-    "diff": {
-      "template": "View git diff using lumen TUI.",
-      "description": "View diff of modified files using lumen TUI"
-    }
-  },
-  "plugin": ["opencode-diff-viewer"]
-}
+### 3. tmux 会话丢失
+
+重新运行启动脚本：
+
+```bash
+opencode-diff-viewer
 ```
 
 ## 工作原理
 
-1. **检测修改文件** - 插件使用 `git diff` 获取已暂存和未暂存的修改
-2. **启动 lumen** - 在新终端窗口中运行 `lumen diff --file <files>`
-3. **自动安装** - 插件启动时检查 lumen，未安装则自动安装
+1. **启动脚本** - 用 tmux new-session 启动 OpenCode
+2. **插件加载** - 在 OpenCode 启动时自动加载
+3. **自动安装依赖** - 检查并安装 tmux 和 lumen
+4. **执行 /diff** - 创建新的 tmux 会话 "opencode-diff-viewer"
+5. **运行 lumen** - 在 tmux 会话中显示 diff
 
 ## 项目结构
 
 ```
 opencode-diff-viewer/
+├── start-opencode.sh      # 启动脚本
 ├── src/
 │   ├── index.ts           # 插件主逻辑
 │   └── command-diff.md    # /diff 命令定义
@@ -184,18 +186,11 @@ cd opencode-diff-viewer
 
 # 安装依赖
 npm install
-# 或
-pnpm install
-# 或
-bun install
 
 # 构建
 npm run build
 
 # 链接本地包
-npm link
-
-# 在全局使用
 npm link -g opencode-diff-viewer
 ```
 
@@ -213,6 +208,7 @@ npm publish
 
 ## 依赖
 
+- [tmux](https://github.com/tmux/tmux) - 终端复用器
 - [lumen](https://github.com/jnsahaj/lumen) - TUI Diff 查看器
 - [@opencode-ai/plugin](https://www.npmjs.com/package/@opencode-ai/plugin) - OpenCode 插件 SDK
 

package/dist/index.js

@@ -9,6 +9,15 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
             return false;
         }
     };
+    const isTmuxInstalled = async () => {
+        try {
+            await $ `which tmux`;
+            return true;
+        }
+        catch {
+            return false;
+        }
+    };
     const isBrewInstalled = async () => {
         try {
             await $ `which brew`;
@@ -51,6 +60,21 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
             error: "Neither brew nor cargo available. Please install lumen manually:\n  brew install jnsahaj/lumen/lumen\n  # or\n  cargo install lumen"
         };
     };
+    const installTmux = async () => {
+        if (await isBrewInstalled()) {
+            try {
+                await $ `brew install tmux`;
+                return { success: true, method: "brew" };
+            }
+            catch (e) {
+                console.warn(`brew install tmux failed: ${e}`);
+            }
+        }
+        return {
+            success: false,
+            error: "Please install tmux manually:\n  brew install tmux\n  # or\n  apt install tmux"
+        };
+    };
     const ensureLumenInstalled = async () => {
         if (await isLumenInstalled()) {
             return { installed: true };
@@ -61,7 +85,25 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
         }
         return { installed: false, message: `❌ ${result.error}` };
     };
-    await ensureLumenInstalled();
+    const ensureTmuxInstalled = async () => {
+        if (await isTmuxInstalled()) {
+            return { installed: true };
+        }
+        const result = await installTmux();
+        if (result.success) {
+            return { installed: true, message: `✅ tmux installed via ${result.method}` };
+        }
+        return { installed: false, message: `❌ ${result.error}` };
+    };
+    // Check and install dependencies on startup
+    const tmuxCheck = await ensureTmuxInstalled();
+    if (!tmuxCheck.installed) {
+        console.warn(tmuxCheck.message);
+    }
+    const lumenCheck = await ensureLumenInstalled();
+    if (!lumenCheck.installed) {
+        console.warn(lumenCheck.message);
+    }
     const getModifiedFiles = async () => {
         try {
             const unstaged = await $ `git diff --name-only`.text();
@@ -77,6 +119,18 @@ export const DiffViewerPlugin = async ({ project, client, $, directory, worktree
         }
     };
     const launchDiffViewer = async (files) => {
+        // Check tmux
+        if (!await isTmuxInstalled()) {
+            return `❌ tmux is not installed.
+
+To install:
+  brew install tmux
+  # or
+  apt install tmux
+
+Then restart OpenCode.`;
+        }
+        // Check lumen
         if (!await isLumenInstalled()) {
             return `❌ lumen is not installed.
 
@@ -93,40 +147,27 @@ Then restart OpenCode.`;
         }
         const fileList = modifiedFiles.map(f => `  • ${f}`).join('\n');
         const fileArgs = modifiedFiles.map(f => `"${f}"`).join(' ');
+        const sessionName = "opencode-diff-viewer";
         const cmd = `cd "${directory}" && lumen diff ${fileArgs}`;
-        const platform = process.platform;
-        // Try to launch in new terminal
-        let launched = false;
-        let errorMsg = "";
         try {
-            if (platform === 'darwin') {
-                await $ `osascript -e 'tell application "Terminal" to do script "${cmd}; exit"'`;
-                launched = true;
-            }
-            else if (platform === 'linux') {
-                try {
-                    await $ `which gnome-terminal && gnome-terminal -- bash -c "${cmd}; read -p 'Press Enter to close...'" `;
-                    launched = true;
-                }
-                catch {
-                    try {
-                        await $ `which xterm && xterm -e "bash -c '${cmd}; read -p Press Enter to close...'" `;
-                        launched = true;
-                    }
-                    catch (e) {
-                        errorMsg = "No terminal emulator found (gnome-terminal/xterm)";
-                    }
-                }
-            }
+            // Kill existing session if it exists
+            await $ `tmux kill-session -t "${sessionName}" 2>/dev/null || true`;
+            // Create new tmux session
+            await $ `tmux new-session -d -s "${sessionName}" "${cmd}"`;
+            return `✅ Opened lumen in tmux session "${sessionName}":\n${fileList}\n\nTo use lumen:
+  1. Run: tmux attach -t "${sessionName}"
+  2. Navigate: j/k or arrows, {/} for hunks
+  3. Detach: Ctrl+B then D
+
+Keybindings:
+  j/k or ↑/↓: Navigate    {/}: Jump hunks
+  tab: Sidebar           e: Edit file
+  q: Quit`;
         }
         catch (e) {
-            errorMsg = e.message || "Unknown error";
-        }
-        if (launched) {
-            return `✅ Opened lumen diff viewer:\n${fileList}\n\nKeybindings:\n  j/k: Navigate  {/}: Jump hunks  tab: Sidebar  e: Edit  q: Quit`;
+            return `❌ Failed to launch tmux session: ${e.message || e}\n\nTry manually:
+  tmux new-session -s "${sessionName}" "${cmd}"`;
         }
-        // If we couldn't launch, show manual instructions
-        return `📺 Could not open terminal automatically.\n\nTo view diffs in lumen:\n1. Open a new terminal\n2. Run:\n   ${cmd}\n\nModified files:\n${fileList}`;
     };
     return {
         "tui.command.execute": async (input, output) => {
@@ -141,7 +182,7 @@ Then restart OpenCode.`;
         },
         tool: {
             view_diff: tool({
-                description: "Open the lumen diff viewer to show git diff for modified files.",
+                description: "Open the lumen diff viewer in a tmux session.",
                 args: {
                     file: tool.schema.string().optional().describe("Optional: specific file path"),
                 },

package/package.json

@@ -1,21 +1,24 @@
 {
   "name": "opencode-diff-viewer",
-  "version": "1.0.7",
-  "description": "OpenCode plugin for viewing git diffs using lumen TUI",
+  "version": "1.0.9",
+  "description": "OpenCode plugin for viewing git diffs using lumen TUI with tmux",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist/",
-    "command-diff.md"
+    "command-diff.md",
+    "start-opencode.sh"
   ],
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "start": "./start-opencode.sh"
   },
   "keywords": [
     "opencode",
     "opencode-plugin",
     "diff",
     "lumen",
+    "tmux",
     "git"
   ],
   "author": "AarynLu",

package/start-opencode.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+# OpenCode Diff Viewer - 启动脚本
+# 自动在 tmux 中启动 OpenCode
+
+set -e
+
+SESSION_NAME="opencode"
+
+# 检查 tmux 是否安装
+if ! command -v tmux &> /dev/null; then
+    echo "❌ tmux 未安装，正在安装..."
+    if command -v brew &> /dev/null; then
+        brew install tmux
+    else
+        echo "❌ 请先安装 tmux: brew install tmux"
+        exit 1
+    fi
+fi
+
+# 检查 OpenCode 是否安装
+if ! command -v opencode &> /dev/null; then
+    echo "❌ OpenCode 未安装"
+    exit 1
+fi
+
+# 检查是否有正在运行的 OpenCode 会话
+if tmux has-session -t "$SESSION_NAME" 2>/dev/null; then
+    echo "📎 已存在 OpenCode 会话，正在附加..."
+    tmux attach-session -t "$SESSION_NAME"
+else
+    echo "🚀 在 tmux 中启动 OpenCode..."
+    tmux new-session -d -s "$SESSION_NAME" "opencode"
+    echo "✅ OpenCode 已在 tmux 会话 '${SESSION_NAME}' 中启动"
+    echo ""
+    echo "下一步:"
+    echo "  1. 运行: tmux attach -t ${SESSION_NAME}"
+    echo "  2. 在 OpenCode 中使用 /diff 命令查看代码变更"
+    echo "  3. lumen 会在后台 tmux 会话 'opencode-diff-viewer' 中运行"
+    echo ""
+    echo "tmux 快捷键:"
+    echo "  Ctrl+B 然后 D - 分离会话"
+    echo "  Ctrl+B 然后 ? - 查看帮助"
+    echo ""
+    tmux attach-session -t "$SESSION_NAME"
+fi