irises 1.0.4 → 1.0.6

package/data/configs.example/cloudflare.yaml

@@ -0,0 +1,17 @@
+# Cloudflare 管理配置
+# 用于通过 Web GUI 管理 DNS 记录和 SSL 设置
+#
+# API Token 解析优先级：apiToken > apiTokenEnv > apiTokenFile
+# 三者都不配置则视为未配置 Cloudflare
+
+# 方式一：直接填写 API Token（不推荐，明文存储）
+# apiToken: your-cloudflare-api-token
+
+# 方式二：从环境变量读取（推荐）
+# apiTokenEnv: IRIS_CF_API_TOKEN
+
+# 方式三：从文件读取（绝对路径，或相对于配置目录）
+# apiTokenFile: /etc/iris/cf-token.txt
+
+# Zone ID（不填则自动选择账号下的第一个 zone）
+# zoneId: auto

package/data/configs.example/mcp.yaml

@@ -1,5 +1,21 @@
 # MCP 服务器配置
 # 连接外部 MCP 服务器，自动将其工具注入 LLM 工具列表
+# 启动时后台异步连接，不阻塞启动
+#
+# 每个服务器支持以下字段：
+#   transport  - 传输方式: stdio | sse | streamable-http
+#   enabled    - 是否启用（默认 true）
+#   timeout    - 连接/listTools 超时，单位 ms（默认 30000）
+#
+# stdio 模式专用：
+#   command    - 要执行的命令
+#   args       - 命令参数数组
+#   env        - 额外环境变量
+#   cwd        - 工作目录
+#
+# sse / streamable-http 模式专用：
+#   url        - MCP 服务器 URL
+#   headers    - 自定义 HTTP 请求头
 
 # servers:
 #   # stdio 传输示例（本地进程）
@@ -7,11 +23,16 @@
 #     transport: stdio
 #     command: npx
 #     args: ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/allowed/dir"]
+#     timeout: 30000
+#     enabled: true
 #
 #   # HTTP 传输示例（远程服务器）
 #   remote_tools:
 #     transport: streamable-http
-#     url: https://mcp.example.com/sse
+#     url: https://mcp.example.com/mcp
+#     headers:
+#       Authorization: Bearer your-token
+#     timeout: 30000
 #
 #   # 企微官方文档 MCP（智能表格 + 文档 CRUD，8 个工具）
 #   # 在企微管理后台创建智能机器人后，MCP 端点页面可获取 apikey

package/data/configs.example/memory.yaml

@@ -0,0 +1,33 @@
+# 记忆插件配置
+#
+# 启用后，LLM 可通过 memory_search / memory_add / memory_update / memory_delete 工具
+# 读写长期记忆，实现跨会话的信息持久化。
+#
+# 存储后端：SQLite + FTS5 全文检索
+# 数据库文件默认存放在数据目录下的 memory.db
+
+# 是否启用记忆
+enabled: false
+
+# 数据库路径（相对于数据目录，或绝对路径）
+# dbPath: ./memory.db
+
+# ── 自动提取（对话结束后自动从对话中提取值得记住的信息）──
+autoExtract: true
+# 每 N 轮对话后提取一次
+extractInterval: 1
+
+# ── 智能检索（每轮对话前自动注入相关记忆到上下文）──
+autoRecall: true
+# 每轮注入记忆的最大大小（字节）
+maxContextBytes: 20480
+# 会话级记忆注入总上限（字节）
+sessionBudgetBytes: 61440
+
+# ── 跨会话归纳（定期整理合并冗余记忆）──
+consolidation:
+  enabled: true
+  # 两次归纳之间的最小间隔（小时）
+  minHours: 24
+  # 触发归纳的最少新会话数
+  minSessions: 3

package/data/configs.example/modes.yaml

@@ -1,5 +1,15 @@
 # 模式配置
 # 不同模式可定义不同的系统提示词和工具策略
+# 通过 /mode 命令切换模式
+#
+# 每个模式支持以下字段：
+#   description    - 模式描述（供人类和 LLM 了解用途）
+#   systemPrompt   - 该模式的系统提示词（覆盖默认提示词）
+#   tools          - 工具过滤规则
+#     include      - 白名单：仅允许这些工具（优先于 exclude）
+#     exclude      - 黑名单：排除这些工具
+#
+# 模式名 "default" 为内置默认模式（全部工具可用），无需定义
 
 # code:
 #   description: "代码开发模式"
