Skip to content

生态与资源

本页汇总 部署入口、平台适配、插件与社区资源,叙事方式对齐成熟 IM 框架文档:首页讲价值,本页讲「接什么、去哪找」。

三种运行入口

入口说明链接
在线 Sandbox零安装,浏览器内发消息demo.zhin.dev
项目脚手架独立仓库,pnpm dev 本地 Hostnpm create zhin-app -y · 快速开始
Monorepo 示例贡献者与深度调试minimal-bot(Stable)· test-bot(厨房水槽)

平台适配器

Zhin 通过 Adapter + Endpoint 连接各 IM 平台。与 NapCatQQ 等协议端配合时,通常流程为:

  1. 部署协议端(如 NapCat / OneBot)或使用官方 Bot API
  2. npx zhin install @zhin.js/adapter-* 安装适配器
  3. npx zhin setup --adapters 写入 zhin.config.yml
档位含义索引
Stable首跑与 CI 默认路径Sandbox
Advanced常用生产平台适配器目录
Experimental需自行验证部署差异同目录 Experimental 区

框架级概念(多 Endpoint、capabilities)见 适配器概览

插件与扩展

类型说明
插件市场官方与社区插件浏览、搜索
安装插件zhin install 与配置启用
插件开发从脚手架到测试、发布

服务类插件(数据库、Host 等)位于 monorepo plugins/services/,适配器位于 plugins/adapters/

Console 与 Host

组件作用
Host API本地 :8086,管理 bot、插件、Console 协议
Remote Consoleconsole.zhin.dev 连接 Host,Sandbox 聊天与配置
Host 栈概览router / api / mcp 分工

AI 与 Agent(可选)

档位安装文档
IM 核心zhin.js快速开始
AI 栈+ @zhin.js/agent zod aiAI 模块
Provider+ @ai-sdk/*配置向导
MCP+ @modelcontextprotocol/sdkMCP 集成

分档表 SSOT:Install tiers

学习路径

不必一次读完所有文档:

  1. L1快速开始消息流转
  2. L2插件开发命令
  3. L3架构概览AI 模块
  4. L4Agent Mesh · full-bot 示例 · 五角色群协作(高级)

详见 学习路径

社区与源码