快速入门
本页面将引导你从安装到完成第一个有用的 pi 会话。
安装
Pi 以 npm 包的形式分发：
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts 在安装过程中禁用依赖项生命周期脚本。Pi 在正常的 npm 安装中不需要安装脚本。
卸载
使用安装 pi 的包管理器。curl 安装程序会全局使用 npm，因此 curl 和 npm 安装都可以通过 npm 卸载：
# curl installer or 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 工作的项目目录中启动 pi：
cd /path/to/project
pi认证
Pi 可以通过 /login使用订阅提供商，或者通过环境变量或认证文件使用 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 启动，输入请求并按 Enter 键：
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 文件来告诉它如何在项目中工作：
# Project Instructions
- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.Pi 加载：
~/.pi/agent/AGENTS.md用于全局指令AGENTS.md或CLAUDE.md来自父目录和当前目录
如果目录包含 AGENTS.override.md，Pi 会加载它，而不是 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 # Continue most recent session
pi -r # Browse previous sessions
pi --name "my task" # Set session display name at startup
pi --session <path|id> # Open a specific session在 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 进行进程集成。