本文为社区中文翻译（依据 MIT 协议），阅读英文原文 →。译文可能滞后于上游更新。
Pi 文档总览
快速开始
用 npm 安装 Pi：
npm install -g --ignore-scripts @earendil-works/pi-coding-agent
--ignore-scripts 会在安装期间禁用依赖的生命周期脚本。Pi 在正常的 npm 安装中不需要安装脚本。
在 Linux 或 macOS 上也可以使用安装脚本：
curl -fsSL https://pi.dev/install.sh | sh
如果通过 curl 或 npm 安装，用 npm 卸载：
npm uninstall -g @earendil-works/pi-coding-agent
pnpm、Yarn 或 Bun 安装的，用对应的卸载命令：pnpm remove -g @earendil-works/pi-coding-agent、yarn global remove @earendil-works/pi-coding-agent 或 bun uninstall -g @earendil-works/pi-coding-agent。
然后在项目目录里运行：
pi
用 /login 登录订阅类提供商，或在启动 Pi 之前设置好 ANTHROPIC_API_KEY 之类的 API Key。
完整的首次运行流程见快速上手。
从这里开始
- 快速上手 —— 安装、认证并完成第一次会话。
- 使用 Pi —— 交互模式、斜杠命令、上下文文件与 CLI 参考。
- 提供商 —— 内置提供商的订阅与 API Key 配置。
- llama.cpp —— 运行本地路由并用
/llama管理模型。 - 安全 —— 项目信任、沙箱边界与漏洞报告。
- 容器化 —— 用 Gondolin、Docker 或 OpenShell 隔离运行 Pi。
- 设置 —— 全局与项目级设置。
- 键位绑定 —— 默认快捷键与自定义键位。
- 会话 —— 会话管理、分支与树状导航。
- 压缩 —— 上下文压缩与分支摘要。
定制
- 扩展 —— 用 TypeScript 模块添加工具、命令、事件与自定义 UI。
- 技能 —— Agent Skills，可复用的按需能力。
- 提示词模板 —— 从斜杠命令展开的复用提示词。
- 主题 —— 内置与自定义终端主题。
- Pi 软件包 —— 打包并分享扩展、技能、提示词与主题。
- 自定义模型 —— 为受支持的提供商 API 添加模型条目。
- 自定义提供商 —— 实现自定义 API 与 OAuth 流程。
编程接入
- SDK —— 在 Node.js 应用中嵌入 Pi。
- RPC 模式 —— 通过 stdin/stdout JSONL 集成。
- JSON 事件流模式 —— 带结构化事件的打印模式。
- TUI 组件 —— 为扩展构建自定义终端 UI。
参考
平台设置
开发
- 开发指南 —— 本地搭建、项目结构与调试。