QIM - 企业即时通讯系统 / Enterprise Instant Messaging

QIM (Quick Instant Messaging) / 青雀 — 一款面向企业的即时通讯解决方案。

QIM (Quick Instant Messaging) 是一款面向企业的即时通讯解决方案，基于 Vue 3 + Electron + Go 构建，支持 macOS、Windows、Linux 多平台运行。当前处于 v2.0 迭代阶段。

QIM 提供完整的即时通讯功能（单聊、群聊、讨论组、频道），集成了任务管理、日历、笔记、便签、文件管理等办公应用，深度整合 AI 能力（AI 助手、群聊助手、AI 分身与知识库），并配备独立的管理后台。同时对外提供 Bot / Webhook / QIM CLI / MCP Server 等生态接口，支持与外部 Agent 交互闭环。

QIM (Quick Instant Messaging) is an enterprise messaging solution built on Vue 3 + Electron + Go, running on macOS, Windows and Linux. It provides full IM features plus workplace apps (tasks, calendar, notes, sticky notes, files), deeply integrated AI capabilities, an admin console, and an open ecosystem (Bot, Webhook, CLI, MCP) for interoperation with external agents.

• 📝 文本消息 — URL 自动识别与链接转换 · Text with auto-link
• 🖼️ 图片消息 — 大图预览 · Images with preview
• 📎 文件消息 — 下载、另存 · Files
• 🔗 分享消息 — 笔记、便签、文件分享 · Shared content
• 📱 小程序卡片 · Mini-app cards
• 📰 资讯卡片 · Article cards
• 🤖 Bot 卡片 — 卡片动作、状态回写 · Bot cards (actions + state)

基于 Cloudwego Eino 框架，多模型适配，支持流式对话与「思考中」状态。

• 多模型支持 — OpenAI、Claude(Anthropic)、通义千问、文心一言、腾讯混元等多个大模型
• AI 助手 — 智能对话机器人，4xx 快速失败、合理重试
• 群聊 AI 助手 — 群级记忆（GroupMemoryService）、@ 触发、关键词门控、代管成员
• AI 分身 / Avatar — AI 生成虚拟形象、分身记忆、知识库（记忆+笔记）、触发决策、手动接管
• 知识库 — 向量检索（CortexDB / Gracedb），群文档、公共文档管理
• 智能摘要 — AI 自动生成消息摘要
• 智能搜索 — AI 驱动的语义搜索
• 群聊助手工具 — 便捷操作与工具调用

• Bot 消息闭环 — 外部 Agent ↔ QIM 用户消息互通，流式回复、卡片消息、卡片动作幂等、卡片状态回写
• Webhook — outbox 重试、死信兜底、投递监控、后台重投，支持纯 pull 模式
• QIM CLI — 登录、Token 自动续期、消息发送/流式 stdin、任务/事件创建、会话查询、JSON 输出、自动更新；跨平台、Makefile、服务端托管二进制
• MCP Server (qim-mcp) — 标准 MCP，stdio adapter + Streamable HTTP transport，对外暴露 IM 工具给 Claude/Cursor
• qim-landing — VitePress 官方落地页 / 文档站

• 🔑 JWT 认证 — 无状态安全认证
• 🔐 双因素认证（可选）· 登录日志 · 会话管理（置顶/免打扰/隐藏）
• 🛡️ 黑名单管理 — 违规用户封禁与恢复
• 🚫 敏感词过滤 · 权限校验 — 修复多处 IDOR、越权访问、敏感信息泄露风险
• 👥 组织权限 — 群文件空间 scope 隔离、集中式文件权限校验
• 🔐 密码安全 — 客户端记住密码用 Electron safeStorage 加密存储

现代化登录界面，支持记住密码（加密存储）、服务器地址配置

左侧边栏：最近联系人、组织架构、群聊、应用、频道；右侧主区域：会话列表与聊天窗口

打开会话后的聊天窗口：支持多种消息类型（文本、图片、文件、分享、引用回复），已读回执常驻

主要应用：文件箱、日历、任务管理、便签、笔记、智能助手、短链接管理

┌─────────────────────────────────────────────────────────────┐
│                         客户端 / Clients                     │
│  ┌─────────┐┌─────────┐┌─────────┐┌─────────┐┌──────────┐  │
│  │ macOS   ││Windows  ││ Linux   ││  Web    ││ QIM CLI  │  │
│  │Electron ││Electron ││Electron ││Admin/Web││/Bot/MCP  │  │
│  └────┬────┘└────┬────┘└────┬────┘└────┬────┘└────┬─────┘  │
└───────┼──────────┼──────────┼──────────┼──────────┼────────┘
        └──────────┴─────┬────┴────┬─────┴──────────┘
                         │         │
                  HTTP / WebSocket  (localhost:8080)
                         │         │
