irises 1.0.0

package/data/configs.example/plugins.yaml

@@ -0,0 +1,47 @@
+# =========================================================
+# 插件配置
+#
+# 配置要加载的 Iris 插件。
+# 插件可以扩展工具、模式、钩子，也可以在 preBootstrap 阶段注册
+# 自定义 LLM / Storage / Memory / OCR Provider 与自定义平台。
+#
+# 插件来源：
+#   - local（默认）：从 ~/.iris/plugins/<name>/ 目录加载
+#   - npm：从 npm 包 iris-plugin-<name> 加载
+#
+# priority:
+#   - 数值越大越先执行
+#   - 影响 preBootstrap、activate、hook 链执行顺序
+#
+# config:
+#   - 会与插件目录中的 config.yaml 做浅合并
+#   - 同名字段以这里的值为准
+#
+# inline 插件：
+#   - 只支持在运行时通过 bootstrap({ inlinePlugins }) 注入
+#   - 不能在 plugins.yaml 中直接声明
+#
+# 插件目录结构：
+#   ~/.iris/plugins/
+#     my-plugin/
+#       index.ts          # 入口文件（必须 export default 一个 IrisPlugin）
+#       config.yaml       # 插件默认配置（可选）
+# ============================================================
+
+# plugins:
+#   # 本地插件示例
+#   - name: my-tool
+#     enabled: true
+#     priority: 100
+#     config:
+#       apiKey: "sk-xxx"
+#
+#   # npm 包插件示例
+#   - name: rag
+#     type: npm
+#     enabled: true
+#     priority: 50
+#
+#   # 禁用某个插件
+#   - name: some-plugin
+#     enabled: false

package/data/configs.example/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/configs.example/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/configs.example/summary.yaml

@@ -0,0 +1,21 @@
+# 上下文压缩配置（/compact 指令）
+
+# 总结 AI 的系统提示词
+systemPrompt: |
+  You are a conversation compressor. Your task is to read the conversation history and produce a dense context summary.
+
+  The summary must:
+  1. State what the user is working on (project, goal)
+  2. List key file paths and code changes made
+  3. Note important decisions and their reasons
+  4. Describe current state and any pending tasks
+  5. Preserve technical details (function names, config keys, error messages, etc.)
+
+  Rules:
+  - Write in the same language as the conversation
+  - Be information-dense — every sentence should contain useful context
+  - Do NOT include pleasantries, greetings, or meta-commentary
+  - Output ONLY the summary text
+
+# 追加在对话末尾的用户指令（要求 AI 生成摘要）
+userPrompt: "Please summarize the conversation above into a concise context summary."

package/data/configs.example/system.yaml

@@ -0,0 +1,57 @@
+# 系统配置
+
+# 系统提示词（留空则使用默认）
+systemPrompt: ""
+
+# 工具执行最大轮次
+maxToolRounds: 200
+
+# 流式输出
+stream: true
+
+# LLM 调用报错自动重试（默认开启）
+retryOnError: true
+
+# 最大重试次数（默认 3）
+maxRetries: 3
+
+# 子代理最大嵌套深度（默认 3）
+# maxAgentDepth: 3
+
+# 默认模式（需与 modes.yaml 中定义的名称对应）
+# defaultMode: code
+
+# 记录 LLM 请求/响应日志（调试用，默认关闭）
+# 开启后每次 LLM 调用会在 ~/.iris/logs/ 生成配对的请求和响应文件：
+#   request_<timestamp>.json   — 请求（URL、headers、body）
+#   response_<timestamp>.json  — 非流式响应原文
+#   response_<timestamp>.txt   — 流式响应原文（SSE）
+# logRequests: true
+
+# 兼容旧配置：skillPreamble 仍可被读取，但当前版本已不再使用。
+# 说明：Skill 已改为通过 read_skill 工具按需读取，不再拼接到用户消息末尾。
+
+# Skill 定义（按需加载的提示词模块）
+# 当前实现会先把 Skill 的 name / path / description 暴露给模型，
+# 模型需要完整 Skill 内容时，再通过 read_skill(path) 工具按需读取。
+# 名称规则：仅允许 ASCII 字母、数字、下划线、连字符，最长 64 字符
+#
+# 除了在此处内联定义，也可以将 SKILL.md 放在以下目录：
+#   ~/.iris/skills/<name>/SKILL.md    — 全局 Skill
+#   .agents/skills/<name>/SKILL.md    — 项目级 Skill（cwd 下）
+# 文件格式遵循 Agent Skills 开放标准（YAML frontmatter + Markdown 正文）
+# 同名时此处的内联定义优先于文件系统中的定义。
+# 内联 Skill 没有真实的 SKILL.md 文件，因此系统会为它生成形如 inline:<name> 的路径标识，
+# 供 read_skill 工具作为唯一参数使用。
+# skills:
+#   code-review:
+#     description: "代码审查专家"
+#     content: |
+#       你是一个代码审查专家。请对用户的代码进行详细审查，
+#       关注代码质量、安全性、性能和可维护性。
+#
+#   translator:
+#     description: "中英翻译助手"
+#     content: |
+#       请将用户的内容翻译为对应的另一种语言（中→英 或 英→中）。
+#       保持原文的语气和风格。

