@wu529778790/open-im 0.3.12 → 1.0.0

package/README.md

@@ -1,121 +1,115 @@
 # open-im
 
-> 🚀 把你的 AI 助手装进口袋里 - 在 Telegram 随时随地使用 Claude Code
+多平台 IM 桥接，将 Telegram 和飞书 (Feishu/Lark) 连接到 AI CLI 工具（Claude Code、Codex、Cursor），实现移动端/远程访问 AI 编程助手。
 
-还在受限于终端吗？用手机也能 Coding 了！
+## 功能特性
 
-open-im 是一个轻量级的 IM 桥接工具，让你通过 Telegram 就能使用 Claude Code、Codex、Cursor 等 AI CLI 工具。无论是在咖啡厅、地铁上，还是躺在床上，你的 AI 助手随时在线。
+- **多平台**：支持 Telegram 和飞书，可同时启用
+- **多 AI 工具**：通过配置切换 Claude Code / Codex / Cursor
+- **流式输出**：节流更新，实时展示 AI 回复
+- **会话管理**：每用户独立 session，`/new` 重置会话
+- **命令支持**：`/help` `/new` `/cd` `/pwd` `/status` `/allow` `/deny`
 
-## ✨ 为什么选择 open-im
-
-- **📱 移动友好** - 告别终端，用手机照样写代码
-- **⚡ 实时流式输出** - AI 思考过程实时可见，像在终端一样流畅
-- **🔒 安全可控** - 支持白名单，只有你能用
-- **🔄 独立会话** - 每个人独立 session，互不干扰
-- **🛠️ 多 AI 支持** - Claude / Codex / Cursor 随意切换
+## 环境要求
 
-## 🚀 快速开始
+- **Node.js** >= 20
+- **AI CLI**：已安装 Claude Code CLI（或 Codex/Cursor）并加入 PATH
 
-### 方式一：npx（无需安装）
+## 安装
 
 ```bash
-npx @wu529778790/open-im run
+npm install @wu529778790/open-im -g
 ```
 
-### 方式二：全局安装（推荐常用用户）
+## ✨ 为什么选择 open-im
 
 ```bash
-npm i @wu529778790/open-im -g
-open-im run
+# 使用 npx 快速体验（无需全局安装）
+npx @wu529778790/open-im start    # 后台运行
+npx @wu529778790/open-im stop     # 停止后台进程
+npx @wu529778790/open-im dev     # 前台运行（调试），Ctrl+C 停止
 ```
 
-首次运行会引导你完成配置，30 秒即可搞定。
-
-如果配置引导未出现，可以手动运行：
+或全局安装后直接使用：
 
 ```bash
-npx @wu529778790/open-im init
+npm install @wu529778790/open-im -g
+open-im start
 ```
 
-## ⚙️ 配置说明
+首次运行会进入交互式配置向导，按提示输入 Token 后自动启动。配置保存到 `~/.open-im/config.json`。
 
-配置文件位置：`~/.open-im/config.json`
-
-配置文件示例：
-
-```json
-{
-  "telegramBotToken": "你的Bot Token（从 @BotFather 获取）",
-  "allowedUserIds": ["你的Telegram用户ID"],
-  "claudeWorkDir": "/path/to/your/work/dir",
-  "claudeSkipPermissions": true,
-  "aiCommand": "claude"
-}
-```
+## 运行方式
 
-获取 Telegram Bot Token：
-1. 在 Telegram 中搜索 @BotFather
-2. 发送 `/newbot` 创建新机器人
-3. 按提示设置机器人名称
-4. BotFather 会返回 Token，格式如：`123456789:ABCdefGHIjklMNOpqrsTUVwxyz`
+| 命令 | 说明 |
+|------|------|
+| `open-im start` | 后台运行，适合长期使用 |
+| `open-im stop` | 停止后台进程 |
+| `open-im dev` 或 `open-im` | 前台运行（调试），Ctrl+C 停止 |
 
