$ npm create zhin-app my-bot -y && cd my-bot && pnpm dev
✔ Bot 已启动 —— 打开 http://127.0.0.1:8068/sandbox 立即开聊(无需平台账号或模型 Key)无需先读完整套架构。挑一个眼下的目标,每条路径都能在一次会话内走完。
不需要平台账号和模型 Key,在本地 /sandbox 或 Remote Console 收到第一条回复。
10 分钟快速开始 STEP 2 · BUILD编写命令、卡片与 AI 工具命令、跨平台 JSX 按钮卡片、中间件、定时任务、AI 工具——放进约定目录即刻热重载生效。
进入插件开发 STEP 3 · SHIP接入真实平台并上线用 npx zhin setup --adapters 接入 QQ / 微信 / 飞书 / Discord 等平台,完成生产部署。
选择平台适配器 NO-CODE · OPERATE运营与群主(无代码)在浏览器 Console 里收发消息、表单化改配置、配置群欢迎与提醒、审批高风险动作。
打开运营指南QQ、微信、企业微信、钉钉、飞书、Discord、Telegram、Slack、KOOK、LINE……业务代码只面对一种统一消息,平台差异交给适配器。
commands/hello/index.ts 就是 /hello 命令。中间件、组件、定时任务、AI 工具同理,不用手写注册代码。
保存即热重载;正在处理的消息用旧版本跑完,新代码报错时旧版本继续服务,Bot 不会因为一次手滑而掉线。
内置 Sandbox 模拟聊天窗口,不用申请任何平台账号或模型 Key,就能完整开发和测试。
打开 console.zhin.dev 填入地址和 Token:发测试消息、看日志、改配置、管插件,无需部署前端。
默认只有不到 10MB 的 IM 核心。运行 npx zhin setup --ai 即可接入大模型、工具、记忆与 MCP。
文件即命令 + 跨平台 JSX 互动卡片(commands/poll/index.tsx):支持按钮的平台渲染原生按钮,纯文本平台自动降级为数字选项。
import { defineCommand } from 'zhin.js/command';
export default defineCommand({
description: '发起快速投票',
params: { topic: { type: 'text', default: '今天发版吗?' } },
execute: ({ params }) => (
<card title={`📊 ${params.topic}`}>
<text>点击按钮(或回复对应序号):</text>
<button label="👍 赞成" onClick={(m) => `${m.$sender.name} 投了赞成`} />
<button label="🤔 再议" onClick={(m) => `${m.$sender.name} 投了再议`} />
</card>
),
});约定目录自动发现:无需手写注册样板,保存文件即热重载。
my-bot/
├── plugin.ts # Root 插件入口:definePlugin()
├── commands/poll/index.tsx # /poll 命令(自动发现)
├── middlewares/… # 每条消息经过的拦截器
├── tools/weather/index.ts # 给 AI 调用的工具(可选)
└── zhin.config.yml # configVersion: 2(插件与平台配置)3 步跑通本地开发(无需任何平台账号或模型 Key):
npm create zhin-app my-bot -y
cd my-bot && pnpm devhttp://127.0.0.1:8068/sandbox 发送 /hellohttp://127.0.0.1:8068 与 .env 中的 HTTP_TOKENcommands/ 下的文件并保存,无需重启即刻生效接下来读哪里