┌────────────────────────┼─────────┼──────────────────────────┐
│                      API Gateway (Gin)                      │
│  ┌────────────────────────────────────────────────────────┐ │
│  │  Auth · Message · User · Group · Channel · File · Note │ │
│  │  Calendar · Task · AI Tools · Bot · Admin · Document   │ │
│  └────────────────────────────────────────────────────────┘ │
│  ┌────────────────────────────────────────────────────────┐ │
│  │                    WebSocket Hub                        │ │
│  │                                                         │ │
│  └────────────────────────────────────────────────────────┘ │
│  ┌────────────────────────────────────────────────────────┐ │
│  │  AI (Eino) · Vector (CortexDB/Gracedb) · Agent Wrappers │ │
│  └────────────────────────────────────────────────────────┘ │
└────────────────────────────┬───────────────────────────────┘
                             │
                    ┌────────┴────────┐
                    │  SQLite / MySQL │
                    └─────────────────┘

qim/
├── qim-client/              # 桌面客户端（Vue 3 + Electron 42）+ Web 资源
│   ├── src/
│   │   ├── components/      # Vue 组件（apps/ chat/ layout/ shared/ ai/ avatar/）
│   │   ├── composables/     # 组合式函数（useUI 等）
│   │   ├── stores/          # Pinia 状态管理
│   │   ├── types/           # TypeScript 类型
│   │   └── utils/           # 工具函数（messageDisplay 等）
│   ├── electron/            # Electron 主进程（安全检查、自动更新、IPC 桥）
│   └── vite.config.ts       # Vite 配置 + manualChunks 分包
│
├── qim-admin/               # 管理后台（Web，构建产物输出到 qim-server/web/webroot/admin）
│   ├── src/{api,views,layouts,stores}/
│   └── vite.config.ts       # 含 /api 代理到 localhost:8080
│
├── qim-server/              # 后端（Go 1.25 + Gin + GORM）
│   ├── ai/                  # AI 服务（工具注册表、output filter）
│   ├── app/                 # 应用初始化（路由、DI 容器）
│   ├── cmd/
│   │   ├── qim/            # QIM CLI 命令行工具
│   │   └── qim-mcp/        # 标准 MCP Server（对外暴露 IM 工具）
│   ├── config/  database/  di/  handler/  middleware/  model/
│   ├── pkg/  repository/  service/  ws/  utils/  auth/
│   └── main.go             # 入口
│
├── qim-landing/             # 官方落地页 / 文档站（VitePress）
├── qim-integration-fixed/   # 集成示例
├── docs/                    # 项目文档（使用指南、MCP/CLI 接入、发布说明）
├── screenshots/             # README 截图
├── CLAUDE.md                # 开发指南
└── README.md

cd qim-server

# 复制配置示例文件
cp config.yaml.example config.yaml

# 编辑配置（默认使用 SQLite，如需 MySQL 修改 database.type）

go mod download
go run main.go        # 服务默认 8080 端口

服务将在 http://localhost:8080 启动，首次运行自动创建数据库和表。

cd qim-client
npm install
npm run dev           # Vite 开发服务器（默认 3000 端口）

cd qim-client
npm run electron:dev  # 同时启动 Vite + Electron

cd qim-admin
npm install
npm run dev           # 默认 3008 端口

cd qim-client
npm run build             # 构建 Web 资源
npm run electron:build    # 打包 Electron 跨平台安装包（electron-dist/）

客户端连接的后端地址默认 http://localhost:8080，可在登录界面修改。

想要更完整的操作步骤（含 AI 分身、群助手记忆/知识库、文件空间，以及 Bot/Webhook/CLI/MCP 对接）请查阅 详细使用手册。

1. 启动应用，输入用户名、密码
2. 可选：勾选「记住密码」（Electron 加密存储）下次自动登录
3. 点击「登录」进入主界面

单聊 / DM：

1. 左侧栏选择「组织架构」
2. 找到目标用户，双击或点击「发起私聊」
3. 在聊天窗口发送消息

群聊 / Group chat：

1. 点击左侧栏「+」按钮，选择「创建群聊」
2. 输入群名称，添加群成员（支持按组织架构选择）
3. 点击「创建」

• AI 助手：左侧栏「应用」→「AI 助手」，选择机器人对话
• 群聊 AI 助手：群聊中 @AI 触发、配置关键词门控，或由代管成员触发自动回复；支持群级记忆（自动提炼群共识）与群知识库（显式上传文档）
• AI 分身 / Avatar：创建虚拟形象，配置记忆与知识库（Notes/Tasks 开关）后与分身对话；支持多模型、触发决策、手动接管分身

1. 左侧栏选择「应用」
2. 选择统计报表、日历、笔记、便签、文件管理、任务管理、AI 助手等
3. 在右侧区域操作

