README.md
Pi-Agent 深度教程
10 章拆解 pi-agent SDK 的源码设计与实现
📚 三种阅读方式
| 方式 | 入口 | 适合场景 |
|---|---|---|
| 🌐 Web 在线版(推荐) | https://dg-ai-notes.pages.dev | PC 端沉浸式阅读,三栏布局 + 配图联动 |
| 📥 Markdown 下载版 | docs/typescript/ · docs/python/ | 下载到本地,配合 AI 边读边问、对照源码 |
| 📕 PDF 版 | GitHub Releases | 离线阅读、打印、长期存档 |
🧪 补充材料:notebooks/agent-loop.ipynb 是第 3 章 Agent Loop 的可执行实验场,可以单步运行、改参数、观察 loop 状态。
本教程基于 Pi v0.80.2 编写。源码链接指向 earendil-works/pi main 分支,可能与 v0.80.2 有微小差异。
🗺️ 章节结构
ch01 开篇总览 → ch02 三层架构 → ch03 Agent Loop → ch04 模型调用 → ch05 工具系统
↓
ch06 消息系统 → ch07 事件驱动 → ch08 上下文工程 → ch09 上下文压缩 → ch10 会话管理
| 章节 | 主题 | TS 版 | Python 版 |
|---|---|---|---|
| ch01 | 开篇 - Pi-Agent 框架总览 | 📖 | 🐍 |
| ch02 | 三层架构 - 项目骨骼 | 📖 | 🐍 |
| ch03 | Agent Loop - 模型转动起来的引擎 | 📖 | 🐍 |
| ch04 | 模型调用 - 一行代码驾驭多模型 | 📖 | 🐍 |
| ch05 | 工具系统 - Agent 的手脚如何被管住 | 📖 | 🐍 |
| ch06 | 消息系统 - Agent 的记忆组织与传递 | 📖 | 🐍 |
| ch07 | 事件驱动 - Agent 的神经系统 | 📖 | 🐍 |
| ch08 | 上下文工程 - 让有限窗口装下无限对话 | 📖 | 🐍 |
| ch09 | 上下文压缩 - 当对话太长怎么办 | 📖 | 🐍 |
| ch10 | 会话管理 - 对话的存储恢复与分叉 | 📖 | 🐍 |
🚀 本地运行 web 电子书
cd web
npm install
npm run dev # http://localhost:4321
详细说明见 web/README.md。
📥 PDF 下载
PDF 版本不进 git 仓库(避免仓库膨胀),通过 GitHub Releases 分发:
- 进入 Releases 页面
- 下载对应版本:
pi-agent-book-ts.pdf— TypeScript 版(约 14MB)pi-agent-book-python.pdf— Python 版(约 16MB)
📜 License
- 代码:MIT
- 文档:CC-BY-SA-4.0