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 密钥设置。
- llama.cpp - 运行本地路由器并使用
/llama. - 安全 - 项目信任、沙箱边界和漏洞报告。
- 容器化 - 使用 Gondolin、Docker 或 OpenShell 对 pi 进行沙箱化。
- 设置 - 全局和项目设置。
- 按键绑定 - 默认快捷键和自定义按键绑定。
- 会话 - 会话管理、分支和树导航。
- 压缩 - 上下文压缩和分支摘要。
自定义
- 扩展 - 用于工具、命令、事件和自定义 UI 的 TypeScript 模块。
- 技能 - 用于可重用按需能力的智能体技能。
- 提示词模板 - 可从斜杠命令展开的可重用提示词。
- 主题 - 内置和自定义终端主题。
- Pi 包 - 打包和共享扩展、技能、提示词和主题。
- 自定义模型 - 为支持的提供商 API 添加模型条目。
- 自定义提供商 - 实现自定义 API 和 OAuth 流程。
编程式使用
- SDK - 在 Node.js 应用程序中嵌入 pi。
- RPC 模式 - 通过 stdin/stdout JSONL 进行集成。
- JSON 事件流模式 - 带有结构化事件的打印模式。
- TUI 组件 - 为扩展构建自定义终端 UI。
参考
平台设置
开发
- 开发 - 本地设置、项目结构和调试。