pi 命令行:子命令与 flag
pi 自己的命令行面:顶层子命令加全部 flag,收自 docs/cli.md。
共 82 行,展开查看
| 命令 / flag | 参数形态 | 作用 | 出处 |
|---|---|---|---|
pi | pi [options] [--] [@files...] [messages...] | 主入口:无参数且 stdin/stdout 是终端时进 TUI | cli.md:8 |
@path | @<相对路径> | 把文本文件或图片并入首个 prompt;相对 cwd 解析 | cli.md:35 |
-- | 分隔符 | 终止选项解析,使 prompt 可以 - 开头 | cli.md:37 |
pi install | pi install <source> [options] | 安装包 | cli.md:9 |
pi remove | pi remove <source> [options] | 移除包及其 settings 条目 | cli.md:10 |
pi uninstall | pi uninstall <source> [options] | remove 的别名 | cli.md:11 |
pi update | pi update [target] [options] | 无 target 时更新 pi 自身 | cli.md:12 |
pi list | pi list | 列出已配置的包 | cli.md:13 |
pi config | pi config [options] | 配置哪些包资源被加载 | cli.md:14 |
pi auth | pi auth <check|print-api-key|print-bearer-token> [options] | 凭据检查/打印 | cli.md:15 |
pi mcp | pi mcp <list|login|logout> [options] | MCP 管理入口(synopsis 仅列三个子命令) | cli.md:16 |
-p, --print | 无值 | 跑完 prompt,把最终助手文本写到 stdout 后退出 | cli.md:45 |
--mode text | 字面量 | 文本输出;但 stdin/stdout 是终端时仍开 TUI | cli.md:46 |
--mode json | 字面量 | 输出 JSONL 事件到 stdout 后退出 | cli.md:47 |
--mode rpc | 字面量 | 从 stdin 读 JSONL 命令,向 stdout 写响应与事件 | cli.md:48 |
--export | --export <input> [output] | 把会话文件导出为 HTML 后退出;省略 output 时自行推导 | cli.md:49 |
--provider | --provider <name> | 把 --model 查找限制到单一 provider;必须配 --model | cli.md:63 |
--model | --model <pattern> | 精确 ID 或模糊 ID/name 匹配,支持 provider/id 与 :<thinking> 后缀 | cli.md:65 |
--api-key | --api-key <key> | 非持久化 API key 覆盖;需先经 --model/--models 选定模型 | cli.md:67 |
--thinking | --thinking <off|minimal|low|medium|high|xhigh|max> | 设置思考等级,覆盖 --model 后缀并按模型能力 clamp | cli.md:69 |
--models | --models <patterns> | 逗号分隔的启动/循环模型范围,支持精确 ID、模糊、大小写不敏感 glob 与 :<thinking> | cli.md:71 |
--list-models | --list-models [search] | 列出可用模型(可模糊过滤)后退出 | cli.md:73 |
-c, --continue | 无值 | 继续当前项目最近的会话 | cli.md:86 |
-r, --resume | 无值 | 打开会话选择器 | cli.md:88 |
--session | --session <path|id> | 按路径/精确 ID/部分 ID 打开;优先当前项目,跨项目匹配会提示 fork | cli.md:90 |
--session-id | --session-id <id> | 打开指定项目会话 ID,不存在则创建;字符限于字母数字 . _ - | cli.md:92 |
--fork | --fork <path|id> | 把已有会话 fork 成当前项目的新会话 | cli.md:94 |
--session-dir | --session-dir <dir> | 覆盖存储与查找;优先于 PI_CODING_AGENT_SESSION_DIR 与 sessionDir | cli.md:96 |
--no-session | 无值 | 使用不落盘的内存会话 | cli.md:98 |
-n, --name | --name <name> | 设置会话显示名 | cli.md:100 |
-t, --tools | --tools <list> | 以逗号分隔的 allowlist 替换默认工具选择;条目可为名字或含 * 的模式 | cli.md:119 |
-xt, --exclude-tools | --exclude-tools <list> | 在其他所有选择选项(含 MCP)之后禁用指定工具 | cli.md:121 |
-nbt, --no-builtin-tools | 无值 | 关默认内置工具,保留扩展与自定义工具 | cli.md:123 |
-nt, --no-tools | 无值 | 内置/扩展/自定义/MCP 全部关闭启动 | cli.md:125 |
-e, --extension | --extension <path> | 加载扩展文件/目录或内置扩展(如 builtin:mcp);可重复 | cli.md:194 |
-ne, --no-extensions | 无值 | 关发现/配置/内置扩展;显式 -e 仍加载 | cli.md:196 |
--no-mcp | 无值 | 本次运行关内置 MCP 支持(无服务器、无 MCP 工具、无 /mcp) | cli.md:198 |
--skill | --skill <path> | 加载 skill 文件/目录;可重复 | cli.md:200 |
-ns, --no-skills | 无值 | 关发现/配置的 skills;显式 --skill 仍加载 | cli.md:202 |
--prompt-template | --prompt-template <path> | 加载 prompt 模板文件/目录;可重复 | cli.md:204 |
-np, --no-prompt-templates | 无值 | 关发现/配置的模板;显式路径仍加载 | cli.md:206 |
--theme | --theme <path> | 加载主题文件/目录;可重复 | cli.md:208 |
--use-theme | --use-theme <name[/name]> | 选定本次运行的初始交互主题 | cli.md:210 |
--no-themes | 无值 | 关发现/配置的主题;显式 --theme 仍加载 | cli.md:212 |
-nc, --no-context-files | 无值 | 关 AGENTS.md 与 CLAUDE.md 发现 | cli.md:214 |
--system-prompt | --system-prompt <text|path> | 用文本或已存在文件内容替换默认系统提示 | cli.md:229 |
--append-system-prompt | --append-system-prompt <text|path> | 向系统提示追加文本或文件内容;可重复 | cli.md:231 |
--tui-mode | --tui-mode <fullscreen|regular> | 终端模式;文档标注 fullscreen 为默认 | cli.md:233 |
--verbose | 无值 | 显示详细启动信息,覆盖 quietStartup | cli.md:235 |
-a, --approve | 无值 | 本次进程信任项目本地配置与资源 | cli.md:237 |
-na, --no-approve | 无值 | 本次进程忽略受信任门控的项目本地配置与资源 | cli.md:239 |
--offline | 无值 | 关自动联网(含模型目录刷新);等价 PI_OFFLINE=1 | cli.md:241 |
-h, --help | 无值 | 显示帮助(含扩展注册的 flag)后退出 | cli.md:243 |
-v, --version | 无值 | 显示 pi 版本后退出 | cli.md:245 |
--local / -l | 无值 | 用于 install/remove/uninstall/config,改用项目 settings 而非全局 | cli.md:267 |
pi update --extensions | 无值 | 更新所有已装包 | cli.md:276 |
pi update <source> | 位置参数 | 更新单个已装包 | cli.md:277 |
pi update --models | 无值 | 刷新模型目录 | cli.md:278 |
pi update --all | 无值 | 同时更新 pi 与所有已装包 | cli.md:279 |
--force | 无值 | 当选中更新包含 pi 时重装 pi | cli.md:281 |
pi update --self / self / pi | 位置参数/flag | pi update 的别名族 | cli.md:288 |
pi update --extension <source> | 位置参数 | pi update <source> 的别名 | cli.md:289 |
--provider(auth 子命令) | --provider <provider> | 为某 provider 解析凭据(三子命令通用) | cli.md:309 |
--model(auth 子命令) | --model <model> | 从模型解析凭据;可与 --provider 组合 | cli.md:310 |
--json(auth check) | 无值 | 以 JSON 输出结构化结果 | cli.md:311 |
--credentials(auth check) | 无值 | ready 时一并输出解析到的凭据 | cli.md:312 |
--no-refresh(auth check) | 无值 | 不刷新过期 OAuth 凭据(默认会刷新) | cli.md:313 |
--min-expiry(print-bearer-token) | --min-expiry <ms|s|m|h> | 要求剩余有效期,如 30m | cli.md:314 |
pi mcp add | pi mcp add <server> [options] -- <command> [args...] | 新增/替换 stdio server 到 mcp.json | cli.md:324 |
--env(mcp add) | --env KEY=VALUE | 设置 stdio server 环境变量;可重复 | cli.md:324 |
--cwd(mcp add) | --cwd <dir> | 设置 stdio server 工作目录 | cli.md:324 |
--url(mcp add) | --url <url> | 新增/替换 streamable HTTP server | cli.md:325 |
--header(mcp add) | --header KEY=VALUE | HTTP 请求头;可重复 | cli.md:325 |
--bearer-token-env-var | --bearer-token-env-var <NAME> | 发送 Authorization: Bearer ${NAME} | cli.md:325 |
--oauth-client-id / --oauth-client-secret / --oauth-callback-port / --oauth-client-name | 各自带值 | 配置 HTTP server 的 OAuth 认证 | cli.md:325 |
pi mcp remove | pi mcp remove <server> | 从 mcp.json 移除 server;已存 OAuth 凭据保留 | cli.md:326 |
pi mcp list | pi mcp list [--json] | 连接所有启用 server 并打印状态/工具/错误;异常时退出码 1 | cli.md:327 |
pi mcp login | pi mcp login <server> [--timeout <seconds>] | OAuth 登录;--timeout 默认 300 秒 | cli.md:328 |
pi mcp logout | pi mcp logout <server> | 删除该 server 已存 OAuth 凭据 | cli.md:329 |
--local / -l(mcp) | 无值 | add/remove 改写当前目录 .pi/mcp.json 而非 ~/.pi/agent/mcp.json | cli.md:331 |
--exposure(mcp add) | --exposure <mode> | 设置 MCP 工具暴露模式 | cli.md:331 |
--description(mcp add) | --description <text> | 设置 server 描述 | cli.md:331 |