irises 1.0.0

package/bin/iris

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+
+/**
+ * Iris npm 启动器
+ *
+ * 纯 Node.js 脚本，负责查找并执行当前平台对应的预编译 Iris 二进制。
+ * 该脚本随 npm 包装器包 (irises) 一起发布，用户通过 npm install -g irises 安装后
+ * 即可直接执行 iris 命令。
+ *
+ * 二进制查找优先级：
+ *   1. IRIS_BIN_PATH 环境变量
+ *   2. postinstall 缓存的 bin/.iris 硬链接
+ *   3. 遍历 node_modules 搜索平台包
+ */
+
+const childProcess = require("child_process")
+const fs = require("fs")
+const path = require("path")
+const os = require("os")
+
+function run(target) {
+  const result = childProcess.spawnSync(target, process.argv.slice(2), {
+    stdio: "inherit",
+  })
+  if (result.error) {
+    console.error(result.error.message)
+    process.exit(1)
+  }
+  const code = typeof result.status === "number" ? result.status : 0
+  process.exit(code)
+}
+
+// 1. 环境变量覆盖
+const envPath = process.env.IRIS_BIN_PATH
+if (envPath) {
+  run(envPath)
+}
+
+const scriptPath = fs.realpathSync(__filename)
+const scriptDir = path.dirname(scriptPath)
+
+// 2. postinstall 缓存
+const cached = path.join(scriptDir, ".iris")
+if (fs.existsSync(cached)) {
+  run(cached)
+}
+
+// 3. 平台检测
+const platformMap = {
+  darwin: "darwin",
+  linux: "linux",
+  win32: "windows",
+}
+const archMap = {
+  x64: "x64",
+  arm64: "arm64",
+  arm: "arm",
+}
+
+let platform = platformMap[os.platform()]
+if (!platform) {
+  platform = os.platform()
+}
+let arch = archMap[os.arch()]
+if (!arch) {
+  arch = os.arch()
+}
+const base = "irises-" + platform + "-" + arch
+const binary = platform === "windows" ? "iris.exe" : "iris"
+
+// 4. 搜索 node_modules
+function findBinary(startDir) {
+  let current = startDir
+  for (;;) {
+    const modules = path.join(current, "node_modules")
+    if (fs.existsSync(modules)) {
+      const candidate = path.join(modules, base, "bin", binary)
+      if (fs.existsSync(candidate)) return candidate
+    }
+    const parent = path.dirname(current)
+    if (parent === current) {
+      return
+    }
+    current = parent
+  }
+}
+
+const resolved = findBinary(scriptDir)
+if (!resolved) {
+  console.error(
+    "未找到当前平台的 Iris 二进制。" +
+    " 可尝试手动安装 \"" + base + "\" 包。"
+  )
+  process.exit(1)
+}
+
+run(resolved)

package/data/agents.example/my-agent/configs/computer_use.yaml

