Skip to main content

Install and sign in

Install the CLI​

The BlazerOps CLI is the blazerops package on PyPI. It needs Python 3.11 or newer. Install it with pip:

pip install blazerops

Or, to keep it in its own environment, with pipx:

pipx install blazerops

Verify the install:

blazerops --version

Upgrade​

pip install -U blazerops

Before each command, the CLI checks that the server accepts its version. If the server needs a newer CLI, the command stops and tells you to upgrade.

The Python library​

The same package installs the importable blazerops library. It includes BlazerOps, a client for calling published apps from your own Python code:

from blazerops import BlazerOps

Sign in​

BlazerOps uses a device-code sign-in. Run:

blazerops login

The CLI prints a short user code and a URL. Open the URL in the browser where you are signed in to the BlazerOps app, enter the code, and choose the organisation you want to work in. The CLI then completes sign-in and stores your token.

Your token is scoped to the organisation you chose. To work in a different organisation, run blazerops login again and pick it.

Confirm you are signed in — whoami makes a real authenticated request and prints your user, organisation, and the API it is talking to:

blazerops whoami

doctor reports your CLI version, authentication, and catalog status, and exits non-zero if anything is wrong — a good first check when something misbehaves:

blazerops doctor

Where credentials are stored​

  • Your token is stored in the OS keyring, keyed by the API URL — never written to a dotfile.
  • Non-secret identity (API URL, organisation, user, expiry) is written to ~/.local/state/blazerops/identity.json.
  • blazerops logout drops the stored token and clears your identity.

CI and headless machines​

On a machine with no keyring (CI, a headless box), set the token in the environment instead. It overrides the keyring entirely:

export BLAZEROPS_TOKEN="<token>"

To obtain a token for this purpose, run blazerops login --print-token, which emits the bearer once instead of storing it.

The API endpoint defaults to the platform's public URL and can be overridden with BLAZEROPS_API_URL when you need to point at a specific environment.

Next​

  • CLI reference: every command and its arguments, generated from the latest release.