• 个人文件空间：个人文件上传/下载/排序，消息中引用
• 群文件空间：群成员共享上传、下载，带集中式权限校验与 scope 隔离

1. 在笔记、便签或文件中找到要分享的内容
2. 点击「分享」，选择分享到的用户或群聊
3. 确认发送

以下功能面向开发者/集成方，完整用法见 详细使用手册：

• Bot / Webhook：external_webhook 模式把用户回复推送到你的回调地址，outbox 重试 + 死信兜底；管理后台「Bot 运维」可监控投递与手动重投
• QIM CLI：命令行收发消息、任务/日历/笔记、流式 stdin → CLI 使用指南
• MCP Server：stdio + Streamable HTTP，暴露 IM 工具给 Claude/Cursor → MCP 接入指南
• 外部 Agent 闭环：外部 Agent ↔ QIM 用户消息互通，卡片动作幂等 + 状态回写、纯 pull 模式

📖 终端使用 + 开发集成的完整操作指引见 详细使用手册。

database:
  type: sqlite        # 或 mysql
  path: ./qim.db      # SQLite 路径

  # MySQL 配置（type 为 mysql 时生效）
  host: localhost
  port: 3306
  username: root
  password: your_password
  database: qim_server

AI 配置分布在两处：

① 服务端配置文件 qim-server/config.yaml — 定义各任务类型的**模型路由（router）**与各厂商凭据：

ai:
  router:                    # 模型路由：任务类型 → 使用的 provider + model
    default_task: "chat"
    routes:
      chat:                  # 对话
        provider: "openai"
        model: "deepseek-v4-flash"
      intent_recognition:    # 意图识别
        provider: "openai"
        model: "deepseek-v4-flash"
      embedding:             # 向量化
        provider: "openai"
        model: "text-embedding-v4"
      # ... analysis / tool_calling / search / digest 等同理
  max_tokens: 1000
  temperature: 0.7
  openai:
    api_key: your_api_key
    model: gpt-4o
    base_url: https://api.openai.com/v1
  # anthropic / alibaba / baidu / tencent / deepseek 等厂商配置同理

⚠️ Router（ai.router 的任务→模型映射）目前只能通过 config.yaml 配置，管理后台暂未提供直接编辑路由器入口。

但管理后台 AI 配置 → AI 供应商（/v1/admin/ai/providers）可管理各厂商凭据（provider 类型、model、api_key、base_url、启停、优先级、测试连接）。DB 中启用的供应商会实时并入模型池（覆盖 config.yaml 的 pool），并支持 per-user 自定义 AI 配置（/ai/configs/my）。

前端默认连接 http://localhost:8080，可在登录界面点击「设置服务器地址」修改。

# 后端
cd qim-server && go test ./...

# 客户端单元测试
cd qim-client && npm run test:unit

# 客户端 E2E（Playwright）
cd qim-client && npm run test:e2e

# 管理后台
cd qim-admin && npm run test && npm run e2e

mysql -u root -p
CREATE DATABASE qim_server CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
USE qim_server;
SOURCE ddl_mysql.sql;

SQLite 数据库在首次运行时自动创建，无需手动建表。

从旧版 OIM 系统迁移数据：旧版数据库结构参考见仓库根目录 schema.sql，迁移脚本存档见 docs/archive/scripts/。

近期已落地 / Recent highlights：

• AI 助手、群聊 AI 助手（群级记忆、@ 触发、工具调用）
• AI 分身（记忆、知识库、触发决策、手动接管）
• 多模型支持 + 流式回复 + 智能摘要 + 语义搜索
• 外部 Agent 闭环（Bot / Webhook / CLI / MCP）
• 群文件空间 + 文件权限体系
• 频道富文本 Markdown / 审批机制
• 待办提醒、日历事件调度
• 分片上传恢复、群主保护、密码安全加固
• 深色模式、Twemoji 表情、FontAwesome 图标、无障碍
• 表情包商店
• 视频会议
• 企业微信 / 钉钉集成

1. 双因素认证后端验证为模拟实现，非生产级。
2. OAuth state 依赖进程内存，多实例部署或服务重启期间登录回调可能失败，需在部署方式下验证。

欢迎提交 Issue 和 Pull Request！

• huangqun@buaa.edu.cn
• gracegaoya@didiglobal.com

• Twemoji (© Twitter, Inc.) — 表情图片资产，采用 CC-BY 4.0 许可，解析器采用 MIT 许可。本项目自托管其 72×72 PNG 资产用于跨平台一致的表情渲染，详见 https://github.com/twitter/twemoji。

MIT License

• 项目主页: https://github.com/qim/im
• 问题反馈: https://github.com/qim/im/issues

QIM - 让沟通更简单，让协作更高效 / Simpler communication, smarter collaboration