Pi 文档
Pi 是最小的端子编码线束。它的设计目的是保持核心较小，同时通过 TypeScript 扩展、技能、prompt templates、主题和 pi 包进行扩展。
快速启动
安装 Pi 和 npm：
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 本身，请使用 npm 进行curl 并使用 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对subscription providers进行身份验证，或者在启动pi之前设置API key，例如ANTHROPIC_API_KEY。
有关完整的首次运行流程，请参阅Quickstart。
从这里开始
- Quickstart - 安装、验证并运行第一个会话。
- Using Pi - 交互模式、slash commands、context files 和 CLI 参考。
- Providers - 内置提供商的订阅和API密钥设置。
- llama.cpp - 运行本地路由器并使用
/llama管理模型。
- Security - 项目信任、sandbox 边界和漏洞报告。
- Containerization - sandbox pi 与 Gondolin、Docker 或 OpenShell。
- Settings - 全局和项目设置。
- Keybindings - 默认快捷键和自定义按键绑定。
- Sessions - 会话管理、分支和树导航。
- Compaction - context compaction 和 branch summarization。
定制化
- Extensions - TypeScript 工具、命令、事件和自定义 UI 模块。
- Skills - 代理Skills，用于可重用的按需功能。
- Prompt templates - 从 slash commands 扩展的可重复使用的提示。
- Themes - 内置和自定义terminal themes。
- Pi packages - 捆绑并共享扩展、技能、提示和主题。
- Custom models - 为支持的提供者APIs 添加模型条目。
- Custom providers - 实现自定义 API 和 OAuth 流程。
程序化使用
- SDK - 将 pi 嵌入到 Node.js 应用程序中。
- RPC mode - 对 stdin/stdout JSONL 进行积分。
- JSON event stream mode - 具有结构化事件的打印模式。
- TUI components - 为扩展构建自定义终端 UI。
参考
- Environment variables - Pi bash 工具可用的流程配置和会话元数据。
- Session format - JSONL 会话文件格式、条目类型和 SessionManager API。
平台设置
开发
- Development - 本地设置、项目结构和调试。
/llama管理模型。