概述

Pi 是一个极简的终端编码工具。它保持核心最小化，通过 TypeScript 扩展、技能、提示模板、主题和 Pi 包进行扩展。

快速开始 Quick start

使用 npm 全局安装：

npm install -g --ignore-scripts @earendil-works/pi-coding-agent

--ignore-scripts 在安装时禁用依赖生命周期脚本，pi 的正常安装无需安装脚本。

Linux 或 macOS 也可使用安装脚本：

curl -fsSL https://pi.dev/install.sh | sh

卸载：

npm uninstall -g @earendil-works/pi-coding-agent

pnpm、Yarn 或 Bun 安装的使用对应命令：pnpm remove -g、yarn global remove、bun uninstall -g。

安装后在项目目录中运行：

pi

使用 /login 通过订阅提供商认证，或在启动前设置 API Key（如 ANTHROPIC_API_KEY）。

首次运行的完整流程请参见快速开始。

从这里开始 Start here

• 快速开始 Quickstart — 安装、认证、首次运行
• 使用 Pi Using Pi — 交互模式、斜杠命令、上下文文件、CLI 参考
• 提供商 Providers — 内置提供商的订阅和 API Key 设置
• 安全 Security — 项目信任、沙箱边界、漏洞报告
• 容器化 Containerization — 使用 Gondolin、Docker 或 OpenShell 沙箱化 pi
• 设置 Settings — 全局和项目设置
• 快捷键 Keybindings — 默认快捷键和自定义绑定
• 会话 Sessions — 会话管理、分支、树导航
• 上下文压缩 Compaction — 上下文压缩和分支摘要

自定义 Customization

• 扩展 Extensions — TypeScript 模块：工具、命令、事件、自定义 UI
• 技能 Skills — Agent Skills 标准：可复用的按需能力
• 提示模板 Prompt Templates — 通过斜杠命令展开的复用提示
• 主题 Themes — 内置和自定义终端主题
• Pi 包 Pi Packages — 打包分享扩展、技能、提示、主题
• 自定义模型 Custom Models — 为支持的提供商 API 添加模型
• 自定义提供商 Custom Providers — 实现自定义 API 和 OAuth 流程

编程使用 Programmatic Usage

• SDK — 在 Node.js 应用中嵌入 pi
• RPC 模式 RPC Mode — 通过 stdin/stdout JSONL 集成
• JSON 事件流模式 JSON Event Stream Mode — 带结构化事件的打印模式
• TUI 组件 TUI Components — 为扩展构建自定义终端 UI

参考 Reference

• 会话格式 Session Format — JSONL 会话文件格式、条目类型、SessionManager API

平台设置 Platform Setup

• Windows
• Termux
• tmux
• 终端设置 Terminal Setup
• Shell 别名 Shell Aliases

开发 Development

• 开发 Development — 本地环境、项目结构、调试