boilstream-admin CLI

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

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

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

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

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:

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.

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

CLI settings and server settings are different:

# 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.

Catalogs and users

Catalog listing and creation require superadmin access. Supply the owner explicitly:

boilstream-admin catalog list
boilstream-admin catalog create --name events__stream --owner user@example.com \
  --description "Application events"
boilstream-admin catalog info CATALOG_ID
boilstream-admin catalog tables CATALOG_ID

Users obtain credentials under their own authorized profile:

boilstream-admin --profile work catalog credentials CATALOG_ID

Common superadmin user operations:

boilstream-admin user list
boilstream-admin user info user@example.com
boilstream-admin user sessions --user user@example.com

For deletion, first inspect boilstream-admin user delete --help and use --dry-run. Deleting a user can also delete owned catalogs and their data; choose the catalog action explicitly.

Tokens and sessions

boilstream-admin --profile work token create --purpose ingest --topic-id 1
boilstream-admin --profile work auth session list
boilstream-admin --profile work auth session revoke SESSION_ID

Replace the topic ID with the ID of your target table. Use a token with the correct purpose for the interface. See Authentication.

Cluster and service health

These operations require administrative access:

boilstream-admin cluster status
boilstream-admin cluster brokers
boilstream-admin cluster health
boilstream-admin cp-metadata status

Use Cluster mode for availability and rolling-update requirements. Check boilstream-admin node --help and boilstream-admin leader --help before changing node state or leadership.

Hydration

Operators can preload historical files for repeated queries:

boilstream-admin hydration table -d CATALOG_ID -t TABLE_NAME
boilstream-admin hydration list -d CATALOG_ID
boilstream-admin hydration stats

See Cold-tier hydration for status, cancellation and cache controls.

Local server process

boilstream-admin server start --config local-dev.yaml
boilstream-admin server status
boilstream-admin server logs --follow
boilstream-admin server stop

These commands manage a local process. Use your orchestrator for a Kubernetes deployment. For upgrades, inspect boilstream-admin server upgrade --help and review a --dry-run before applying changes.

Other administration

Use the matching command group and its --help:

Task	Command group
Role assignments	role
Cloud accounts	cloud-account
S3 buckets	s3-bucket
SAML providers	saml
Schema discovery	schema-registry

The Web Auth GUI provides browser-based administration.