Vidrush CLI

安装

vidrush-cli 需要 Node.js 20 或更高版本，且没有运行时依赖。NPM 发布正在准备中；在此之前，可运行本地 package 或链接它：

cd packages/vidrush-cli
node bin/vidrush.mjs models
npm link
vidrush models

配置 API key

vidrush config set-key sk-your-api-key

命令会把 key 保存到 ~/.config/vidrush/config.json。单个 shell 或 CI 中可使用环境变量：

export VIDRUSH_API_KEY=sk-your-api-key

对需要认证的命令，CLI 按 --api-key、VIDRUSH_API_KEY、保存的配置的顺序查找凭证。vidrush models 是公开命令，不需要 key。

命令

vidrush models [--json]
vidrush credits [--json]
vidrush generate -m <model> -p <prompt> [options]
vidrush task <task_id> [--wait] [--output file] [--json]

`models`

列出公开的 v1 模型目录。加上 --json 可输出原始 JSON。

`credits`

输出已认证账户的剩余积分。

`generate`

vidrush generate -m sora-2 -p "A paper kite crossing a bright summer sky" \
  --duration 8s --resolution 720p --aspect-ratio 16:9 --wait --output kite.mp4

选项	含义
`-m`, `--model`	必填模型 ID
`-p`, `--prompt`	必填提示词
`--mode`	视频模式，例如 `text-to-video`
`--image <url>`	源图片 URL；可重复传入多张图片
`--duration <duration>`	模型支持的时长，例如 `8s`
`--resolution <resolution>`	模型支持的分辨率，例如 `720p`
`--aspect-ratio <ratio>`	模型支持的宽高比，例如 `16:9`
`--audio`	仅在模型支持时开启音频
`--wait`	每 5 秒轮询，最长 10 分钟
`--output <file>`	下载第一个成功的视频 URL 到文件
`--json`	为自动化输出裸 JSON

`task`

按 ID 查询任务。使用 --wait 轮询，使用 --output 下载第一个成功的视频 URL。

通用选项与退出码

--base-url <url> 覆盖默认的 https://vidrush-ai.com，可用于测试环境。--api-key <key> 覆盖环境变量和保存的 key。--json 输出裸 JSON。

成功退出码为 0，业务/API 失败为 1，命令用法无效为 2。

生成前应先运行 vidrush models：创建任务会消耗模型配置的积分。

Vidrush CLI

On this page