蒲公英 CLI
蒲公英官方命令行工具 @pgyer/cli 的功能概览,涵盖应用上传、应用与历史版本管理、账户认证及自动化集成。
@pgyer/cli 是蒲公英官方命令行工具,您可以在终端中上传安装包、查询和管理应用及历史版本,也可以将这些操作接入构建脚本、CI/CD 流水线或 AI 助手。
本文提供功能概览与常用示例,完整命令和参数请查看 GitHub 仓库 PGYER/pgyer-cli 或 npm 软件包页面。
如需选择 API、CLI、CI/CD 插件、MCP 或 Agent Skill,请先查看 自动上传 App 与 CI/CD 集成指南。
功能概览
| 功能 | 可以完成的操作 |
|---|---|
| 应用上传 | 通过快速上传 API 上传 IPA、APK、HAP,设置更新说明、安装方式和渠道等发布选项 |
| 应用管理 | 查看应用列表和详情、通过短链接查找应用、修改应用设置或删除应用 |
| 历史版本管理 | 查询历史版本、检查更新、设置或取消最新版本标记、删除指定版本 |
| 上传状态跟踪 | 默认等待发布处理完成,也可异步上传后单独查询或等待处理结果 |
| 账户认证 | 浏览器登录、查看认证状态、退出登录,以及通过 API Key 接入自动化环境 |
| 脚本与自动化 | 通过 --json 输出便于程序解析的结果,部分修改操作支持用 --dry-run 预览 |
| AI 助手 | 运行 pgyer mcp 启动 MCP 服务器,在 AI 客户端中上传和管理应用,详见 蒲公英 MCP |
安装
环境要求:Node.js 20.19 或更高版本。
npm install -g @pgyer/cli快速上手
登录账号
本地开发可通过浏览器完成授权:
pgyer auth login在 CI/CD 环境中,通过环境变量传入 API Key 即可:
export PGYER_API_KEY=YOUR_API_KEY上传应用
pgyer upload ./app-release.apk --build-update-description "修复登录崩溃"支持 .apk、.ipa、.hap 格式。不指定 --install-type 时沿用应用当前的安装方式;上传后默认最多等待 600 秒,直到蒲公英发布完成,可以用 --timeout 调整。
查询应用与历史版本
# 查看应用列表
pgyer apps list
# 查看应用详情
pgyer apps info YOUR_APP_KEY
# 查看应用的历史版本
pgyer versions list YOUR_APP_KEY将 YOUR_APP_KEY 替换为目标应用的 App Key。需要在脚本中处理结果时,可添加 --json,例如 pgyer apps list --json。
更多用法
应用设置、渠道上传、异步任务、版本管理等完整示例,请查看 CLI 使用说明。本地也可运行 pgyer --help 查看命令列表,或运行 pgyer upload --help 查看某个命令的参数。具体能力以您安装的版本为准。