package/data/configs.example/tools.yaml

@@ -0,0 +1,237 @@
+# 工具配置
+#
+# ─── 工具防御性参数（防止输出过大撑爆 LLM 上下文） ───
+#
+# 所有参数均有内置默认值，通常无需修改。
+# 如需调整，取消对应行的注释即可。
+#
+limits:
+  # ── read_file ──
+  read_file:
+    maxFiles: 10                   # 单次调用最多读取文件数
+    maxFileSizeBytes: 2097152      # 单文件最大字节数 (2MB)
+    maxTotalOutputChars: 200000    # 所有文件格式化后的总输出字符数上限
+
+  # ── search_in_files ──
+  search_in_files:
+    maxResults: 100                # 最大匹配结果数 (search 模式)
+    maxFiles: 50                   # 最大处理文件数 (replace 模式)
+    contextLines: 2                # 每条匹配的上下文行数
+    maxFileSizeBytes: 2097152      # 单文件最大字节数 (2MB)，超过则跳过
+    maxLineDisplayChars: 500       # 结果中单行最大展示字符数 (防 minified 文件撑爆)
+    maxMatchDisplayChars: 200      # 匹配文本最大展示字符数
+
+  # ── list_files ──
+  list_files:
+    maxEntries: 2000               # 递归列出时最大条目数
+
+  # ── find_files ──
+  find_files:
+    maxResults: 500                # 每个 pattern 的最大结果数
+
+  # ── shell ──
+  shell:
+    defaultTimeout: 30000          # 默认超时 (毫秒)
+    maxOutputChars: 50000          # stdout/stderr 各自的最大字符数
+    maxBuffer: 10485760            # Node.js exec maxBuffer 字节数 (10MB)
+
+# ─── 全局审批开关（最高优先级） ───
+#
+# 全部自动批准（跳过一类 + 二类审批）
+# autoApproveAll: true
+#
+# 仅跳过一类审批（Y/N 确认），二类审批（diff 预览）仍生效
+# autoApproveConfirmation: true
+#
+# 仅跳过二类审批（diff 预览），一类审批（Y/N 确认）仍生效
+# autoApproveDiff: true
+#
+# ─── 按工具配置执行策略 ───
+#
+# 下方按工具名称配置执行策略。
+# 未配置的工具默认需要手动确认。
+#
+# autoApprove: true  -> 工具调用后直接执行
+# autoApprove: false -> 工具执行前需要手动确认
+
+# 只读工具：默认直接执行
+read_file:
+  autoApprove: true
+search_in_files:
+  autoApprove: true
+  # 如需对 mode: replace 打开 diff 审批页，可改为 false，并开启 showApprovalView
+  showApprovalView: true
+find_files:
+  autoApprove: true
+list_files:
+  autoApprove: true
+read_skill:
+  # Skill 读取工具是只读操作，建议默认直接执行
+  autoApprove: true
+
+# 修改类工具：默认需要确认
+write_file:
+  autoApprove: false
+  # Console TUI 中是否打开 diff 审批视图；设为 false 时退回到底部 Y/N 确认提示
+  showApprovalView: true
+apply_diff:
+  autoApprove: false
+  # Console TUI 中是否打开 diff 审批视图；设为 false 时退回到底部 Y/N 确认提示
+  showApprovalView: true
+insert_code:
+  autoApprove: false
+  showApprovalView: true
+delete_code:
+  autoApprove: false
+  showApprovalView: true
+delete_file:
+  autoApprove: false
+create_directory:
+  autoApprove: false
+
+# ─────────────────────────────────────────────────────────────
+# Shell 工具配置
+# ─────────────────────────────────────────────────────────────
+#
+# 除了 autoApprove 开关外，shell 工具还支持细粒度的命令模式匹配：
+#
+#   allowPatterns — 白名单：匹配的命令自动执行（即使 autoApprove: false）
+#   denyPatterns  — 黑名单：匹配的命令必须确认（即使 autoApprove: true）
+#
+# 判定优先级：denyPatterns > allowPatterns > autoApprove
+#
+# 支持的模式语法：
+#   - 精确匹配：  "git status"              仅匹配该完整命令
+#   - 通配符 *：  "git log *"               匹配 git log 后跟任意参数
+#   - 通配符 ?：  "ls -?"                   匹配 ls 后跟单字母选项
+#   - 前缀匹配：  "npm run *"               匹配所有 npm run 子命令
+#   - 正则表达式："/^cat\s+\S+$/"           以 / 包裹按正则解析
+#
+# ── 用法示例 ──
+#
+#   场景 A：默认拒绝，仅放行指定命令（推荐）
+#     autoApprove: false
+#     allowPatterns:
+#       - "git status*"
+#       - "ls *"
+#
+#   场景 B：默认放行，拦截危险命令
+#     autoApprove: true
+#     denyPatterns:
+#       - "rm *"
+#       - "/sudo\s+/"
+#
+#   场景 C：混合使用（白名单 + 黑名单 + 兜底）
+#     autoApprove: false
+#     allowPatterns:
+#       - "git *"
+#     denyPatterns:
+#       - "git push *"          # 虽然 git * 在白名单，但 push 被黑名单拦截
+#
+shell:
+  autoApprove: false
+
+  # ── 白名单（取消注释以启用） ──
+  allowPatterns:
+    # 只读 / 查看类
+    # - "ls *"                    # 列出文件
+    # - "cat *"                   # 查看文件内容
+    # - "head *"                  # 查看文件开头
+    # - "tail *"                  # 查看文件结尾
+    # - "wc *"                    # 统计行数/字数
+    # - "which *"                 # 查找命令路径
+    # - "echo *"                  # 输出信息
+    # - "pwd"                     # 当前目录
+    # - "env"                     # 查看环境变量
+    #
+    # 搜索类
+    # - "grep *"                  # 搜索文本
+    # - "find *"                  # 查找文件
+    # - "rg *"                    # ripgrep 搜索
+    # - "fd *"                    # fd 查找
+    #
+    # Git 只读操作
+    # - "git status*"             # 状态查看
+    # - "git log *"               # 日志查看
+    # - "git diff*"               # 差异查看
+    # - "git branch*"             # 分支查看
+    # - "git show *"              # 查看提交
+    # - "git remote -v"           # 查看远程
+    #
+    # 包管理器（只读）
+    # - "npm list*"               # 查看依赖
+    # - "npm run *"               # 运行脚本
+    # - "bun run *"               # bun 运行脚本
+    #
+    # 自定义正则
+    # - "/^(node|bun|npx|tsx)\\s+/"  # 允许 node/bun/npx/tsx 命令
+
+  # ── 黑名单（取消注释以启用） ──
+  denyPatterns:
+    # 危险操作
+    # - "rm -rf *"                # 递归强制删除
+    # - "/^sudo\\s+/"             # 所有 sudo 命令
+    # - "/^chmod\\s+/"            # 修改权限
+    # - "/^chown\\s+/"            # 修改所有者
+    # - "dd *"                    # 磁盘操作
+    # - "/\\|\\s*sh/"             # 管道到 sh 执行
+    # - "curl * | *"              # curl 管道执行
+    #
+    # Git 危险操作
+    # - "git push *"              # 推送
+    # - "git reset --hard*"       # 硬重置
+    # - "git clean -fd*"          # 强制清理
+    #
+    # 包管理器写操作
+    # - "npm install*"            # 安装依赖
+    # - "npm publish*"            # 发布包
+
+sub_agent:
+  autoApprove: false
+
+read_skill:
+  autoApprove: true
+
+# ─────────────────────────────────────────────────────────────
+# Computer Use 工具配置（需在 computer_use.yaml 中启用）
+# ─────────────────────────────────────────────────────────────
+#
+# 以下工具在 computer_use.yaml 的 enabled: true 时自动注册。
+# 所有坐标参数均为 0-999 归一化值，由工具内部转换为实际像素。
+#
+# 只读 / 低风险操作：建议自动批准
+# get_screenshot:
+#   autoApprove: true
+# click_at:
+#   autoApprove: true
+# hover_at:
+#   autoApprove: true
+# scroll_document:
+#   autoApprove: true
+# scroll_at:
+#   autoApprove: true
+# go_back:
+#   autoApprove: true
+# go_forward:
+#   autoApprove: true
+# search:
+#   autoApprove: true
+# navigate:
+#   autoApprove: true
+# wait_5_seconds:
+#   autoApprove: true
+#
+# 输入类操作：按需决定是否自动批准
+# type_text_at:
+#   autoApprove: true
+# key_combination:
+#   autoApprove: false          # 按键组合可能触发系统级操作，建议手动确认
+# drag_and_drop:
+#   autoApprove: false
+
+# 如需启用其他工具（记忆、MCP 等），请按工具名补充配置。
+# 例如：
+# memory_search:
+#   autoApprove: true
+# mcp__my_server__my_tool:
+#   autoApprove: false

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "irises",
+  "version": "1.0.0",
+  "description": "模块化、可解耦的 AI 聊天框架，支持多平台、多 LLM、工具调用",
+  "license": "GPL-3.0-only",
+  "bin": {
+    "iris": "./bin/iris"
+  },
+  "scripts": {
+    "postinstall": "bun ./postinstall.mjs || node ./postinstall.mjs"
+  },
+  "optionalDependencies": {
+    "irises-linux-x64": "1.0.0",
+    "irises-darwin-arm64": "1.0.0",
+    "irises-darwin-x64": "1.0.0",
+    "irises-windows-x64": "1.0.0",
+    "irises-linux-arm64": "1.0.0"
+  }
+}

