Skip to content

学习路径

L1 起点:先能跑起来,再按需加深。不必一次读完所有文档。

Zhin.js 文档按三条跑道组织,对应不同目标。

L1 — 能用

目标:安装、配置、让机器人收到消息并回复。

建议阅读顺序

  1. 快速开始 / 安装与启动
  2. 配置文件
  3. 任选:消息如何流转(一页弄清「消息从哪来到哪去」)

这一阶段不必了解@zhin.js/kernelAsyncLocalStorage 出站上下文、PluginBase、双轨路由细节。

L2 — 会写业务插件

目标:用 usePlugin 加命令、简单处理消息、读配置。

在 L1 基础上继续

  1. 核心概念(插件、命令)
  2. 命令系统
  3. 插件系统

可选

L3 — 扩展与贡献

目标:理解全链路、AI 与工具、适配器/仓库结构,向社区贡献。

推荐阅读

  1. 架构概览
  2. 消息如何流转(与源码、AGENTS.md 对齐)
  3. AI 模块
  4. 工具与技能
  5. 贡献指南仓库结构与模块化约定

术语速查术语表

我现在该读哪篇?

仓库内给 AI/自动化代理的速查表见根目录 AGENTS.md(维护者向,可与 L3 对照阅读)。

基于 MIT 许可发布