iflow-feishu 1.0.0 → 1.0.2

package/README.md

@@ -9,41 +9,56 @@
 - **会话管理** - 自动保存上下文历史
 - **模式切换** - 支持 default/yolo/plan/smart 模式
 - **自动搜索** - 检测搜索关键词自动启用网络搜索
+- **交互式配置** - 首次运行自动引导配置
+
+## 安装
+
+```bash
+npm install -g iflow-feishu
+```
 
 ## 快速开始
 
-### 一键启动
+### 方式一：交互式配置（推荐）
+
+直接运行，首次使用会引导你配置飞书凭证：
 
 ```bash
 iflow-feishu
 ```
 
-启动脚本会自动完成以下操作：
-
-1. **检查 iFlow CLI** - 未安装时询问是否安装
-2. **安装插件依赖** - 自动安装 npm 依赖
-3. **安装 PM2** - 自动安装进程管理器
-4. **配置飞书凭证** - 首次使用时引导输入
-5. **启动服务**
+按提示输入飞书机器人的 App ID 和 App Secret 即可。
 
-### 前置要求
-
-- Node.js >= 16.0.0
+### 方式二：环境变量
 
-### 手动配置
+```bash
+export FEISHU_APP_ID="cli_xxxxxxxxxxxx"
+export FEISHU_APP_SECRET="xxxxxxxxxxxxxxxx"
+iflow-feishu
+```
 
-如需手动配置飞书凭证：
+### 方式三：配置文件
 
 ```bash
 mkdir -p ~/.feishu-config
-echo '{
-  "appId": "your-app-id",
-  "appSecret": "your-app-secret"
-}' > ~/.feishu-config/feishu-app.json
+cat > ~/.feishu-config/feishu-app.json << 'EOF'
+{
+  "appId": "cli_xxxxxxxxxxxx",
+  "appSecret": "xxxxxxxxxxxxxxxx"
+}
+EOF
+iflow-feishu
 ```
 
+## 前置要求
+
+- Node.js >= 16.0.0
+- iFlow CLI（可选，用于本地开发）
+
 ## 命令列表
 
+在飞书中给机器人发送以下命令：
+
 | 命令 | 说明 |
 |------|------|
 | `/help` | 显示帮助信息 |
@@ -52,6 +67,44 @@ echo '{
 | `/mode <模式>` | 切换模式 (default/yolo/plan/smart) |
 | `/status` | 查看会话状态 |
 
