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 last check result is stored separately in ~/.breeze/update-state.json; only your policy lives in config.toml.

​
Manual updates

breeze update checks the public release manifest and installs the matching binary and runtime. breeze upgrade is an alias.
Add --with-skills when you want the bundled agent skills to follow the CLI release: