快速开始
本页帮助你从安装到运行第一个有用的 pi 会话。
安装
Pi 作为 npm 包分发：
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts 在安装时禁用依赖的生命周期脚本。Pi 不需要安装脚本即可进行正常的 npm 安装。
卸载
使用安装 pi 的包管理器。curl 安装器使用 npm 全局安装，所以 curl 和 npm 安装可通过 npm 卸载：
# curl 安装器或 npm install -g
npm uninstall -g @earendil-works/pi-coding-agent
# pnpm
pnpm remove -g @earendil-works/pi-coding-agent
# Yarn
yarn global remove @earendil-works/pi-coding-agent
# Bun
bun uninstall -g @earendil-works/pi-coding-agent卸载 pi 会保留设置、凭据、会话和安装的 pi 包在 ~/.pi/agent/ 中。
然后在你想让 pi 工作的项目目录中启动它：
cd /path/to/project
pi身份验证
Pi 可以通过 /login 使用订阅制提供商，或通过环境变量或 auth 文件使用 API 密钥提供商。
选项 1：订阅登录
启动 pi 并运行：
/login然后选择提供商。内置的订阅登录包括 Claude Pro/Max、ChatGPT Plus/Pro (Codex) 和 GitHub Copilot。
选项 2：API 密钥
在启动 pi 之前设置 API 密钥：
export ANTHROPIC_API_KEY=sk-ant-...
pi你也可以运行 /login 并选择 API 密钥提供商，将密钥存储在 ~/.pi/agent/auth.json 中。
有关所有支持的提供商、环境变量和云提供商设置，请参见 提供商。
首次会话
一旦 pi 启动，键入请求并按回车：
Summarize this repository and tell me how to run its checks.默认情况下，pi 会给模型四个工具：
read- 读取文件write- 创建或覆盖文件edit- 修补文件bash- 运行 Shell 命令
额外的内置只读工具（grep、find、ls）可通过工具选项访问。Pi 在你的当前工作目录中运行，并可以修改那里的文件。如果你想轻松回滚，请使用 git 或其他检查点工作流。
给 Pi 项目指令
Pi 在启动时加载上下文文件。添加一个 AGENTS.md 文件来告诉它如何在项目中工作：
# 项目指令
- 代码更改后运行 `npm run check`。
- 不要本地运行生产迁移。
- 保持回复简洁。Pi 加载：
~/.pi/agent/AGENTS.md用于全局指令- 来自父目录和当前目录的
AGENTS.md或CLAUDE.md
更改上下文文件后，重启 pi 或运行 /reload。
常见尝试
引用文件
在编辑器中键入 @ 可模糊搜索文件，或在命令行传递文件：
pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"图像可以通过 Ctrl+V（Windows 上 Alt+V）粘贴，或拖入支持的终端。
运行 Shell 命令
在交互式模式下：
!npm run lint命令输出会发送给模型。使用 !!command 运行命令而不将其输出添加到模型上下文。
切换模型
使用 /model 或 Ctrl+L 选择模型。使用 Shift+Tab 循环思考级别。使用 Ctrl+P / Shift+Ctrl+P 循环通过范围模型。
稍后继续
会话会自动保存：
pi -c # 继续最近的会话
pi -r # 浏览以前的会话
pi --session <path|id> # 打开特定会话在 Pi 内部，使用 /resume、/new、/tree、/fork 和 /clone 来管理会话。
非交互式模式
用于一次性提示：
pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"使用 --mode json 输出 JSON 事件，或使用 --mode rpc 进行进程集成。