基于 pi 0.84.4 官方文档(README 与 docs/)逐特性整理的系列笔记。 总览读《完整指南》,深入读各章;每章按"设计思想 / 原理 / 用法"三段展开。
文档结构
本目录包含两类文档:
| 文档 | 定位 |
|---|---|
| Pi Coding Agent 完整指南 | 独立总览文章:从安装、日常使用到 SDK 嵌入的完整速览 |
| 特性系列(第 1–9 章) | 每个特性一章,作为指南的展开与深耕 |
章节目录
- 第 1 章:交互模式——终端里的驾驶舱 TUI 四块布局、编辑器技巧、斜杠命令、快捷键、消息队列(steering / follow-up)
- 第 2 章:会话与树——把时间掰成分叉 JSONL 树结构、/tree /fork /clone、compaction 压缩、A/B 对比工作流
- 第 3 章:上下文文件——让项目自己开口说话 AGENTS.md / CLAUDE.md 加载顺序、override 覆盖、SYSTEM.md 替换与追加
- 第 4 章:提供商与模型——一个接口,百家模型 订阅与 API key 认证、模型切换、思考级别、models.json 自定义提供商
- 第 5 章:可定制化——模板、技能、扩展、主题与包 Prompt Templates、Skills、Extensions、Themes、Pi Packages 五层定制体系
- 第 6 章:编程方式——从 CLI 到 SDK 四种运行模式、SDK 核心类、RPC 协议、会话分支与事件订阅
- 第 7 章:设置与信任——画好边界再谈自由 settings 两层层叠、项目信任机制、遥测与离线开关
- 第 8 章:CLI 全参数速查 模式 / 模型 / 会话 / 工具 / 资源全量选项、环境变量速查表
- 第 9 章:设计哲学——为什么“不做”是特性 极简内核的取舍逻辑、插件体系如何替代内置功能
阅读顺序
完整指南(总览)
└─ 日常使用:第 1、2 章
└─ 项目适配:第 3、4 章
└─ 能力扩展:第 5、6 章
└─ 治理与理念:第 7、8、9 章
来源与时效
- 依据版本:pi 0.84.4(
@earendil-works/pi-coding-agent) - 官方文档:https://pi.dev/docs/latest 、npm 包内
docs/目录 - SDK / CLI 更新较快,API 细节以官方文档为准