package/postinstall.mjs

@@ -0,0 +1,107 @@
+#!/usr/bin/env node
+
+/**
+ * Iris npm postinstall 脚本
+ *
+ * 在 npm install 完成后自动执行，将当前平台的预编译主程序和 onboard 二进制
+ * 硬链接（或复制）到包装器包的 bin/.iris 与 bin/.iris-onboard，供统一入口调用。
+ */
+
+import fs from "fs"
+import path from "path"
+import os from "os"
+import { fileURLToPath } from "url"
+import { createRequire } from "module"
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const require = createRequire(import.meta.url)
+
+function detectPlatformAndArch() {
+  const platformMap = { darwin: "darwin", linux: "linux", win32: "windows" }
+  const archMap = { x64: "x64", arm64: "arm64", arm: "arm" }
+
+  const platform = platformMap[os.platform()] || os.platform()
+  const arch = archMap[os.arch()] || os.arch()
+  return { platform, arch }
+}
+
+function resolvePackageDir() {
+  const { platform, arch } = detectPlatformAndArch()
+  const packageName = `irises-${platform}-${arch}`
+  try {
+    const packageJsonPath = require.resolve(`${packageName}/package.json`)
+    return {
+      packageName,
+      packageDir: path.dirname(packageJsonPath),
+      platform,
+    }
+  } catch (error) {
+    throw new Error(`Could not find package ${packageName}: ${error.message}`)
+  }
+}
+
+function resolveBinaryPaths() {
+  const { packageName, packageDir, platform } = resolvePackageDir()
+  const suffix = platform === "windows" ? ".exe" : ""
+  const binaries = {
+    main: path.join(packageDir, "bin", `iris${suffix}`),
+    onboard: path.join(packageDir, "bin", `iris-onboard${suffix}`),
+  }
+
+  for (const [kind, binaryPath] of Object.entries(binaries)) {
+    if (!fs.existsSync(binaryPath)) {
+      throw new Error(`Binary (${kind}) not found in ${packageName}: ${binaryPath}`)
+    }
+  }
+
+  return binaries
+}
+
+function linkOrCopy(sourcePath, targetPath) {
+  if (fs.existsSync(targetPath)) {
+    fs.unlinkSync(targetPath)
+  }
+
+  try {
+    fs.linkSync(sourcePath, targetPath)
+  } catch {
+    fs.copyFileSync(sourcePath, targetPath)
+  }
+}
+
+async function main() {
+  try {
+    if (os.platform() === "win32") {
+      console.log("Windows detected: skip cached links, launcher will resolve packaged binaries directly")
+      return
+    }
+
+    const binaries = resolveBinaryPaths()
+    const binDir = path.join(__dirname, "bin")
+    if (!fs.existsSync(binDir)) {
+      fs.mkdirSync(binDir, { recursive: true })
+    }
+
+    const targets = {
+      main: path.join(binDir, ".iris"),
+      onboard: path.join(binDir, ".iris-onboard"),
+    }
+
+    for (const [kind, sourcePath] of Object.entries(binaries)) {
+      const targetPath = targets[kind]
+      linkOrCopy(sourcePath, targetPath)
+      fs.chmodSync(targetPath, 0o755)
+      console.log(`Iris ${kind} binary linked: ${targetPath} -> ${sourcePath}`)
+    }
+  } catch (error) {
+    console.error("Failed to setup Iris binaries:", error.message)
+    process.exit(0)
+  }
+}
+
+try {
+  main()
+} catch (error) {
+  console.error("Postinstall script error:", error.message)
+  process.exit(0)
+}