PiAPI CLI 快速开始:从终端生成 AI 图片和视频

PiAPI CLI 是 PiAPI 官方命令行工具,可从终端直接调用图片、视频、音频、3D 和 LLM 等多模态 AI 模型。
这篇快速开始会介绍安装、API key 认证、第一次图片生成、async 视频任务,以及如何查看可用模型。
PiAPI CLI 是什么?
快速定义
PiAPI CLI 是一个 Node.js 命令行工具,可在不打开 Web dashboard 的情况下运行 PiAPI 模型。
当生成流程从终端开始时,AI CLI 很有用:你可以保存命令、重复执行、修改参数,并把它放进脚本或 AI agent。
- 用可复用 prompt 生成素材
- 开发应用或 prototype 时快速测试
- 从项目目录上传本地文件
- 把输出保存到固定文件夹
- 为脚本、CI 或 agent 返回 JSON
PiAPI CLI 概览
| 包名 | piapi-cli |
|---|---|
| 命令 | piapi |
| Runtime | Node.js 18+ |
| 主要用途 | 终端内多模态 AI 生成 |
| 适合人群 | 开发者、自动化 workflow 和 AI agents |
准备条件
- Node.js 18 或更高版本
- PiAPI API key
- 终端应用
安装 PiAPI CLI
使用你偏好的 JavaScript package manager 安装 piapi-cli。
npm install -g piapi-clipnpm add -g piapi-clibun add -g piapi-cliyarn global add piapi-clinpx piapi-cli@latest --help使用 PiAPI API key 认证
安装后,将 CLI 连接到你的 PiAPI 账号。
piapi auth login --api-key sk-xxxxxpiapi auth statusexport PIAPI_API_KEY=sk-...从终端生成第一张 AI 图片
认证后,可以用 piapi run 从终端生成 AI 图片。
piapi run flux-dev prompt="a corgi in space"piapi run gpt-image-2 prompt="a corgi in space" size=1024x1024piapi run sora2-pro prompt="ocean waves" --asyncpiapi task get <id>piapi run remove-bg image=@./photo.png --download --out-dir ./out探索模型并检查 quota
使用 model 命令浏览模型、查看 schema 和检查 quota。
piapi model listpiapi model list --type videopiapi model schema flux-devpiapi quota常用 PiAPI CLI flags
自动化常用 flags:
--async | CLI workflow 选项 |
--download | CLI workflow 选项 |
--out-dir <path> | CLI workflow 选项 |
--stream | CLI workflow 选项 |
--dry-run | CLI workflow 选项 |
--output json | JSON output for scripts and automation |
--webhook <url> | CLI workflow 选项 |
--quiet | CLI workflow 选项 |
--non-interactive | CLI workflow 选项 |
在 AI agents 和自动化中使用 PiAPI CLI
PiAPI CLI 也可用于 AI agent、shell scripts、CI jobs 和自动化 workflow。
npx skills add PiAPI-1/piapi-clipiapi run flux-dev prompt="a product photo on a white background" --output jsonMidjourney n8n integration guide
PiAPI CLI 常见问题排查
如果第一个命令无法运行,请先检查这些常见问题,再调整 prompt 或 model。
找不到 piapi 命令
npx piapi-cli@latest --help
API key 无效或缺失
piapi auth status
视频命令返回 task ID 而不是文件
piapi task get <id>
什么时候用 PiAPI CLI 而不是 Web UI?
当你需要可重复、可脚本化或可交给 AI agent 的 workflow 时使用 PiAPI CLI。Web UI 适合视觉探索;CLI 更适合自动化。
FAQ
PiAPI CLI 是什么?
PiAPI CLI 是一个 Node.js 命令行工具,可在不打开 Web dashboard 的情况下运行 PiAPI 模型。
如何安装 PiAPI CLI?
npm install -g piapi-cli / npx piapi-cli@latest --help
可以从终端生成 AI 图片和视频吗?
piapi run flux-dev prompt="a corgi in space" / piapi run sora2-pro prompt="ocean waves" --async
开始使用 PiAPI CLI 构建
PiAPI CLI 让开发者和 AI agents 能从命令行生成图片、视频、音频、3D assets 和 LLM responses。

