现在位置: 首页 > Pi Agent > 正文

Pi Agent 安装

本章介绍如何在不同平台上安装 Pi Agent,并完成基础环境配置。


环境要求

在安装 Pi Agent 之前,请确保你的系统满足以下要求:

依赖项最低版本说明
Node.js建议 18 LTS 或更高Pi Agent 基于 Node.js 运行,需要支持现代 JavaScript 特性的运行环境
npm随 Node.js 自带用于安装 Pi Agent 和扩展包
终端支持 True Color推荐 iTerm2(macOS)、Windows Terminal、Kitty、WezTerm

检查 Node.js 是否已安装:

$ node --version
v20.11.0

$ npm --version
10.2.4

如果你的 Node.js 版本低于 18,请先升级。可以使用 nvm(Node Version Manager)来管理多个 Node.js 版本。


安装方式一:npm 全局安装(推荐)

这是最通用、最简单的安装方式,适用于 macOS、Linux 和 Windows:

# 全局安装 Pi Agent
# --ignore-scripts 禁用依赖包的生命周期脚本,提高安装安全性
npm install -g --ignore-scripts @earendil-works/pi-coding-agent

# 安装完成后验证版本
pi --version

安装完成后,pi 命令就可以在终端中直接使用了。


安装方式二:curl 一键脚本

在 Linux 或 macOS 上,也可以使用官方安装脚本:

# 使用 curl 下载并执行安装脚本
curl -fsSL https://pi.dev/install.sh | sh

这个脚本会自动检测你的系统并完成安装,本质也是通过 npm 全局安装。


安装方式三:其他包管理器

如果你使用 pnpm、Yarn 或 Bun,也可以用对应的命令安装:

# 使用 pnpm 安装
pnpm add -g @earendil-works/pi-coding-agent

# 使用 Yarn 安装
yarn global add @earendil-works/pi-coding-agent

# 使用 Bun 安装
bun install -g @earendil-works/pi-coding-agent

卸载方法

卸载 Pi Agent 时,请使用与你安装时相同的包管理器:

# npm 或 curl 安装的用 npm 卸载
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 Agent 不会删除你的配置、凭证和会话记录。这些数据保存在 ~/.pi/agent/ 目录中。如需彻底清除,可以手动删除该目录。


终端建议

Pi Agent 使用 24 位 RGB 色彩渲染终端界面,推荐使用以下终端以获得最佳体验:

平台推荐终端说明
macOSiTerm2、Kitty、Warp原生支持 True Color,内嵌图片显示效果好
WindowsWindows Terminal、WezTermWindows Terminal 是官方推荐的现代终端
LinuxKitty、WezTerm、Alacritty都支持 True Color 和 GPU 加速

检查你的终端是否支持 True Color:

$ echo $COLORTERM
truecolor

如果输出是 truecolor24bit,说明你的终端支持完整的色彩渲染。


首次运行

安装完成后,进入一个项目目录并启动 Pi Agent:

$ cd /path/to/your-project
$ pi

首次启动时,你会看到 Pi Agent 的欢迎界面。

此时还没有配置 AI 提供商,你需要先完成认证——这将在下一章详细说明。

Pi Agent 在启动时会以当前工作目录(cwd)作为项目根目录。它对目录中的文件拥有读写权限,建议在 git 版本控制下使用,方便随时回滚修改。


更新 Pi Agent

保持 Pi Agent 更新到最新版本:

# 仅更新 Pi Agent 本身
pi update --self

# 更新 Pi Agent 和所有已安装的扩展包
pi update --all

# 更新模型目录(获取最新的可用模型列表)
pi update --models

使用 --self --force 可以强制重装 Pi Agent,即使当前已是最新版本:

$ pi update --self --force