Skip to content

Zhin.js 是什么?

一句话:Zhin.js 是用 TypeScript 编写跨平台 IM 机器人的框架;可选叠加 AI Agent 做自然语言对话与工具调用。

若你熟悉 Koishi 的「插件 + 多平台」或 Karin 的「几行代码起 bot」,可以把 Zhin 理解为:TypeScript 优先、出站链路统一、IM 核心可单独安装(<10MB) 的同类方案,并内置可选 Agent 编排与安全 Harness。

能做什么?

场景你会用到
多平台客服 / 群管一套插件逻辑,QQ、Discord、Telegram 等同跑
AI 助手@zhin.js/agent + Provider,多轮对话与工具
运维通知Webhook、邮件、GitHub 等 Endpoint
本地调试Sandbox + Remote Console,无需先接真机

产品边界:面向生活/工作类 IM 助手,不是 Cursor / Claude Code 类 coding agent。见 能力分档

核心概念(30 秒)

Adapter(平台协议) → Endpoint(账号实例) → Plugin(你的功能)
入站消息 → Dispatcher → 命令 / AI → 统一出站链路 → 平台
  • PluginusePlugin() 注册命令、中间件、工具(须在文件顶层调用)
  • Endpoint:一个 QQ 号、一个 Discord Bot、一个 Sandbox 会话
  • ZhinAgent(可选):在入站消息上跑大模型与工具

一页展开:核心概念速查

和常见方案对比

Zhin.jsKoishi从零写 SDK
语言TypeScript 原生以 JS 为主,支持 TS自定
多平台20+ Adapter,统一 Message API生态以 QQ 为主,平台丰富每平台一套
AI可选 @zhin.js/agent,编排 + Harness靠插件组合自研
热重载插件/配置保存即加载支持自研
安装体积IM 核心 <10MB(4.x 分档)视插件而定

协议端(如 NapCatQQ)的关系:NapCat 提供 QQ 协议能力;Zhin 通过 @zhin.js/adapter-napcat 等适配器接入,上层仍写 Zhin 插件与命令。

两个安装层级

层级约体积能力
IM 核心zhin.js<10 MB多平台、命令、插件、热重载
+ AI@zhin.js/agent+约 12–15 MBAgent、会话、工具、压缩

详见 Install tiersADR 0019

建议阅读顺序

先跑起来,再加深

  1. 快速开始 — 5 分钟 Sandbox 首跑
  2. 消息如何流转 — 弄清入站/出站
  3. 插件开发 — 写自己的功能
  4. 学习路径 — 按 L1–L4 选读

完整资源索引:生态与资源