Breeze CLI command reference

This page maps the full Breeze CLI command surface. Run breeze --help for the local command list and breeze <command> --help for the flags on any command. breeze capabilities prints the same surface as machine-readable JSON.

Commands

Command	Purpose	Details
`breeze tts`	Generate speech from text. Consumes credits.	Text to speech
`breeze tts realtime`	Stream realtime conversation turns over one WebSocket. Consumes credits.	Text to speech
`breeze tts enhance`	Enhance delivery instructions for a TTS request.	Text to speech
`breeze voice list` / `search` / `get` / `play`	Browse or semantically search voices and play saved previews.	Voices
`breeze voice design`	Generate voice previews from a text description. Consumes credits.	Voices
`breeze voice clone`	Create a voice clone preview from an audio sample. Consumes credits.	Voices
`breeze voice remix`	Change an existing voice; `presets`, `prepare`, and `status` support comparison. Generation consumes credits.	Voices
`breeze voice preview`	Download, play, or save generated voice previews.	Voices
`breeze voice settings`	Get or edit voice generation settings.	Voices
`breeze voice edit` / `delete`	Rename, update, or delete a saved voice.	Voices
`breeze studio`	Manage projects, scripts, chapters, tracks, instances, and audio materials.	Studio management
`breeze history`	List, download, play, or delete generation history items.	History and jobs
`breeze jobs`	Track, wait for, download, or play async generation jobs.	History and jobs
`breeze play <file-or-url>`	Play a local or public WAV/MP3 file.	History and jobs
`breeze cache`	Inspect and clean locally cached audio.	History and jobs
`breeze curl`	Print a reproducible Developer API cURL request.	From CLI to API
`breeze capabilities`	Print commands, legal flag values, and exit codes as data.	Scripting and agents
`breeze skills`	Check, install, or update Breeze agent skills.	Scripting and agents
`breeze video`	Video Lab: validate, inspect, and render local HTML compositions.	Video Lab
`breeze login` / `logout`	Browser login and local credential removal.	Login and auth
`breeze config`	Profiles, base URLs, manual keys, and update policy.	Config and update
`breeze update`	Check for and install CLI updates. `breeze upgrade` is an alias.	Config and update
`breeze whoami`	Show the current account context and recent usage.	Account commands
`breeze api-key current`	Show the authenticating key’s status and Key Budget.	Account commands
`breeze balance`	Show the account credit balance.	Account commands
`breeze usage list`	List recent Developer API usage.	Account commands
`breeze models list`	List available models.	Account commands
`breeze diagnostics`	Check local configuration, key source, and runtime health.	Troubleshooting
`breeze version`	Print the CLI version.	—

Global flags

These flags work on every command:

Flag	Default	Meaning
`--agent`	off	Bundle for machine callers: `--output json --non-interactive --quiet` plus no audio autoplay.
`--output json`	—	JSON results on `stdout`, JSON error envelopes on `stderr`. Implies `--non-interactive`. `json` is the only supported value.
`--quiet`, `-q`	off	Suppress non-essential status output.
`--non-interactive`	off	Disable prompts, spinners, and audio autoplay.
`--api-key`	—	Override the API key for this invocation.
`--base-url`	active profile, then `https://api.breeze.blue`	Override the Developer API base URL.
`--timeout`	`60s`	Request timeout, for example `90s` or `3m`.
`--cache-dir`	system cache directory	Override the local audio cache directory.

Environment variables

Variable	Meaning
`BREEZE_API_KEY`	API key fallback when no flag or profile key applies.
`BREEZE_BASE_URL`	Base URL fallback when the active profile does not set one.
`BREEZE_CLI_PREFER_ENV_CONFIG=1`	Let `BREEZE_API_KEY` and `BREEZE_BASE_URL` take precedence over the profile.
`BREEZE_CACHE_DIR`	Override the local audio cache directory.
`BREEZE_CLI_DISABLE_UPDATE_CHECK=1`	Disable the daily interactive update check.
`CI`	When set, the CLI behaves non-interactively and skips update checks.

See Login and auth for the exact key and base URL resolution order.

Account commands

breeze whoami --agent
breeze api-key current --agent
breeze balance
breeze usage list --days 30
breeze models list

breeze whoami shows the account behind the resolved key plus recent usage (--days, default 7). breeze api-key current checks the resolved key itself and returns its public ID, name, prefix, status, and Key Budget counters without exposing the plaintext key. breeze usage list filters by time range, HTTP method, API key, status class, and client type; run breeze usage list --help for the full flag list.

Get started

Workflows

Automation

Setup and reference

Breeze CLI command reference

Commands

Global flags

Environment variables

Account commands

​Commands

​Global flags

​Environment variables

​Account commands

Commands

Global flags

Environment variables

Account commands