@@ -8,11 +18,11 @@
 #     exclude: [memory_add, memory_delete]
 #
 # readonly:
-#   description: "只读分析模式"
+#   description: "只读分析模式 — 只能读取文件和搜索，不能修改"
 #   tools:
-#     include: [read_file, memory_search, get_current_time]
+#     include: [read_file, search_in_files, find_files, list_files, memory_search, get_current_time]
 #
 # chat:
-#   description: "纯聊天模式"
+#   description: "纯聊天模式 — 不使用任何文件操作工具"
 #   tools:
 #     include: [get_current_time]

package/data/configs.example/net.yaml

@@ -0,0 +1,26 @@
+# 多端互联配置
+# 启用后可从远程设备控制本 Iris 实例
+
+# 直连模式：启动 WebSocket 服务器
+# enabled: true
+# port: 9100
+# host: 0.0.0.0
+# token: your-secret-token-here
+
+# 局域网发现：启用后可被同网络的 Iris 实例自动发现
+# 发现使用 UDP 端口 (port + 1)，默认 9101
+# 发现响应不包含 token，安全可靠
+
+# 已保存的远程连接（/remote 命令中显示为快捷列表）
+# remotes:
+#   my-linux:
+#     url: ws://192.168.1.100:9100
+#     token: my-secret-token
+#   my-server:
+#     url: ws://10.0.0.5:9100
+
+# 中继模式：注册到中继服务器（用于 NAT 穿透）
+# relay:
+#   url: wss://your-relay-server:9001
+#   nodeId: my-iris
+#   token: relay-secret-token

package/data/configs.example/ocr.yaml

@@ -1,9 +1,17 @@
 # OCR 配置（可选）
-# 当主模型不支持图片输入时，Iris 会调用这里配置的 openai-compatible vision 模型提取文字与图片内容，
-# 再把提取结果发送给主对话模型。
-# 删除整个文件即可关闭 OCR 回退。
+#
+# 当主模型不支持图片输入（supportsVision: false）时，
+# Iris 会调用这里配置的 vision 模型提取图片中的文字和内容，
+# 再把提取结果作为文本注入主对话模型的上下文。
+#
+# 何时需要配置：
+#   - 主模型是纯文本模型（如 gpt-4o-mini 文本版），但用户会上传图片
+#   - 主模型本身支持图片输入时，通常不需要配置 OCR
+#
+# 删除整个文件或注释掉所有字段即可关闭 OCR 回退。
+# 关闭后，不支持图片的模型会收到"无法查看图片内容"的占位提示。
 
-provider: openai-compatible
-apiKey: your-api-key-here
-baseUrl: https://api.openai.com/v1
-model: gpt-4o-mini
+# provider: openai-compatible    # 当前仅支持 openai-compatible
+# apiKey: your-api-key-here      # OCR 模型的 API Key
+# baseUrl: https://api.openai.com/v1  # API 基地址
+# model: gpt-4o-mini             # 推荐使用轻量 vision 模型，成本低、速度快

package/data/configs.example/storage.yaml

@@ -1,10 +1,22 @@
 # 存储配置
+#
+# 会话数据的持久化后端，支持两种模式：
+#
+# json-file（默认）：
+#   - 每个会话一个 .json 文件，存放在 dir 目录下
+#   - 可直接阅读/编辑 JSON 文件，适合小规模使用
+#   - 并发控制通过 per-session 写锁实现
+#
+# sqlite：
+#   - 单个 SQLite 数据库文件，WAL 模式，天然支持并发
+#   - 大量会话时性能更优
+#   - 需要 SQLite 工具查看数据
 
 # 类型: json-file | sqlite
 type: json-file
 
-# 会话数据目录（默认 ~/.iris/sessions/）
+# 会话数据目录（默认 ~/.iris/sessions/，type 为 json-file 时使用）
 # dir: ~/.iris/sessions
 
-# SQLite 数据库路径（type 为 sqlite 时使用，默认 ~/.iris/iris.db）
+# SQLite 数据库路径（默认 ~/.iris/iris.db，type 为 sqlite 时使用）
 # dbPath: ~/.iris/iris.db

package/package.json

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