-获取 Telegram 用户 ID（可选）：
-1. 在 Telegram 中搜索 @userinfobot
-2. 发送任意消息
-3. 机器人会返回你的用户 ID
-4. 如不设置，则所有人都可以使用你的机器人
+## 会话说明
 
-**或者通过环境变量配置：**
+**会话上下文存储在本地**（`~/.open-im/data/sessions.json`），与 IM 聊天记录无关。每用户在本地维护独立的 session 和 Claude 会话 ID，`/new` 可重置当前会话。
 
 ```bash
-export TELEGRAM_BOT_TOKEN="你的Bot Token"
-export ALLOWED_USER_IDS="用户ID1,用户ID2"
+npm i @wu529778790/open-im -g
 open-im run
 ```
 
-## 📖 常用命令
+### 环境变量
 
-| 命令 | 说明 |
+| 变量 | 说明 |
 |------|------|
-| `open-im` / `open-im run` | 前台运行（首次使用会引导配置） |
-| `open-im init` | 初始化配置（首次使用或重新配置） |
-| `open-im start` | 后台启动服务 |
-| `open-im stop` | 停止服务 |
-| `open-im restart` | 重启服务 |
-
-### Telegram 机器人命令
+| `TELEGRAM_BOT_TOKEN` | Telegram Bot Token（从 @BotFather 获取） |
+| `FEISHU_APP_ID` | 飞书应用 App ID |
+| `FEISHU_APP_SECRET` | 飞书应用 App Secret |
+| `ALLOWED_USER_IDS` | 白名单用户 ID（逗号分隔，空=所有人） |
+| `AI_COMMAND` | `claude` \| `codex` \| `cursor`，默认 `claude` |
+| `CLAUDE_CLI_PATH` | Claude CLI 路径，默认 `claude` |
+| `CLAUDE_WORK_DIR` | 工作目录 |
+| `CLAUDE_SKIP_PERMISSIONS` | 跳过权限确认，默认 `true` |
+| `CLAUDE_TIMEOUT_MS` | Claude 超时（毫秒），默认 600000 |
+| `CLAUDE_MODEL` | Claude 模型（可选） |
+| `ALLOWED_BASE_DIRS` | 允许访问的目录（逗号分隔） |
+| `LOG_DIR` | 日志目录，默认 `~/.open-im/logs` |
+| `LOG_LEVEL` | 日志级别：INFO/DEBUG/WARN/ERROR |
 
-| 命令 | 功能 |
-|------|------|
-| `/help` | 查看帮助 |
-| `/new` | 开启新会话 |
-| `/cd <路径>` | 切换工作目录 |
-| `/pwd` | 查看当前目录 |
-| `/status` | 查看运行状态 |
+### 配置文件
 
-## 💡 使用场景
+配置优先级：环境变量 > `~/.open-im/config.json` > 默认值。
 
-- 🚇 **通勤路上** - 用手机处理简单的代码问题
-- ☕ **咖啡厅** - 没带电脑也能快速调试
-- 🛋️ **沙发模式** - 躺着看 AI 帮你写代码
-- 🌙 **紧急修复** - 半夜收到报警，手机直接处理
+至少需配置 **Telegram** 或 **飞书** 其一：
 
-## 📦 安装方式
+- **Telegram**：`TELEGRAM_BOT_TOKEN` 或 `telegramBotToken`
+- **飞书**：`FEISHU_APP_ID` + `FEISHU_APP_SECRET` 或 `feishuAppId` + `feishuAppSecret`
 
