Skip to content
BoilStream

Use the administration CLI

operationspreview
TL;DR

Install the administration CLI supplied with your server release, sign in and select an explicit profile before managing resources. User and superadmin commands have different permissions. Protect saved sessions and check help for the installed beta version. Server configuration, local CLI preferences and Kubernetes orchestration are separate concerns.

Message sequenceThe CLI sends authenticated administration requests
The CLI sends authenticated administration requestsAn operator chooses a CLI profile and target, supplies authentication and submits an administration request. BoilStream checks permissions and returns the result; operators verify the resulting state.Operator / CLIBoilStreamSelect profile and endpointAuthenticated admin requestCheck permission and apply actionResult or errorRead resulting stateTime moves downward · dashed arrows are responsesThe CLI sends authenticated administration requestsAn operator chooses a CLI profile and target, supplies authentication and submits an administration request. BoilStream checks permissions and returns the result; operators verify the resulting state.Operator /CLIBoilStreamSelect profile andendpointAuthenticated adminrequestCheck permission andapply actionResult or errorRead resulting stateTime moves downward · dashed arrows are responses
Select the intended environment before running commands. A profile is connection configuration, not a separate server.

Use boilstream-admin to manage users, catalogs and deployments. Install the CLI supplied with your server release. It is a beta interface; use --help to check the commands and options available in that version.

Installation

Section titled “Installation”

Download the appropriate binary from the release downloads, then make it executable:

Shell
chmod +x boilstream-admin
./boilstream-admin --help

Move it to a directory on your PATH to use the commands below.

Authentication

Section titled “Authentication”

Use the auth server URL supplied by your administrator. Store the password in a local file readable only by your account, then set BOILSTREAM_PASSWORD_PATH to its path:

Shell
export BOILSTREAM_PASSWORD_PATH=/secure/path/password.txt
boilstream-admin auth login --server https://your-server.example \
  --email user@example.com --as-profile work
boilstream-admin --profile work auth status

Use boilstream as the username for the superadmin account. Complete MFA when required; check boilstream-admin auth login --help for the current MFA options. For manual TOTP setup, use the algorithm and settings supplied by the service; the current CLI enrollment instructions specify SHA-512, six digits and a 30-second period.

Saved sessions are local credentials. Protect ~/.boilstream/ and do not commit its contents. Select a profile explicitly when working with more than one deployment or user.

Shell
boilstream-admin auth list
boilstream-admin auth switch work
boilstream-admin auth whoami
boilstream-admin --profile work auth logout

auth whoami shows the active profile. Use auth switch first; to inspect a different profile without switching, use --profile NAME auth status.

Configuration

Section titled “Configuration”

CLI settings and server settings are different:

Shell
# Local CLI configuration
boilstream-admin config show
boilstream-admin config path
boilstream-admin --profile work config set auth_server https://your-server.example


# Server configuration, with sensitive values redacted
boilstream-admin --profile work config dump

Useful environment variables include BOILSTREAM_PROFILE, BOILSTREAM_AUTH_SERVER, BOILSTREAM_PASSWORD_PATH and BOILSTREAM_MFA_SECRET_PATH. Use boilstream-admin config --help for configuration commands.

An automation launcher can supply BOILSTREAM_MFA_SECRET directly in its child process environment. The CLI uses this value before any MFA file lookup. Surrounding whitespace is trimmed; an explicitly empty or non-Unicode value fails instead of selecting another secret. Omitting it preserves the existing file lookup. This input does not write an MFA file; it does not change the CLI’s existing session persistence behavior.

Choose a command

Section titled “Choose a command”

Use the command reference for catalogs, tokens, cluster health, hydration and local server control. Inspect --help before modifying a resource.