#Pi 文档

本页面是 Pi 官方文档 的中文翻译。仅供学习参考。

Pi 是一个极简的终端编码助手。它的核心设计保持轻量，同时通过 TypeScript 扩展、技能（Skills）、提示模板（Prompt Templates）、主题和 Pi 软件包进行扩展。

#快速开始

在 Linux 或 macOS 上，可以通过 curl 安装 Pi：

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

或者通过 npm：

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

然后在项目目录中运行：

pi

使用 /login 进行订阅提供商认证，或者设置 API Key（如 ANTHROPIC_API_KEY）后再启动 Pi。完整的新手流程请参阅 Quickstart。

#从这里开始

• Quickstart — 安装、认证并运行第一个会话。
• Using Pi — 交互模式、斜杠命令、上下文文件和 CLI 参考。
• Providers — 内置提供商的订阅和 API Key 设置。
• Settings — 全局和项目级配置。
• Keybindings — 默认快捷键和自定义按键绑定。
• Sessions — 会话管理、分支和树形导航。
• Compaction — 上下文压缩和分支摘要。

#自定义

• Extensions — TypeScript 模块：工具、命令、事件和自定义 UI。
• Skills — 可复用的按需能力（Agent Skills）。
• Prompt Templates — 可通过斜杠命令展开的可复用提示。
• Themes — 内置和自定义终端主题。
• Pi Packages — 打包和分享扩展、技能、提示和主题。
• Custom Models — 为支持的提供商 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。

#平台设置

• Windows
• Termux on Android
• tmux
• Terminal Setup
• Shell Aliases

#开发

• Development — 本地设置、项目结构和调试。

法律声明：本页面是 pi.dev 官方文档的中文翻译版本，仅供学习参考。本网站与 pi.dev 及 Earendil Inc. 无任何法律关系。