@@ -0,0 +1,138 @@
+# Computer Use 配置
+#
+# 启用后，LLM 可通过一组预定义工具操控浏览器或桌面。
+# 工具包括 get_screenshot、click_at、type_text_at、scroll_document 等，
+# 走普通 function calling 路径，任何支持工具调用的模型均可使用。
+#
+# 依赖：
+#   browser 环境需要安装 Playwright
+#     npm install playwright
+#     laywright install chromium
+#   screen 环境无额外依赖（Windows 通过 PowerShell 调用系统 API）
+
+# 是否启用（默认关闭）
+enabled: false
+
+# 执行环境
+#   browser — Playwright 控制 Chromium 浏览器（操作范围限定在浏览器窗口内）
+#   screen  — 系统级截屏 + 输入模拟（默认全屏，可通过 targetWindow 限定到单个窗口）
+environment: browser
+
+# ─── 工具策略 ───
+#
+# 按环境配置要启用或排除的工具。
+# 三个环境层级，运行时自动选择匹配的一个：
+#   browser     — Playwright 浏览器环境
+#   screen      — 桌面全屏 / 窗口前台模式
+#   background  — 桌面窗口后台模式（screen + backgroundMode: true）
+#
+# 每个环境支持两种策略（互斥，include 优先）：
+#   include: [工具名]  — 白名单，仅启用列出的工具
+#   exclude: [工具名]  — 黑名单，排除列出的工具，其余全部启用
+#
+# 不配置 environmentTools 时使用内置默认策略：
+#   browser:    全部启用
+#   screen:     排除 go_back, go_forward, search
+#   background: 排除 go_back, go_forward, search, drag_and_drop
+#
+# 配置后覆盖对应环境的默认策略。未配置的环境仍使用默认值。
+#
+# 全部 13 个工具：
+#   get_screenshot, click_at, hover_at, type_text_at,
+#   scroll_document, scroll_at, key_combination, navigate,
+#   go_back, go_forward, search, wait_5_seconds, drag_and_drop
+#
+# ── 示例 ──
+#
+# environmentTools:
+#   # 浏览器环境：排除拖拽
+#   browser:
+#     exclude:
+#       - drag_and_drop
+#
+#   # 桌面环境：使用内置默认排除策略（不配置即可）
+#
+#   # 后台模式：白名单，只允许基础操作
+#   background:
+#     include:
+#       - get_screenshot
+#       - click_at
+#       - type_text_at
+#       - scroll_document
+#       - key_combination
+#       - wait_5_seconds
+
+# ─── browser 环境专用 ───
+
+# 启动时打开的初始页面
+# initialUrl: https://www.google.com
+
+# 搜索引擎首页（search 工具导航的目标）
+# searchEngineUrl: https://www.google.com
+
+# 浏览器视口尺寸（像素），仅 browser 环境生效
+# screen 环境下屏幕/窗口尺寸自动检测，无需手动配置
+# Gemini 推荐 1440×900 以获得最佳效果
+screenWidth: 1440
+screenHeight: 900
+
+# 是否无头模式（不显示浏览器窗口）
+# 调试时建议关闭，以便观察操作过程
+headless: false
+
+# 是否在操作位置显示红色圆圈标记（调试用）
+# highlightMouse: true
+
+# ─── screen 环境专用 ───
+#
+# 默认为全屏模式（截取整个桌面，操作范围不受限制）。
+# 如需限定在某个应用窗口内，设置 targetWindow 即可。
+#
+# 目标窗口标题（子串匹配）。设置后：
+#   - 截屏只截取该窗口区域
+#   - 鼠标坐标自动偏移到窗口位置
+#   - 操作前自动将窗口置于前台（后台模式除外）
+#   - screenSize 返回窗口尺寸（LLM 的坐标归一化基于窗口尺寸）
+# 不设置则为全屏模式。
+#
+# 示例：
+#   targetWindow: "记事本"       # 匹配标题包含"记事本"的窗口
+#   targetWindow: "Chrome"       # 匹配标题包含 Chrome 的窗口
+#   targetWindow: "Visual Studio Code"
+# targetWindow:
+#
+# 注意：全屏模式下 AI 的操作范围不受限制，请谨慎使用。
+# 建议将 key_combination 等高风险工具设为 autoApprove: false（在 tools.yaml 中配置）。
+
+# 后台操作模式（仅窗口模式下有效，需先设置 targetWindow）。
+# 启用后不需要目标窗口在前台，AI 可以在后台操作窗口。
+# 窗口只需处于显示状态（不最小化），可以被其他窗口遮挡。
+# 如果窗口被最小化，会自动恢复但不激活（不抢焦点）。
+#
+# 实现方式：
+#   截图 → PrintWindow（请求窗口自绘，支持 GPU 加速窗口）
+#   鼠标 → PostMessage(WM_LBUTTONDOWN/UP)
+#   键盘 → PostMessage(WM_KEYDOWN/UP) / WM_CHAR
+#
+# 截图兼容性（PrintWindow）：
+#   ✓ 原生 Win32 / WPF / WinForms 应用
+#   ✓ GPU 加速窗口（Chrome、Electron、游戏等）— 只要窗口处于显示状态
+#
+# 操作兼容性（PostMessage）：
+#   ✓ 原生 Win32 / WPF / WinForms — 点击、键盘、滚动均正常
+#   △ 部分应用可能不响应 PostMessage 的鼠标/键盘消息
+#   △ 拖拽操作通过消息模拟，部分应用可能不支持
+#
+# 默认 false（前台模式）。
+# backgroundMode: true
+
+# ─── 截图保留策略 ───
+#
+# 发送给 LLM 时，只保留最近 N 轮 Computer Use 工具交互中的截图。
+# 超出的旧轮次截图会被自动剥离，以节省 token。
+# 存储中的完整截图不受影响。
+#
+# 默认 3，与 Gemini 官方示例一致。
+# 设为 0 表示不保留任何截图（仅保留 URL 等文本信息）。
+# 不设置或注释掉则使用默认值 3。
+maxRecentScreenshots: 3

