Skip to main content
Breeze CLI stores local configuration in ~/.breeze/config.toml and profile credentials in ~/.breeze/credentials.json. The credentials file is local-only and should not be committed.

​
Profiles

Profiles keep separate environments or accounts on one machine. Logging in with --profile writes the key into that profile but does not switch to it; switch explicitly with config profile use.

​
API environments

The selected profile’s base URL is used by every API command, including breeze login. Breeze web host aliases are normalized to API hosts: https://breezeblue.ai maps to https://api.breeze.blue; legacy https://breeze.blue also maps to https://api.breeze.blue.

​
Manual key entry

​
Automatic update checks

Interactive CLI commands check for a new public CLI release at most once per day by default. When a newer version is available, Breeze prints a short terminal hint and leaves installation manual. The check is skipped for --agent, --output json, --non-interactive, --quiet, and CI runs, and can be disabled entirely with BREEZE_CLI_DISABLE_UPDATE_CHECK=1. Automatic installation is never enabled by default. Opt in explicitly if you want Breeze to prompt before installing or install automatically. The latest successful automatic or explicit update check is stored separately in ~/.breeze/update-state.json; a successful installation records status: "current". Only your policy lives in config.toml.

​
Manual updates

breeze update checks the public release manifest and installs the matching binary, Video Lab runtime, and bundled agent Skills together. breeze upgrade is an alias.
Skills are synchronized by default. The auto target detects Codex, Claude Code, and Cursor on this machine, with Codex as the fallback. To add all supported targets:
Existing Breeze-managed targets also update. Repeating breeze update --yes on the current version repairs missing or modified Skills from the local package. breeze update --check only checks availability. Every package contains its matching Skills. When an earlier updater installs the package without copying Skills into agent directories, the first regular command from the installed CLI performs that local synchronization before continuing. No additional download is needed. Synchronization failures stop the command; use breeze update --force --yes to repair a damaged package. Restart or reload an agent session that has already loaded Breeze Skills so it reads the installed files. Updates and downgrades require a package with matching Skills (0.10.0 or later). An archive without bundled Skills is rejected before installation.