IRIS 文档

从安装到把它接进你的工作群。当前版本 v1.0.0,适用于 Windows、macOS 与 Linux。

概览

IRIS 是一个自进化的个人 AI 代理。同一份内核提供三种入口:桌面端图形界面、终端界面(TUI)与消息网关。 三者共享同一套配置、会话库和技能,所以在桌面端开的对话,可以在手机上接着聊。

所有本地数据都在 ~/.hermes 下。卸载时删除该目录即可彻底清除,不会在系统其它位置残留。

快速开始

两步:装好,然后开始对话。

# 1. 安装
$ curl -fsSL https://iris.agent/install.sh | bash

# 2. 重新加载 shell 后启动
$ source ~/.bashrc
$ weiagent

首次启动会引导你选择模型服务商并填入凭证。想一次配好全部内容(模型、工具、消息渠道),运行向导:

$ weiagent setup

安装

macOS / Linux / WSL2

$ curl -fsSL https://iris.agent/install.sh | bash

Windows

在 PowerShell 中执行:

> iex (irm https://iris.agent/install.ps1)

安装完成后可能需要重开终端,再运行 weiagent 开始对话。

Android / Termux

aarch64 设备请使用预发布的 APT 包(含 Python、Node.js 与 TUI),不要用桌面版安装脚本,否则依赖会装错架构。

桌面安装包

图形界面版本从下载页获取:Windows 为 .exe,macOS 为 .dmg,Linux 为 .AppImage / .deb。桌面端与 CLI 共用同一份 ~/.hermes。

首次配置

配置分三步,逐步细化:

命令作用
weiagent setup完整向导:选择服务商、填凭证、勾选工具集、配置消息渠道
weiagent model单独切换模型或服务商
weiagent tools选择启用哪些工具集(工具越多,每轮请求越大)
weiagent config set设置单个配置项,例如默认人格、超时、工作目录

配置写在 ~/.hermes/config.yaml,密钥写在同目录的 .env。两者都支持多套配置档案,互不干扰。

模型与服务商

对话中随时切换,不需要重启,也不需要改代码:

/model                      # 交互式选择
/model openrouter:anthropic/claude-sonnet-4
/model nous:hermes-4-405b

支持的服务商包括 Nous Portal、OpenRouter(200+ 模型)、NVIDIA NIM、Kimi / Moonshot、智谱 GLM、MiniMax、Hugging Face、OpenAI,以及任意兼容 OpenAI 协议的自定义端点。

不想逐个申请 Key 的话,可以用订阅制的模型网关一次覆盖模型、联网搜索、图像生成、语音合成与云浏览器;也可以按工具粒度混用——模型走订阅,搜索走自己的 Key。

上下文与用量

/compress                   # 压缩上下文,保留结论
/usage                      # 查看本轮与累计用量
/insights --days 7          # 近 7 天使用洞察

技能

技能是写给人看、也能被代理读懂的操作手册:一份 SKILL.md 加上可选的脚本与资源。IRIS 会在完成复杂任务后自动生成技能,并在后续使用中改写它。

把团队流程写成技能是最划算的投入:一次把步骤和坑写清,之后每次执行都一致。

消息渠道

消息网关是一个独立进程,负责把各平台的消息转给同一个代理内核,再把结果投递回去。

# 交互式选择要接入的渠道并填写凭证
$ weiagent gateway setup

# 前台启动(生产环境建议交给 systemd / 计划任务托管)
$ weiagent gateway start

企业微信、飞书、钉钉均为原生适配,不需要公网 IP 或内网穿透:

渠道接入方式
企业微信智能机器人(长连接 WebSocket)或自建应用(AES 回调)
飞书官方 SDK 长连接,或 webhook 模式
钉钉Stream Mode 长连接
其余Telegram、Slack、Discord、WhatsApp、Signal、Matrix、邮件、短信等

每个渠道可单独设置允许的用户与会话,未授权的人发消息不会触发代理。定时任务的结果也可以指定投递到某个渠道。

逐个平台的图文步骤(每一步点什么、填什么、看到什么算成功)见下面的渠道接入手册。

渠道接入手册

企业微信、钉钉、飞书三家都走长连接——由你的电脑主动连平台,所以不需要服务器、公网 IP、域名或内网穿透, 公司内网、家用宽带、笔记本连热点都能用。三个平台在各自后台点几下拿到凭证,回 IRIS 粘两个值就通了。

平台平台后台要做IRIS 里填耗时
企业微信创建智能机器人 → 选 API 模式 → 选长连接 → 设可见范围Bot ID、Secret15 分钟
钉钉建企业内部应用 → 加机器人选 Stream → 开发消息权限 → 发布Client ID、Client Secret、StaffId15–20 分钟
飞书建自建应用 → 加机器人 → 开 5 条权限 → 事件与回调 → 发版本App ID、App Secret20 分钟

三个平台通用的两个坑

企业微信

企业微信侧做 4 件事(找入口 → 建机器人 → 拿凭证 → 设可见范围),IRIS 侧只做 1 件。 不需要管理员权限:普通成员在客户端「工作台 → 智能机器人」里就能建,只有「让全公司都能用」才需要管理员。

IRIS 里的字段填什么在哪拿
WeCom (AI Bot)消息平台列表里选这一项桌面端左侧「消息平台」
Bot ID机器人的账号,不是秘密但要填对智能机器人 → 编辑 → API 配置
Secret机器人的密码,只完整显示一次同上;看不到就点「重置」换新的
PDF
把企业微信接入 IRIS · 图文手册 20 页 · 6 个步骤 · 更新于 2026-10-28

内嵌预览加载不出来时,点右上角「新窗口打开」或「下载」查看原文件。

钉钉

钉钉侧做 4 件事(建应用 → 拿凭证 → 加机器人 → 发布),IRIS 侧填 4 个字段。 前 4 步都在 open-dev.dingtalk.com 后台,第 5 步才回到 IRIS。

IRIS 里的字段填什么必填
DingTalk Client ID (app key)后台「凭证与基础信息」里的 AppKey是
DingTalk Client Secret同页的 AppSecret,只完整显示一次是
Allowed users你自己的 UserID / StaffId,多个用英文逗号隔开强烈建议填
DingTalk robot webhook URL留空否
PDF
把钉钉接入 IRIS · 图文手册 19 页 · 5 个步骤 · 更新于 2026-10-28

内嵌预览加载不出来时,点右上角「新窗口打开」或「下载」查看原文件。

飞书

飞书侧要做 6 件事(建应用 → 加机器人 → 开权限 → 订阅事件与回调 → 拿凭证 → 发版),IRIS 侧只填 2 个值。 比另外两家多两道闸门:建应用可能要管理员授权,改完配置必须重新发版。

IRIS 里的字段填什么备注
App IDcli_ 开头那串必填
App Secret凭证页第二行的长串必填
Domain留空默认就是飞书国内版
Encrypt Key / Verification Token留空只有 HTTP 回调模式才需要
PDF
把飞书接入 IRIS · 图文手册 24 页 · 7 个步骤 · 更新于 2026-10-29

内嵌预览加载不出来时,点右上角「新窗口打开」或「下载」查看原文件。

定时任务

用自然语言描述计划即可,调度器会解析成 cron 表达式并托管执行。

子代理与并行

长任务不必占用主对话。IRIS 可以派生出隔离子代理,各自带独立上下文并行推进,完成后只把结论交回主线。

# 让代理把三件事分给三个子代理同时做
请并行处理:拉取上周数据、生成图表、写一份周报草稿

需要极致节省上下文时,可以让代理写一段 Python 脚本,通过 RPC 直接调用工具,把整条多步流水线压进一轮。

插件

扩展能力优先做成插件,而不是往内核里加工具。一个插件是一个目录:

plugins/
└── my-tool/
    ├── plugin.yaml        # 元信息与依赖声明
    └── __init__.py        # register(ctx) 里注册工具

在 register(ctx) 中调用 ctx.register_tool(...) 即可把工具挂进工具集;插件也可以注册新的模型服务商、记忆后端或消息平台。启用后在桌面端「技能与工具」页可见。

CLI 参考

命令说明
weiagent进入交互式终端界面,开始对话
weiagent setup完整设置向导
weiagent model选择服务商与模型
weiagent tools配置启用的工具集
weiagent config set设置单个配置项
weiagent gateway启动消息网关(setup / start / status)
weiagent claw migrate从 OpenClaw 迁移配置
weiagent update更新到最新版本
weiagent doctor环境诊断,输出可直接贴进工单
hermes logs查看运行日志(网关、工具执行、错误堆栈)

常用斜杠命令

命令说明
/new /reset开始新对话
/model [provider:model]切换模型
/skills浏览与调用技能
/compress压缩上下文
/usage /insights用量与使用洞察
/retry /undo重试或撤销上一轮
/stop中断当前任务(消息平台)

排障

先跑一次诊断,大多数问题能直接定位:

$ weiagent doctor

更新日志

v1.0.0