+## 环境变量
+
+| 变量 | 说明 | 默认值 |
+|------|------|--------|
+| `FEISHU_APP_ID` | 飞书应用 ID | - |
+| `FEISHU_APP_SECRET` | 飞书应用密钥 | - |
+| `PORT` | HTTP 服务端口 | 18080 |
+| `LOG_LEVEL` | 日志级别 (DEBUG/INFO/WARN/ERROR) | INFO |
+
+## 常用操作
+
+```bash
+# 健康检查
+curl http://localhost:18080/health
+
+# 后台运行
+nohup iflow-feishu > iflow-feishu.log 2>&1 &
+
+# 查看日志
+tail -f iflow-feishu.log
+
+# 使用 PM2 管理
+pm2 start iflow-feishu
+pm2 logs iflow-feishu
+pm2 restart iflow-feishu
+pm2 stop iflow-feishu
+```
+
+## 飞书机器人配置
+
+1. 访问 [飞书开放平台](https://open.feishu.cn/)
+2. 创建企业自建应用
+3. 开通机器人能力
+4. 配置事件订阅：
+   - URL: `http://your-server:18080/webhook`
+   - 事件：接收消息
+5. 获取 App ID 和 App Secret
+
 ## 项目结构
 
 ```
@@ -81,67 +134,6 @@ iflow-feishu/
 └── README.md
 ```
 
-## 架构说明
-
-### 模块职责
-
-| 模块 | 职责 |
-|------|------|
-| service.js | 协调各模块，管理服务生命周期 |
-| message-processor.js | 消息解析、上下文构建 |
-| stream-handler.js | 流式响应处理、token 提取 |
-| http-server.js | HTTP 服务，健康检查，事件回调 |
-| websocket-client.js | 飞书 WebSocket 连接 |
-| feishu-client.js | 飞书 API 封装 |
-| iflow-client.js | iFlow CLI 调用封装 |
-| session.js | 会话持久化存储 |
-| card-builder.js | 飞书卡片构建 |
-| commands.js | 命令处理逻辑 |
-
-### 数据流
-
-```
-飞书消息 -> WebSocket -> service.handleMessageEvent()
-    -> messageProcessor.parseMessage()
-    -> commandHandler.handle() 或 processMessage()
-    -> iflowClient.execute() (流式)
-    -> streamHandler.extractResponse()
-    -> feishuClient.updateCardMessage()
-```
-
-## 配置选项
-
-| 选项 | 说明 | 默认值 |
-|------|------|--------|
-| `feishu.appId` | 飞书应用 ID | - |
-| `feishu.appSecret` | 飞书应用密钥 | - |
-| `server.port` | HTTP 服务端口 | 18080 |
-| `sessions.maxHistory` | 最大历史消息数 | 15 |
-| `iflow.timeout` | CLI 超时时间(ms) | 300000 |
-
-## 环境变量
-
-| 变量 | 说明 |
-|------|------|
-| `PORT` | 服务端口 |
-| `LOG_LEVEL` | 日志级别 (DEBUG/INFO/WARN/ERROR) |
-
-## 常用操作
-
-```bash
-# 查看服务状态
-pm2 status iflow-feishu
-
-# 查看日志
-pm2 logs iflow-feishu
-
-# 重启服务
-pm2 restart iflow-feishu
-
-# 健康检查
-curl http://localhost:18080/health
-```
-
 ## 许可证
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iflow-feishu",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "iFlow CLI 飞书插件 - 将 iFlow AI 助手接入飞书机器人",
   "main": "src/index.js",
   "bin": {

package/src/config/config.js

@@ -1,23 +1,38 @@
 /**
  * 配置管理模块
  * 
- * 负责加载和验证配置
+ * 负责加载和验证配置，支持交互式配置向导
  */
 
 const fs = require('fs');
 const path = require('path');
+const readline = require('readline');
 const { DEFAULT_MODEL, DEFAULT_MAX_TOKENS, MODEL_MAX_TOKENS } = require('../core/constants');
 
+const CONFIG_DIR = path.join(process.env.HOME, '.feishu-config');
+const CONFIG_PATH = path.join(CONFIG_DIR, 'feishu-app.json');
+
+// 获取版本号
+function getVersion() {
+  try {
+    const pkgPath = path.join(__dirname, '..', '..', 'package.json');
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+    return pkg.version || '1.0.0';
+  } catch {
+    return '1.0.0';
+  }
+}
+
+const VERSION = getVersion();
+
 /**
  * 加载飞书配置
  * @returns {Object|null}
  */
 function loadFeishuConfig() {
-  const configPath = path.join(process.env.HOME, '.feishu-config', 'feishu-app.json');
-  
   try {
-    if (fs.existsSync(configPath)) {
-      const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+    if (fs.existsSync(CONFIG_PATH)) {
+      const config = JSON.parse(fs.readFileSync(CONFIG_PATH, 'utf8'));
       return {
         appId: config.appId || config.app_id,
         appSecret: config.appSecret || config.app_secret
@@ -30,6 +45,61 @@ function loadFeishuConfig() {
   return null;
 }
 
+/**
+ * 保存飞书配置
+ * @param {string} appId 
+ * @param {string} appSecret 
+ */
+function saveFeishuConfig(appId, appSecret) {
+  if (!fs.existsSync(CONFIG_DIR)) {
+    fs.mkdirSync(CONFIG_DIR, { recursive: true });
+  }
+  
+  const config = { appId, appSecret };
+  fs.writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2));
+  console.log(`\n✅ 配置已保存到: ${CONFIG_PATH}\n`);
+}
+
+/**
+ * 配置向导 - 交互式创建配置
+ */
+async function setupWizard() {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+
+  const question = (prompt) => new Promise((resolve) => {
+    rl.question(prompt, resolve);
+  });
+
+  console.log('\n╔══════════════════════════════════════╗');
+  console.log('║     iFlow Feishu 配置向导            ║');
+  console.log('╚══════════════════════════════════════╝\n');
+  console.log('请输入飞书机器人凭证（从飞书开放平台获取）:');
+  console.log('文档: https://open.feishu.cn/document/home/introduction-to-feishu-open-platform\n');
+
+  const appId = await question('📱 App ID: ');
+  if (!appId || appId.trim() === '') {
+    console.error('\n❌ App ID 不能为空');
+    rl.close();
+    process.exit(1);
+  }
+
+  const appSecret = await question('🔐 App Secret: ');
+  if (!appSecret || appSecret.trim() === '') {
+    console.error('\n❌ App Secret 不能为空');
+    rl.close();
+    process.exit(1);
+  }
+
+  rl.close();
+
+  saveFeishuConfig(appId.trim(), appSecret.trim());
+  
+  return { appId: appId.trim(), appSecret: appSecret.trim() };
+}
+
 /**
  * 验证配置
  * @param {Object} config - 配置对象
@@ -51,53 +121,81 @@ function validateConfig(config) {
   return true;
 }
 
-// 加载飞书配置
-const feishuConfig = loadFeishuConfig();
-
-if (!feishuConfig) {
-  console.error('\n错误: 未找到飞书配置文件');
-  console.error('\n请先运行: iflow-feishu');
-  console.error('首次运行时会引导你配置飞书机器人凭证\n');
-  process.exit(1);
+/**
+ * 构建完整配置对象
+ */
+function buildConfig(feishuConfig) {
+  return {
+    version: VERSION,
+    feishu: {
+      appId: feishuConfig.appId,
+      appSecret: feishuConfig.appSecret,
+    },
+    iflow: {
+      command: 'iflow',
+      timeout: 300000,
+      workDir: process.env.HOME || '/data/data/com.termux/files/home',
+      maxTokens: DEFAULT_MAX_TOKENS,
+      modelMaxTokens: MODEL_MAX_TOKENS
+    },
+    server: { 
+      port: parseInt(process.env.PORT, 10) || 18080,
+      host: '0.0.0.0'
+    },
+    sessions: {
+      dir: path.join(process.env.HOME || '/tmp', '.iflow-feishu', 'sessions'),
+      maxHistory: 15,
+    },
+    card: {
+      titleFontSize: 'small',
+      colors: {
+        model: 'blue',
+        generating: 'orange',
+        completed: 'green'
+      }
+    }
+  };
 }
 
-// 构建完整配置
-const config = {
-  feishu: {
-    appId: feishuConfig.appId,
-    appSecret: feishuConfig.appSecret,
-  },
-  iflow: {
-    command: 'iflow',
-    timeout: 300000,
-    workDir: process.env.HOME || '/data/data/com.termux/files/home',
-    maxTokens: DEFAULT_MAX_TOKENS,
-    modelMaxTokens: MODEL_MAX_TOKENS
-  },
-  server: { 
-    port: parseInt(process.env.PORT, 10) || 18080,
-    host: '0.0.0.0'
-  },
-  sessions: {
-    dir: path.join(process.env.HOME || '/tmp', '.iflow-feishu', 'sessions'),
-    maxHistory: 15,
-  },
-  card: {
-    titleFontSize: 'small',
-    colors: {
-      model: 'blue',
-      generating: 'orange',
-      completed: 'green'
-    }
+/**
+ * 初始化配置（异步，支持交互式向导）
+ * @returns {Promise<Object>} 配置对象
+ */
+async function initConfig() {
+  let feishuConfig = loadFeishuConfig();
+  
+  // 检查环境变量
+  if (!feishuConfig && process.env.FEISHU_APP_ID && process.env.FEISHU_APP_SECRET) {
+    feishuConfig = {
+      appId: process.env.FEISHU_APP_ID,
+      appSecret: process.env.FEISHU_APP_SECRET
+    };
   }
-};
-
-// 验证配置
-validateConfig(config);
-
-// 确保会话目录存在
-if (!fs.existsSync(config.sessions.dir)) {
-  fs.mkdirSync(config.sessions.dir, { recursive: true });
+  
+  // 配置缺失，启动向导
+  if (!feishuConfig) {
+    console.log('\n⚠️  未找到飞书配置文件');
+    console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n');
+    
+    feishuConfig = await setupWizard();
+  }
+  
+  const config = buildConfig(feishuConfig);
+  
+  // 验证配置
+  validateConfig(config);
+  
+  // 确保会话目录存在
+  if (!fs.existsSync(config.sessions.dir)) {
+    fs.mkdirSync(config.sessions.dir, { recursive: true });
+  }
+  
+  return config;
 }
 
-module.exports = config;
+module.exports = {
+  initConfig,
+  getVersion,
+  VERSION,
+  CONFIG_PATH
+};

package/src/index.js

@@ -1,14 +1,17 @@
 /**
- * iFlow Feishu - v1.0.0
+ * iFlow Feishu
  * 将 iFlow CLI 接入飞书机器人
  */
 
 const { FeishuService } = require('./core/service');
-const config = require('./config/config');
+const { initConfig, VERSION } = require('./config/config');
 const { logger } = require('./utils/logger');
 
 async function main() {
-  console.log('\n🚀 iFlow Feishu v1.0.0');
+  // 初始化配置（支持交互式向导）
+  const config = await initConfig();
+
+  console.log(`\n🚀 iFlow Feishu v${VERSION}`);
   console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
   console.log(`📱 飞书 App ID: ${config.feishu.appId.substring(0, 15)}...`);
   console.log(`🌐 服务端口: ${config.server.port}`);