📊 页面导航

适用角色与上手难度

角色推荐度上手难度
🛠️ 开发★★★★★★☆☆☆☆
🧪 测试★★★★☆★☆☆☆☆
📦 产品★★★★☆★☆☆☆☆

🎯 学习产出: 掌握 Pi 的安装、认证和基本使用流程,能快速开始第一次编程对话

🚀 AI 能力提升: 代码生成、上下文管理

快速开始

预计阅读时间: 4 分钟

5 分钟内完成 Pi 的安装和首次使用。

安装

通过 npm 全局安装(--ignore-scripts 跳过依赖生命周期脚本,正常安装无需安装脚本):

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

或者使用官方安装脚本:

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

认证

Pi 支持两种认证方式:

方式一:环境变量 API Key

export ANTHROPIC_API_KEY=sk-ant-...
pi

方式二:登录订阅

pi
/login   # 然后选择 provider

登录后可以用 /model(或 Ctrl+L)在 provider 的模型列表中切换模型。

第一次对话

在任意项目目录下启动:

cd your-project
pi

Pi 默认给模型四个工具:readwriteeditbash,模型会用它来完成任务。试试这些操作:

1. 了解项目

> 这个项目是做什么的?帮我总结一下代码结构

2. 修改代码

> 在 src/utils.ts 中添加一个 formatDate 函数,将 Date 对象格式化为 YYYY-MM-DD 字符串

3. 运行命令

> 运行项目的测试,如果有失败的帮我修复

4. Git 操作

> 把今天的改动提交一下,用英文写 commit message

四种运行模式

模式说明示例
交互式(默认)终端里对话,编辑、斜杠命令全功能pi
打印模式 -p处理完提示后输出并退出pi -p "explain this function"
JSON 模式 --mode json所有事件按 JSON 行输出,适合脚本集成pi --mode json -p "hello"
RPC 模式 --mode rpc面向进程集成的 RPC 协议pi --mode rpc

打印模式下会读取管道输入并合并进初始提示:

cat README.md | pi -p "Summarize this text"

引用文件

@ 前缀把文件放进消息里:

pi @prompt.md "Answer this"
pi -p @screenshot.png "What's in this image?"
pi @code.ts @test.ts "Review these files"

在交互式编辑器里,直接输入 @ 会模糊搜索项目文件。

更新 Pi

pi update          # 只更新 pi 本身
pi update --all    # 更新 pi 和所有已安装的包
pi update --models # 强制刷新 provider 模型目录

下一步