💬
一套代码，多端运行
QQ、Discord、Telegram、飞书、钉钉、Slack、KOOK、邮件、GitHub……Adapter 抽象平台差异，插件逻辑可复用。
Zhin.js跨平台 IM 机器人框架
TypeScript 原生 · 插件热重载 · 20+ 平台一套代码 · 可选 AI Agent（<10MB IM 核心）
Skip to content
为什么选择 Zhin.js？
对标 Karin、Koishi、NapCatQQ 等成熟方案，Zhin.js 的文档与产品叙事同样遵循 先价值、后细节：
| 叙事层次 | 成熟产品常见做法 | Zhin.js 对应 |
|---|---|---|
| 首屏 | 一句话定位 + 主 CTA | 本页 Hero：跨平台框架 +「5 分钟上手」 |
| 第二屏 | 3～6 个利益点卡片 | 上方 Features：多端、热重载、体积、AI、Console、Harness |
| 第三屏 | 可复制的一条命令 | 下方「快速开始」代码块 |
| 深入阅读 | 分路径文档，不一次倾倒 | 学习路径 L1→L4 |
若你只想 先跑起来：跟 快速开始 走到底即可，不必先读架构。若你要 接 QQ / NapCat：见 平台适配器 与 生态。
快速开始
bash
npm create zhin-app my-bot -y
cd my-bot && pnpm dev启动后打开 console.zhin.dev，API Base 填 http://127.0.0.1:8086，Token 与 .env 中 HTTP_TOKEN 一致，在 Sandbox 发送 hello。
| 入口 | 适合谁 | 下一步 |
|---|---|---|
| demo.zhin.dev | 零安装体验 | 直接发 hello / card |
npm create zhin-app | 独立项目 | 5 分钟首跑 |
| minimal-bot | 贡献者调试 | monorepo 内 pnpm dev |
三步上手
1 · 创建
脚手架生成 IM-only 黄金路径：Sandbox + Host API + Remote Console，默认不要求 云模型 Key。
2 · 连接 Console
Host 监听 8086（仅 API，无内置网页 UI）。Remote Console 负责聊天预览与配置。
3 · 发出第一条消息
Sandbox 发送 hello 收到回复即成功；再试 card 查看 JSX 卡片示例。
10 行代码，一个能用的机器人
typescript
import { usePlugin, MessageCommand } from 'zhin.js'
const { addCommand } = usePlugin()
addCommand(
new MessageCommand('hello').desc('打招呼').action(() => '你好！我是 Zhin.js 机器人 🤖'),
)保存后热重载生效。在 Sandbox 或已接入的平台发送 hello 即可收到回复。完整插件流程见 插件开发。
专为开发者打造
| 说明 | 文档 | |
|---|---|---|
| TypeScript 原生 | 命令参数、Adapter、AI 工具有完整类型提示 | 核心概念 |
| 消息链路单一出口 | 出站统一经 Message.$reply / Adapter.sendMessage | 消息如何流转 |
| 分层安装 | IM / AI / Provider / MCP 分档，控制 node_modules 体积 | Install tiers |
| 可观测与排错 | zhin doctor、内容链 stage 日志、L4 验收脚本 | 疑难排查 |