学习路径
L1 起点:先能跑起来,再按需加深。不必一次读完所有文档。
Zhin.js 文档按三条跑道组织,对应不同目标。
L1 — 能用
目标:安装、配置、让机器人收到消息并回复。
建议阅读顺序:
- 快速开始 / 安装与启动
- 配置文件
- 任选:Remote Console(管理 bot 与 Sandbox)
- 任选:消息如何流转(一页弄清「消息从哪来到哪去」)
这一阶段不必了解:@zhin.js/kernel、AsyncLocalStorage 出站上下文、PluginBase、双轨路由细节。
L2 — 会写业务插件
目标:用 usePlugin 加命令、简单处理消息、读配置。
在 L1 基础上继续:
可选:
L3 — 扩展与贡献
目标:理解全链路、AI 与工具、适配器/仓库结构,向社区贡献。
推荐阅读:
术语速查:术语表
L3+ — AI 与 MCP 进阶
目标:在跑通 Stable 路径后,理解 Agent 编排、接入 MCP、启用 Advanced 能力。
建议在 L3 之前或并行阅读(概念优先于配置细节):
验证环境:examples/test-bot(厨房水槽,非默认模板)。
L4 — 全维度参考
目标:在 Stable 之上验收硬编排、语义记忆、MCP Agent Mesh、多适配器(Sandbox + NapCat + KOOK)。
建议阅读:
- Agent Mesh 硬编排
- MCP 集成
- examples/full-bot README 与 ACCEPTANCE.md
验证:pnpm check:l4(仓库根);Stable 仍用 pnpm check:stable(仅 minimal-bot)。
进阶路径:Stable(minimal-bot)→ L4(full-bot)→ 厨房水槽(test-bot)。
我现在该读哪篇?
仓库内给 AI/自动化代理的速查表见根目录 AGENTS.md(维护者向,可与 L3 对照阅读)。