package/data/agents.example/my-agent/configs/llm.yaml

@@ -0,0 +1,71 @@
+# LLM 配置（模型池）
+# defaultModel: 启动时默认使用的模型名称
+# models:       可用模型列表，键名就是模型名称
+
+# defaultModel 必须指向 models 中的某个模型名称
+# 运行中的 Console TUI 可以通过 /model 指令切换当前使用的模型
+
+defaultModel: gemini_flash
+
+models:
+  gemini_flash:
+    # 提供商: gemini | openai-compatible | openai-responses | claude
+    provider: gemini
+    apiKey: your-api-key-here
+    # model 字段填写提供商真实模型 id
+    model: gemini-2.0-flash
+    # Gemini 要以 /v1beta 结尾；OpenAI 兼容 / OpenAI Responses / Claude 要以 /v1 结尾
+    # 在此基础上，程序再补全具体接口后缀
+    baseUrl: https://generativelanguage.googleapis.com/v1beta
+    # 是否支持图片输入；不填时程序会按模型名自动判断。
+    # 如果你使用代理网关、自定义模型别名，建议显式填写。
+    supportsVision: true
+
+    # 模型上下文窗口大小（token 数，用于 TUI 显示占用比例）
+    # 常见模型已有内置默认值，通常无需手动设置
+    # contextWindow: 1048576
+
+    # 自定义请求头：会覆盖 provider 内置同名 header
+    # headers:
+    #   x-goog-api-key: your-override-key
+    #   x-custom-header: hello
+
+    # 自定义请求体：会深合并到 provider 编码后的最终请求体，支持嵌套参数
+    # 例如 Gemini thinking / 输出长度 / 温度等都可以直接这样配置
+    # requestBody:
+    #   generationConfig:
+    #     maxOutputTokens: 32000
+    #     temperature: 1
+    #     topP: 1
+    #     thinkingConfig:
+    #       thinkingBudget: 1228
+    #       includeThoughts: true
+
+  # gpt4o_mini:
+  #   provider: openai-compatible
+  #   apiKey: your-api-key-here
+  #   model: gpt-4o-mini
+  #   baseUrl: https://api.openai.com/v1
+  #   supportsVision: false
+
+  # gpt4o:
+  #   provider: openai-responses
+  #   apiKey: your-api-key-here
+  #   model: gpt-4o
+  #   baseUrl: https://api.openai.com/v1
+  #   supportsVision: true
+
+# Claude 示例：
+# models:
+#   claude_sonnet:
+#     provider: claude
+#     apiKey: your-api-key-here
+#     model: claude-sonnet-4-6
+#     baseUrl: https://api.anthropic.com/v1
+# Gemini 示例：
+# models:
+#   gemini_flash:
+#     provider: gemini
+#     apiKey: your-api-key-here
+#     model: gemini-2.0-flash
+#     baseUrl: https://generativelanguage.googleapis.com/v1beta

package/data/agents.example/my-agent/configs/mcp.yaml

