Pi 文档
本页面是 Pi 官方文档 的中文翻译。仅供学习参考。
Pi 是一个极简的终端编码助手。它的核心设计保持轻量，同时通过 TypeScript 扩展、Skill（技能）、Prompt 模板、主题和 Pi 软件包进行扩展。
快速开始
通过 npm 安装 Pi：
--ignore-scripts 在安装期间禁用依赖生命周期脚本。Pi 的正常 npm 安装不需要安装脚本。
在 Linux 或 macOS 上，也可以使用安装脚本：
卸载
要卸载 Pi 本身，curl 和 npm 安装均使用 npm：
对于 pnpm、Yarn 或 Bun 安装，使用对应的全局删除命令：
卸载 Pi 后，设置、凭据、会话和已安装的 Pi 包会保留在 ~/.pi/agent/ 中。
然后在项目目录中运行：
使用 /login 进行订阅 Provider 认证，或者设置 API Key（如 ANTHROPIC_API_KEY）后再启动 Pi。完整的首次运行流程请参阅 Quickstart。
从这里开始
- Quickstart — 安装、认证并运行第一个会话。
- Using Pi — 交互模式、斜杠命令、上下文文件和 CLI 参考。
- Providers — 内置 Provider 的订阅和 API Key 设置。
- 安全 — 项目信任、沙箱边界和安全漏洞报告。
- 容器化 — 使用 Gondolin、Docker 或 OpenShell 沙箱化 Pi。
- Settings — 全局和项目级配置。
- Keybindings — 默认快捷键和自定义快捷键。
- Sessions — 会话管理、分支和树形导航。
- Compaction — 上下文压缩和分支摘要。
自定义
- Extensions — TypeScript 模块：工具、命令、事件和自定义 UI。
- Skills — 可复用的按需能力（Agent Skills）。
- Prompt Templates — 可通过斜杠命令展开的可复用提示。
- Themes — 内置和自定义终端主题。
- Pi Packages — 打包和分享扩展、Skill、Prompt 和主题。
- Custom Models — 为支持的 Provider API 添加模型条目。
- Custom Providers — 实现自定义 API 和 OAuth 流程。
编程式使用
- SDK — 在 Node.js 应用中嵌入 Pi。
- RPC Mode — 通过 stdin/stdout JSONL 进行进程集成。
- JSON Event Stream Mode — 带结构化事件的输出模式。
- TUI Components — 为扩展构建自定义终端 UI。
参考
- Session Format — JSONL 会话文件格式、条目类型和 SessionManager API。
平台设置
开发
- Development — 本地设置、项目结构和调试。
法律声明：本页面是 pi.dev 官方文档的中文翻译版本，仅供学习参考。本网站与 pi.dev 及 Earendil Inc. 无任何法律关系。