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

breeze config show
breeze config profile list
breeze config profile use work

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.
breeze config init --profile work --base-url https://api.breeze.blue
breeze config profile use work
breeze login
BREEZE_CLI_PREFER_ENV_CONFIG=1 \
  BREEZE_BASE_URL=https://api.breeze.blue \
  breeze diagnostics --agent

Manual key entry

printf '%s' "$BREEZE_API_KEY" | breeze config set api-key --stdin
breeze config unset api-key

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. 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.
breeze config set update-check daily
breeze config set update-install manual
[updates]
check = "daily"      # daily | weekly | never
install = "manual"   # manual | prompt | auto

Manual updates

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