Pi
Pi 是一个极简的终端编码工具框架。它的核心设计保持精简，同时可通过 TypeScript 扩展、技能、提示模板、主题和 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
要卸载 pi 本身，对于 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 之前设置 API 密钥，例如 ANTHROPIC_API_KEY。
完整的首次运行流程请参阅快速入门。
从这里开始
- 快速入门 - 安装、身份验证并运行第一次会话。
- 使用 Pi - 交互模式、斜杠命令、上下文文件和 CLI 参考。
- 提供商 - 内置提供商的订阅和 API 密钥设置。
- 安全 - 项目信任、沙箱边界和漏洞报告。
- 容器化 - 使用 Gondolin、Docker 或 OpenShell 对 pi 进行沙箱化。
- 设置 - 全局和项目设置。
- 快捷键 - 默认快捷键和自定义快捷键。
- 会话 - 会话管理、分支和树形导航。
- 压缩 - 上下文压缩和分支摘要。
自定义
- 扩展 - 用于工具、命令、事件和自定义 UI 的 TypeScript 模块。
- 技能 - 用于可复用按需能力的 Agent Skills。
- 提示模板 - 可从斜杠命令展开的可复用提示。
- 主题 - 内置和自定义终端主题。
- Pi 包 - 打包并分享扩展、技能、提示和主题。
- 自定义模型 - 为受支持的提供商 API 添加模型条目。
- 自定义提供商 - 实现自定义 API 和 OAuth 流程。
编程式用法
- SDK - 在 Node.js 应用程序中嵌入 pi。
- RPC 模式 - 通过 stdin/stdout JSONL 集成。
- JSON 事件流模式 - 带结构化事件的 print 模式。
- TUI 组件 - 为扩展构建自定义终端 UI。
参考
- 会话格式 - JSONL 会话文件格式、条目类型和 SessionManager API。
平台设置
开发
- 开发 - 本地设置、项目结构和调试。