opencode-feishu

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

opencode-feishu

★ 11 Open GitHub ↗

OpenCode 飞书插件 — 通过飞书消息给 OpenCode 布置任务，支持图片、会话管理、模型切换

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# opencode-feishu

[OpenCode](https://github.com/nicepkg/opencode) 飞书插件 — 通过飞书消息给 OpenCode 布置任务，任务完成后自动总结并回复结果。

使用飞书 WebSocket 长连接，**无需公网 IP、无需内网穿透**。

## 功能

- 📱 通过飞书私聊/群聊向 OpenCode 发送任务
- 📊 任务完成后自动发送结果卡片（包含文件变更统计）
- 🖼️ **图片支持** — 直接发送图片或图文混合消息，AI 可分析图片内容
- 🔄 **会话复用** — 连续消息自动在同一 session 中执行，`/new` 才创建新会话
- 🤖 **模型切换** — `/model` 查看和切换 OpenCode 使用的模型
- 📋 **会话管理** — `/sessions` 查看历史会话，`/session <ID>` 切换会话
- 📁 支持 `/dir` 动态切换项目目录
- 🔧 支持所有 OpenCode 原生命令（`/compact` 等）
- 🔔 AI 执行过程中可通过 `feishu_notify` 工具推送进度
- 👥 可配置用户白名单

## 安装

安装依赖：

```bash
npm install opencode-feishu
```

### 配置方式一：环境变量（推荐）

在 shell 配置文件（如 `~/.zshrc`）中添加：

```bash
export FEISHU_PLUGIN_APP_ID="cli_xxxxxxxxxx"
export FEISHU_PLUGIN_APP_SECRET="xxxxxxxxxxxxxxxxxx"
```

然后在 `opencode.json` 中只需添加插件：

```json
{
  "plugin": ["opencode-feishu"]
}
```

### 配置方式二：opencode.json

在 `opencode.json` 中添加插件和配置：

```json
{
  "plugin": ["opencode-feishu"],
  "feishu": {
    "appId": "cli_xxxxxxxxxx",
    "appSecret": "xxxxxxxxxxxxxxxxxx"
  }
}
```

> ⚠️ 注意：`opencode.json` 可能会被纳入版本控制，建议使用环境变量方式避免泄露密钥。

## 飞书应用创建

1. 打开 [飞书开放平台](https://open.feishu.cn/app)，创建企业自建应用
2. 进入 **机器人** 页面，启用机器人能力
3. 获取 App ID 和 App Secret 配置到环境变量
4. 进入应用的 **事件订阅** 页面：
   - 请求方式选择 **使用长连接接收事件**（WebSocket 模式）
5. 添加事件订阅：
   - `im.message.receive_v1` — 接收消息
6. 进入 **权限管理**，批量处理 - 批量导入权限：
   ```json
   {
     "scopes": {
       "tenant": [
         "cardkit:card:read",
         "cardkit:card:write",
         "cardkit:template:read",
         "im:message",
         "im:message.p2p_msg:readonly",
         "im:message:send_as_bot",
         "im:resource"
       ],
       "user": []
     }
   }
   ```
   > 💡 批量导入后如需手动添加，权限列表如下（卡片权限 `cardkit:*` 用于发送任务结果卡片，不可或缺）：
   > - `cardkit:card:read` — 读取卡片
   > - `cardkit:card:write` — 发送/更新卡片
   > - `cardkit:template:read` — 读取卡片模板
   > - `im:message` — 获取与发送消息
   > - `im:message:send_as_bot` — 以应用身份发消息
   > - `im:resource` — 读取消息中的资源（图片下载需要）
   > - `im:message.p2p_msg:readonly` — 读取用户发给机器人的单聊消息
7. 发布应用版本，等待管理员审批

## 完整配置参考

| 字段 | 环境变量 | 类型 | 必填 | 说明 |
|------|---------|------|------|------|
| `appId` | `FEISHU_PLUGIN_APP_ID` | string | ✅ | 飞书应用 App ID |
| `appSecret` | `FEISHU_PLUGIN_APP_SECRET` | string | ✅ | 飞书应用 App Secret |
| `domain` | `FEISHU_PLUGIN_DOMAIN` | string | | `"feishu"`（国内，默认）/ `"lark"`（国际）/ 自定义域名 |
| `defaultDirectory` | `FEISHU_PLUGIN_DEFAULT_DIR` | string | | 默认工作目录，不设则使用 opencode 当前目录 |
| `allowedUsers` | `FEISHU_PLUGIN_ALLOWED_USERS` | string[] | | 允许使用的用户 open_id 列表（环境变量用逗号分隔），空 = 所有人可用 |
| `connectionMode` | `FEISHU_PLUGIN_CONN_MODE` | string | | `"websocket"`（默认，推荐）/ `"webhook"`（暂未实现） |

## 使用方式

在飞书中向机器人发送消息：

| 消息 | 说明 |
|------|------|
| 任意文本 | 作为任务 prompt 发送给 OpenCode 执行 |
| 发送图片 | 图片会被下载并传给 AI 分析 |
| 图文混合（富文本） | 同时提取文字和图片发送 |
| `/new` | 清除当前会话，下次消息创建新会话 |
| `/model` | 查看所有可用模型和当前模型 |
| `/model <provider/model>` | 切换模型（如 `/model anthropic/claude-sonnet-4-20250514`） |
| `/sessions` | 查看最近的会话列表 |
| `/session <ID>` | 切换到指定会话（支持 ID 前缀匹配） |
| `/dir <路径>` | 切换工作目录 |
| `/dir` | 查看当前工作目录 |
| `/status` | 查看进行中的任务 |
| `/abort` | 中止当前任务 |
| `/help` | 显示帮助 |
| `/compact` 等 | 透传给 OpenCode 的原生命令 |

### 会话复用

连续发送的消息会自动在**同一 session** 中执行，不会每次创建新会话。只有以下情况会创建新会话：

- 首次发送消息（无活跃会话）
- 使用 `/new` 命令清除当前会话后
- 使用 `/session <ID>` 切换到其他会话

## 工作原理

```
飞书用户 → 飞书消息 → [WebSocket 长连接] → opencode-feishu 插件
                                                   ↓
                                        解析消息（文本/图片/富文本）
                                        下载图片资源（如有）
                                                   ↓
                                        复用或创建 OpenCode Session
                                        发送 prompt（含 FilePartInput）
                                                   ↓
                                        OpenCode 执行任务...
                                                   ↓
                                        session.idle 事件触发
                                                   ↓
                                        收集结果 + 文件变更
                                                   ↓
飞书用户 ← 结果卡片 ← [REST API] ← opencode-feishu 插件
```

## 开发

```bash
# 安装依赖
npm install

# 类型检查
npm run typecheck

# 构建
npm run build

# 清理
npm run clean
```

opencode-feishu

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README