@@ -0,0 +1,20 @@
+# MCP 服务器配置
+# 连接外部 MCP 服务器，自动将其工具注入 LLM 工具列表
+
+# servers:
+#   # stdio 传输示例（本地进程）
+#   filesystem:
+#     transport: stdio
+#     command: npx
+#     args: ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/allowed/dir"]
+#
+#   # HTTP 传输示例（远程服务器）
+#   remote_tools:
+#     transport: streamable-http
+#     url: https://mcp.example.com/sse
+#
+#   # 企微官方文档 MCP（智能表格 + 文档 CRUD，8 个工具）
+#   # 在企微管理后台创建智能机器人后，MCP 端点页面可获取 apikey
+#   wecom-doc:
+#     transport: streamable-http
+#     url: "https://qyapi.weixin.qq.com/mcp/robot-doc?apikey=your-mcp-apikey"

package/data/agents.example/my-agent/configs/memory.yaml

@@ -0,0 +1,7 @@
+# 记忆配置
+
+# 是否启用记忆
+enabled: false
+
+# 数据库路径（默认 ~/.iris/memory.db）
+# dbPath: ~/.iris/memory.db

package/data/agents.example/my-agent/configs/modes.yaml

@@ -0,0 +1,18 @@
+# 模式配置
+# 不同模式可定义不同的系统提示词和工具策略
+
+# code:
+#   description: "代码开发模式"
+#   systemPrompt: "你是一个专注于代码开发的 AI 助手。"
+#   tools:
+#     exclude: [memory_add, memory_delete]
+#
+# readonly:
+#   description: "只读分析模式"
+#   tools:
+#     include: [read_file, memory_search, get_current_time]
+#
+# chat:
+#   description: "纯聊天模式"
+#   tools:
+#     include: [get_current_time]

package/data/agents.example/my-agent/configs/ocr.yaml

@@ -0,0 +1,9 @@
+# OCR 配置（可选）
+# 当主模型不支持图片输入时，Iris 会调用这里配置的 openai-compatible vision 模型提取文字与图片内容，
+# 再把提取结果发送给主对话模型。
+# 删除整个文件即可关闭 OCR 回退。
+
+provider: openai-compatible
+apiKey: your-api-key-here
+baseUrl: https://api.openai.com/v1
+model: gpt-4o-mini

package/data/agents.example/my-agent/configs/platform.yaml

@@ -0,0 +1,49 @@
+# 平台配置
+
+# 类型: console | discord | telegram | web | wxwork | lark
+# 支持单平台或多平台同时启动：
+#   type: console            # 单平台
+#   type: [console, web]     # 多平台同时启动
+type: console
+
+discord:
+  token: your-discord-bot-token
+
+telegram:
+  token: your-telegram-bot-token
+  # 是否在流式回复中展示工具执行状态（默认 true）
+  # showToolStatus: false
+  # 群聊中是否要求 @机器人 后才响应（默认 true）
+  # groupMentionRequired: true
+
+web:
+  port: 8192
+  # 127.0.0.1 = 仅本机访问（配合 Nginx 反代使用，推荐）
+  # 0.0.0.0   = 允许所有网络接口访问（本地开发/无反代时使用）
+  host: 127.0.0.1
+  # API 全局认证令牌（可选，未配置时不启用）
+  # authToken: your-secret-token-here
+  # 管理接口认证令牌（推荐）
+  # managementToken: your-management-token-here
+
+wxwork:
+  # 企业微信智能机器人 Bot ID 和 Secret
+  # 在企业微信管理后台 → 应用管理 → 智能机器人 中创建并获取
+  # 文档: https://developer.work.weixin.qq.com/document/path/101463
+  botId: your-bot-id
+  secret: your-bot-secret
+  # 是否在流式回复中展示工具执行状态（默认 true）
+  # showToolStatus: false
+
+lark:
+  # 飞书自建应用 App ID 和 App Secret
+  # 在飞书开放平台创建自建应用，开启「机器人」能力后获取
+  # 文档: https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes
+  appId: your-app-id
+  appSecret: your-app-secret
+  # 是否在流式回复中展示工具执行状态（默认 true）
+  # showToolStatus: false
+  # 可选：Webhook 模式用的验证 token（WebSocket 模式不需要）
+  # verificationToken: your-verification-token
+  # 可选：Webhook 模式用的加密 key（WebSocket 模式不需要）
+  # encryptKey: your-encrypt-key