-```bash
-# npx（无需安装）
-npx @wu529778790/open-im run
+### 飞书配置说明
 
-# npm 全局安装
-npm i @wu529778790/open-im -g
+1. 在 [飞书开放平台](https://open.feishu.cn/) 创建企业自建应用
+2. 开启「机器人」能力
+3. 配置事件订阅：启用 `im.message.receive_v1`，使用 **长连接** 模式（WebSocket）
+4. 将机器人添加到目标群聊或发起私聊
 
-# yarn 全局安装
-yarn global add @wu529778790/open-im
+## 开发
 
-# pnpm 全局安装
-pnpm i @wu529778790/open-im -g
+```bash
+npm run build      # 构建
+npm run dev        # 直接运行源码（tsx，无需 build）
+npm run foreground # 前台运行已构建版本
 ```
 
+## IM 内命令
+
+| 命令 | 说明 |
+|------|------|
+| `/help` | 显示帮助 |
+| `/new` | 开始新会话 |
+| `/status` | 显示状态（AI 工具、工作目录、费用等） |
+| `/cd <路径>` | 切换工作目录 |
+| `/pwd` | 显示当前工作目录 |
+| `/allow` `/y` | 允许权限请求 |
+| `/deny` `/n` | 拒绝权限请求 |
+
 ## 📝 License
 
 [MIT](LICENSE)
@@ -127,22 +121,30 @@ pnpm i @wu529778790/open-im -g
 如果配置引导没有出现，尝试以下方法：
 
 1. **手动运行配置命令：**
+
    ```bash
    npx @wu529778790/open-im init
    ```
 
 2. **检查是否已有配置文件：**
+
    ```bash
    cat ~/.open-im/config.json
    ```
 
 3. **手动创建配置文件：**
+
    ```bash
    mkdir -p ~/.open-im
    cat > ~/.open-im/config.json << 'EOF'
    {
      "telegramBotToken": "你的Bot Token",
      "allowedUserIds": ["你的Telegram用户ID"],
+     "platforms": {
+       "telegram": {
+         "proxy": "http://127.0.0.1:7890"
+       }
+     },
      "claudeWorkDir": "$(pwd)",
      "claudeSkipPermissions": true,
      "aiCommand": "claude"
@@ -175,3 +177,40 @@ npx @wu529778790/open-im run
 1. 在 Telegram 中搜索 @userinfobot
 2. 点击"START"或发送任意消息
 3. 机器人会返回你的用户 ID（数字）
+
+### Q: 如何配置代理？
+
+如果你的网络环境无法直接访问 Telegram，需要在配置文件中添加代理设置：
+
+```json
+{
+  "platforms": {
+    "telegram": {
+      "proxy": "http://127.0.0.1:7890"
+    }
+  }
+}
+```
+
+支持的代理格式：
+
+- HTTP：`http://127.0.0.1:7890`
+- HTTPS：`https://127.0.0.1:7890`
+- SOCKS5：`socks5://127.0.0.1:1080`
+
+注意：代理仅用于访问 Telegram API，不影响 AI 工具的网络请求。
+
+### Q: Telegram 机器人无响应？
+
+可能原因及解决方法：
+
+1. **网络问题 - Telegram 被阻断**
+   - 配置代理（见上方"如何配置代理"）
+   - 测试代理是否可用：`curl -x http://127.0.0.1:7890 https://api.telegram.org`
+
+2. **Token 错误**
+   - 重新获取 Token：在 @BotFather 中使用 `/revoke` 命令
+
+3. **用户 ID 白名单问题**
+   - 检查配置文件中的 `allowedUserIds` 是否包含你的用户 ID
+   - 或留空允许所有人访问（仅开发环境建议）

package/dist/access/access-control.js

@@ -1,11 +1,18 @@
+import { createLogger } from '../logger.js';
+const log = createLogger('AccessControl');
 export class AccessControl {
     allowedUserIds;
     constructor(allowedUserIds) {
         this.allowedUserIds = new Set(allowedUserIds);
+        log.info(`AccessControl initialized with ${allowedUserIds.length} allowed users:`, allowedUserIds);
     }
     isAllowed(userId) {
-        if (this.allowedUserIds.size === 0)
+        if (this.allowedUserIds.size === 0) {
+            log.debug(`Allowing user ${userId} (no whitelist configured)`);
             return true;
-        return this.allowedUserIds.has(userId);
+        }
+        const allowed = this.allowedUserIds.has(userId);
+        log.info(`Checking user ${userId}: ${allowed ? 'ALLOWED' : 'DENIED'}`);
+        return allowed;
     }
 }

package/dist/claude/cli-runner.js

@@ -1,20 +1,29 @@
-import { spawn } from 'node:child_process';
-import { createInterface } from 'node:readline';
-import { parseStreamLine, extractTextDelta, extractThinkingDelta, extractResult } from './stream-parser.js';
-import { isStreamInit, isContentBlockStart, isContentBlockDelta, isContentBlockStop } from './types.js';
-import { createLogger } from '../logger.js';
-const log = createLogger('CliRunner');
+import { spawn } from "node:child_process";
+import { createInterface } from "node:readline";
+import { parseStreamLine, extractTextDelta, extractThinkingDelta, extractResult, } from "./stream-parser.js";
+import { isStreamInit, isContentBlockStart, isContentBlockDelta, isContentBlockStop, } from "./types.js";
+import { createLogger } from "../logger.js";
+const log = createLogger("CliRunner");
 export function runClaude(cliPath, prompt, sessionId, workDir, callbacks, options) {
-    const args = ['-p', '--output-format', 'stream-json', '--verbose', '--include-partial-messages'];
+    const args = [
+        "-p",
+        "--output-format",
+        "stream-json",
+        "--verbose",
+        "--include-partial-messages",
+    ];
     if (options?.skipPermissions)
-        args.push('--dangerously-skip-permissions');
+        args.push("--dangerously-skip-permissions");
     if (options?.model)
-        args.push('--model', options.model);
+        args.push("--model", options.model);
     if (sessionId)
-        args.push('--resume', sessionId);
-    args.push('--', prompt);
+        args.push("--resume", sessionId);
+    args.push("--", prompt);
     const env = {};
     for (const [k, v] of Object.entries(process.env)) {
+        // Skip CLAUDECODE to prevent nested session detection
+        if (k === "CLAUDECODE")
+            continue;
         if (v !== undefined)
             env[k] = v;
     }
@@ -22,29 +31,67 @@ export function runClaude(cliPath, prompt, sessionId, workDir, callbacks, option
         env.CC_IM_CHAT_ID = options.chatId;
     if (options?.hookPort)
         env.CC_IM_HOOK_PORT = String(options.hookPort);
-    const child = spawn(cliPath, args, { cwd: workDir, stdio: ['ignore', 'pipe', 'pipe'], env, windowsHide: true });
-    log.debug(`Claude CLI spawned: pid=${child.pid}, cwd=${workDir}, session=${sessionId ?? 'new'}`);
-    let accumulated = '';
-    let accumulatedThinking = '';
+    // Try different spawn strategies based on platform
+    log.info(`Spawning CLI: path=${cliPath}, platform=${process.platform}`);
+    let child;
+    if (process.platform === "win32") {
+        // Check if running in Git Bash (MINGW) or MSYS
+        const isGitBash = process.env.MSYSTEM ||
+            process.env.MINGW_PREFIX ||
+            process.env.SHELL?.includes("bash");
+        log.info(`Detected environment: Git Bash=${isGitBash ? "yes" : "no"}`);
+        if (isGitBash) {
+            // In Git Bash, use shell for proper path resolution
+            log.info(`Using shell spawn for Git Bash environment`);
+            child = spawn(cliPath, args, {
+                cwd: workDir,
+                stdio: ["ignore", "pipe", "pipe"],
+                env,
+                shell: true,
+            });
+        }
+        else {
+            // In pure cmd/PowerShell, direct spawn works best
+            log.info(`Using direct spawn for Windows cmd/PowerShell`);
+            child = spawn(cliPath, args, {
+                cwd: workDir,
+                stdio: ["ignore", "pipe", "pipe"],
+                env,
+                windowsHide: true,
+            });
+        }
+    }
+    else {
+        child = spawn(cliPath, args, {
+            cwd: workDir,
+            stdio: ["ignore", "pipe", "pipe"],
+            env,
+        });
+    }
+    log.info(`Claude CLI: pid=${child.pid}, cwd=${workDir}, session=${sessionId ?? "new"}`);
+    let accumulated = "";
+    let accumulatedThinking = "";
     let completed = false;
-    let model = '';
+    let model = "";
     const toolStats = {};
     const pendingToolInputs = new Map();
     const MAX_TIMEOUT = 2_147_483_647;
-    const timeoutMs = options?.timeoutMs && options.timeoutMs > 0 ? Math.min(options.timeoutMs, MAX_TIMEOUT) : 0;
+    const timeoutMs = options?.timeoutMs && options.timeoutMs > 0
+        ? Math.min(options.timeoutMs, MAX_TIMEOUT)
+        : 0;
     let timeoutHandle = null;
     if (timeoutMs > 0) {
         timeoutHandle = setTimeout(() => {
             if (!completed && !child.killed) {
                 completed = true;
                 log.warn(`Claude CLI timeout after ${timeoutMs}ms, killing pid=${child.pid}`);
-                child.kill('SIGTERM');
+                child.kill("SIGTERM");
                 callbacks.onError(`执行超时（${timeoutMs}ms），已终止进程`);
             }
         }, timeoutMs);
     }
     const rl = createInterface({ input: child.stdout });
-    rl.on('line', (line) => {
+    rl.on("line", (line) => {
         const event = parseStreamLine(line);
         if (!event)
             return;
@@ -64,16 +111,18 @@ export function runClaude(cliPath, prompt, sessionId, workDir, callbacks, option
             callbacks.onThinking?.(accumulatedThinking);
             return;
         }
-        if (isContentBlockStart(event) && event.event.content_block?.type === 'tool_use') {
+        if (isContentBlockStart(event) &&
+            event.event.content_block?.type === "tool_use") {
             const name = event.event.content_block.name;
             if (name)
-                pendingToolInputs.set(event.event.index, { name, json: '' });
+                pendingToolInputs.set(event.event.index, { name, json: "" });
             return;
         }
-        if (isContentBlockDelta(event) && event.event.delta?.type === 'input_json_delta') {
+        if (isContentBlockDelta(event) &&
+            event.event.delta?.type === "input_json_delta") {
             const pending = pendingToolInputs.get(event.event.index);
             if (pending)
-                pending.json += event.event.delta.partial_json ?? '';
+                pending.json += event.event.delta.partial_json ?? "";
             return;
         }
         if (isContentBlockStop(event)) {
@@ -134,17 +183,19 @@ export function runClaude(cliPath, prompt, sessionId, workDir, callbacks, option
             }
         }
     };
-    child.on('close', (code) => {
+    child.on("close", (code) => {
+        log.info(`Claude CLI closed: exitCode=${code}, pid=${child.pid}`);
         exitCode = code;
         childClosed = true;
         finalize();
     });
-    rl.on('close', () => {
+    rl.on("close", () => {
         rlClosed = true;
         finalize();
     });
-    child.on('error', (err) => {
-        log.error(`Claude CLI error: ${err.message}`);
+    child.on("error", (err) => {
+        const errorCode = err.code;
+        log.error(`Claude CLI spawn error: ${err.message}, code=${errorCode}, path=${cliPath}`);
         if (timeoutHandle)
             clearTimeout(timeoutHandle);
         if (!completed) {
@@ -160,7 +211,7 @@ export function runClaude(cliPath, prompt, sessionId, workDir, callbacks, option
                 clearTimeout(timeoutHandle);
             rl.close();
             if (!child.killed)
-                child.kill('SIGTERM');
+                child.kill("SIGTERM");
         },
     };
 }