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

Pi Agent CLI 参考手册

以下是 Pi Agent 常用命令行参数的参考。


模式选项

以下参数控制 Pi Agent 的运行模式,不指定时默认进入交互界面。

参数说明示例
(默认)交互模式,终端 TUI 界面pi
-p, --printPrint 模式,输出结果后退出pi -p "总结代码"
--mode jsonJSON 模式,所有事件以 JSON 行输出pi --mode json -p "总结"
--mode rpcRPC 模式,stdin/stdout JSONL 协议pi --mode rpc
--export <输入> [输出]导出会话为 HTML,输出路径可省略pi --export abc123 session.html

模型选项

以下参数用于指定提供商、模型与推理等级,适合临时切换而不改动配置文件。

参数说明示例
--provider name指定 AI 提供商pi --provider anthropic
--model pattern模型 ID,支持 provider/id 和 :thinking 格式pi --model openai/gpt-4o
pi --model sonnet:high
--api-key key直接传入 API Key,优先级最高;示例值需替换为你自己的 Keypi --api-key sk-ant-api03-xxxx
--thinking level推理等级:off/minimal/low/medium/high/xhigh/maxpi --thinking high
--models patterns逗号分隔的模型列表,限制 Ctrl+P 循环pi --models "claude-*,gpt-4o"
--list-models列出所有可用模型pi --list-models

会话选项

以下参数决定本次运行使用哪个会话,以及会话文件保存在哪里。

参数说明示例
-c, --continue继续最近的会话pi -c
-r, --resume浏览并选择历史会话pi -r
--session path|id使用指定会话文件或 UUIDpi --session abc123
--fork path|id从指定会话分叉出新会话pi --fork abc123
--session-dir dir自定义会话存储目录,默认目录为 ~/.pi/agent/sessions/,此参数用于临时替换它pi --session-dir .pi/sessions
--no-session临时模式,不保存会话pi --no-session
-n, --name name设置会话显示名称pi --name "重构认证模块"

工具选项

以下参数控制内置工具的可用范围,用于收紧权限或做纯对话。

参数说明示例
-t, --tools list白名单指定工具,逗号分隔pi --tools read,bash,edit,write
-xt, --exclude-tools list禁用指定工具,逗号分隔pi --exclude-tools bash
-nbt, --no-builtin-tools禁用所有内置工具,保留扩展工具pi --no-builtin-tools
-nt, --no-tools禁用所有工具,纯对话模式pi --no-tools

资源选项

以下参数控制扩展、Skill、模板与主题的加载,带 --no- 前缀的参数用于关闭自动发现。

参数说明示例
-e, --extension source加载扩展,可重复使用pi -e ./my-ext.ts -e npm:@foo/bar
--no-extensions禁用扩展自动发现pi --no-extensions
--skill path加载 Skill,可重复使用pi --skill ./my-skill
--no-skills禁用 Skill 自动发现pi --no-skills
--prompt-template path加载提示词模板,可重复使用pi --prompt-template ./review.md
--no-prompt-templates禁用模板自动发现pi --no-prompt-templates
--theme path加载主题,可重复使用pi --theme ./my-theme.json
--no-themes禁用主题自动发现pi --no-themes
-nc, --no-context-files禁用 AGENTS.md/CLAUDE.md 加载pi -nc

其他选项

以下参数覆盖系统提示词、项目信任与帮助信息等行为。

参数说明示例
--system-prompt text替换默认系统提示词pi --system-prompt "你是 Python 专家"
--append-system-prompt text追加到系统提示词pi --append-system-prompt "使用中文回复"
--tui-mode界面模式,如 fullscreen;不指定时用常规(regular)模式pi --tui-mode fullscreen
--use-theme指定主题加载,仅对本次运行生效,不改动配置pi --use-theme "dark-plus"
--verbose强制显示详细启动信息pi --verbose
-a, --approve本次运行信任项目本地文件pi -a
-na, --no-approve本次运行不信任项目本地文件pi -na
--分隔符,其后内容原样传给 promptpi -- @notes.md 总结这份笔记
-h, --help显示帮助信息pi -h
-v, --version显示版本号pi -v

-a-na 互斥,同一次运行只能指定其中一个。

两者的作用范围都只限于本次运行,不会写入 trust.json。


pi 子命令

除启动参数外,pi 还提供一组管理扩展包与自身更新的子命令。

子命令说明
pi install <source>安装扩展包,加 -l 安装到项目本地
pi remove <source>移除已安装的扩展包
pi uninstall <source>remove 的别名,效果相同
pi list列出已安装的扩展包
pi update更新 pi 自身与扩展包,支持 --self、--all、--models、--extensions、--extension <source>
pi config启用或禁用扩展包提供的各类资源

相关环境变量

以下环境变量影响认证、网络与终端表现,可作为命令行参数之外的补充配置。

变量作用示例
ANTHROPIC_API_KEYAnthropic 认证的备用方式,未通过 /login 订阅登录时使用sk-ant-api03-xxxx
HTTP_PROXY / HTTPS_PROXY为 API 请求指定代理服务器http://127.0.0.1:7890
NO_PROXY代理白名单,命中的主机不经过代理localhost,127.0.0.1
COLORTERMtruecolor 自动检测的参考值之一;检测失败可用 PI_TRUE_COLOR=1 强制开启,或配置 terminal.trueColortruecolor

需要长期使用的代理建议写入 ~/.pi/agent/settings.jsonhttpProxy

该配置仅在全局配置文件中生效,写在项目级 .pi/settings.json 中无效。


文件参数

使用 @ 前缀引用文件:

$ pi @prompt.md "回答这个问题"
$ pi -p @screenshot.png "图中有什么"
$ pi @src/code.ts @src/test.ts "对比这两个文件"

以第二条命令为例,输出类似:

图中是一张登录页面的截图,页面包含用户名输入框、密码输入框和一个登录按钮。