$ cat ~/map/pi-docs.md
Pi documentation (pi.dev)
Pi 官方网站与文档——安装、配置、扩展与主题指南。
officialtutorials
事实速查
- GitHub Stars
- —
- Forks
- —
- 许可证
- —
- npm / 月
- —
- 最后推送
- —
## 速览
pi.dev 上的官方文档——这部版本化文档覆盖极简终端编码 harness 的方方面面:从快速上手、provider、会话与设置,到扩展、技能、主题、包以及 SDK/RPC 等编程用法。
## 要点
- $pi 的权威文档,开篇即把 pi 描述为一个极简终端编码 harness——核心保持小巧,通过 TypeScript 扩展、技能、提示模板、主题与 pi 包向外扩展。
- $入门路线:Quickstart、Using Pi(斜杠命令、上下文文件、CLI)、Providers、llama.cpp、Security、Containerization、Settings、Keybindings、Sessions 与 Compaction。
- $定制路线覆盖 Extensions、Skills、Prompt templates、Themes、Pi packages、自定义模型与自定义 provider;编程用法部分讲解 Node.js SDK、基于 stdin/stdout JSONL 的 RPC 模式、JSON 事件流模式与 TUI 组件。
- $参考与平台部分:环境变量、JSONL 会话格式,以及 Windows、Android 上的 Termux、tmux、终端设置与 shell 别名——另有面向本地开发环境、项目结构与调试的 Development 章节。
- $每个主题都可在 /docs/latest/ 下深链访问(如 /docs/latest/quickstart、/docs/latest/extensions、/docs/latest/sessions);文档按版本管理,每页都链回 earendil-works/pi 仓库中对应的源文件,便于查看或编辑。
## 常见问题
Q 新用户该从哪里读起?
从 /docs/latest/quickstart 开始——安装、用 /login 或 API key 完成认证、试用四件默认工具;再看 Using Pi 掌握斜杠命令、上下文文件与 CLI。Providers 页面讲解每个内置 provider 的订阅与 API key 两种登录方式。
Q 文档覆盖编程用法吗?
覆盖。SDK 章节讲解在 Node.js 应用中嵌入 pi,另有专门章节讲解 RPC 模式(stdin/stdout JSONL)、JSON 事件流模式与可复用的 TUI 组件。
## 参考链接
## 相关条目
最后更新: 2026年8月31日