CLI

The VideoGen CLI is a self-contained binary that wraps the VideoGen API. The commands stay in sync with the API because they are generated from the same OpenAPI spec as the SDKs.

Install

Install globally with npm:

$
npm install -g @videogen/cli

Or, on macOS and Linux, with Homebrew:

$
brew install video-gen/tap/videogen

Both put a videogen command on your PATH. To run it once without installing, use npx:

$
npx @videogen/cli --help

Authenticate

Set your API key from app.videogen.io/developers as an environment variable:

$
export VIDEOGEN_TOKEN="YOUR_API_KEY"

A .env file in the working directory is also loaded automatically. You can override the key per command with the --token flag.

Quick start

List the available commands:

$
videogen --help

Every API resource is a subcommand (videogen <resource> <method>). List the methods on a resource:

$
videogen tools --help

Run a tool

Provide request parameters as individual flags or as a single JSON body with --json. Tool runs are asynchronous, so the CLI prints a toolExecutionId:

$
videogen tools generate-video-clip --json '{"prompt": "A sunset over a calm ocean, cinematic lighting"}'

Poll the execution until it reaches a terminal status:

$
videogen tools get-tool-execution-info --tool-execution-id vg_tool_...

Output formats

Commands print JSON by default, so you can pipe results into jq or other tooling. Use --format to switch to table, yaml, or csv:

$
videogen account get-me | jq '.teamId'

Common flags

These global flags work on every command:

Links

• GitHub: videogen-cli
• npm: @videogen/cli
• REST API Reference