package/data/agents.example/my-agent/configs/storage.yaml

@@ -0,0 +1,10 @@
+# 存储配置
+
+# 类型: json-file | sqlite
+type: json-file
+
+# 会话数据目录（默认 ~/.iris/sessions/）
+# dir: ~/.iris/sessions
+
+# SQLite 数据库路径（type 为 sqlite 时使用，默认 ~/.iris/iris.db）
+# dbPath: ~/.iris/iris.db

package/data/agents.example/my-agent/configs/sub_agents.yaml

@@ -0,0 +1,53 @@
+# 子代理配置
+# 定义主 LLM 可委派的子代理类型。
+# 删除或注释掉某个类型即可禁用它，清空所有类型则完全禁用子代理功能。
+
+# 字段说明：
+#   description   - 面向主 LLM 的用途说明（展示在 sub_agent 工具描述中）
+#   systemPrompt  - 子代理的系统提示词
+#   allowedTools  - 工具白名单（与 excludedTools 互斥，优先）
+#   excludedTools - 工具黑名单
+#   modelName     - 固定使用的模型名称；不写时跟随当前活动模型
+#   parallel      - 当前类型的 sub_agent 调用是否按 parallel 工具参与调度（默认 false）
+#                   不写就是 false，只有显式写 true 才会参与并行调度
+#   maxToolRounds - 最大工具执行轮次
+
+types:
+  general-purpose:
+    description: "执行需要多步工具操作的复杂子任务。适合承接相对独立的子任务。"
+    systemPrompt: "你是一个通用子代理，负责独立完成委派给你的子任务。请专注于完成任务并返回清晰的结果。"
+    excludedTools:
+      - sub_agent
+    parallel: false
+    # modelName: gemini_flash
+    maxToolRounds: 200
+
+  explore:
+    description: "只读搜索和阅读文件、执行查询命令。不做修改，只返回发现的信息。"
+    systemPrompt: "你是一个只读探索代理，负责搜索和阅读信息。不要修改任何文件，只返回你发现的内容。"
+    allowedTools:
+      - read_file
+      - search_in_files
+      - find_files
+      - list_files
+      - shell
+    parallel: true
+    # modelName: gpt4o_mini
+    maxToolRounds: 200
+
+  recall:
+    description: "从长期记忆中检索相关信息。当需要回忆用户偏好、历史事实或之前保存的内容时使用。"
+    systemPrompt: |
+      你是一个记忆召回代理。根据给定的查询，从长期记忆中尽可能全面地检索相关信息。
+
+      策略：
+      1. 先用原始查询搜索
+      2. 如果结果不够，提取关键词重新搜索
+      3. 尝试相关概念或同义词搜索
+
+      将所有找到的记忆整理为清晰的摘要返回。如果没有找到任何相关记忆，明确说明。
+    allowedTools:
+      - memory_search
+    parallel: false
+    # modelName: recall_model
+    maxToolRounds: 3

package/data/agents.example/my-agent/configs/system.yaml

@@ -0,0 +1,25 @@
+# 系统配置（Agent: my-agent）
+#
+# 每个 agent 拥有独立的系统配置。
+# 你可以为不同 agent 设置不同的提示词、工具轮次等。
+
+# 系统提示词（留空则使用默认）
+systemPrompt: ""
+
+# 工具执行最大轮次
+maxToolRounds: 200
+
+# 流式输出
+stream: true
+
+# LLM 调用报错自动重试（默认开启）
+retryOnError: true
+
+# 最大重试次数（默认 3）
+maxRetries: 3
+
+# 子代理最大嵌套深度（默认 3）
+# maxAgentDepth: 3
+
+# 默认模式（需与 modes.yaml 中定义的名称对应）
+# defaultMode: code