CLI Reference#

This page provides a complete reference for all Minitrino CLI commands and options.

Global Options#

The following options are available for all Minitrino commands:

--version - Display the Minitrino version and exit
-v, --verbose - Enable verbose output for detailed logging
--log-level - Set the logging level (ERROR, WARN, INFO, DEBUG)
-e, --env - Set environment variables (format: KEY=VALUE)
-c, --cluster - Specify the cluster name (use '*' or 'all' for all clusters)

Commands#

provision#

minitrino provision#

Provision a cluster with optional modules.

minitrino provision [OPTIONS]

Options

-m, --module <modules>#: Module to install in the cluster.

-i, --image <image>#: Cluster image type (trino or starburst). Defaults to trino.

-w, --workers <workers>#: Number of cluster workers to provision (default: 0).

-n, --no-rollback#: Disables cluster rollback if provisioning fails.

down#

minitrino down#

Stop and remove all running cluster containers. By default, applies to cluster ‘default’.

Stop and remove containers in specific cluster by using the CLUSTER_NAME environment variable or the –cluster / -c option, e.g.:

minitrino -c my-cluster down

Stop all clusters via:

minitrino -c all down

minitrino down [OPTIONS]

Options

-k, --keep#: Do not remove containers; only stop them.

--sig-kill#: Stop containers without a grace period.

remove#

minitrino remove#

Remove Minitrino resources. By default, applies to ‘default’ cluster.

Remove resources for a specific cluster by using the CLUSTER_NAME environment variable or the –cluster / -c option, e.g.:

minitrino -c my-cluster remove

Or specify all clusters via:

minitrino -c all remove

minitrino remove [OPTIONS]

Options

-i, --images#: Remove images. –cluster must be set to all.

-v, --volumes#: Remove volumes.

-n, --networks#: Remove networks.

-m, --module <modules>#: Filter removal by module.

-f, --force#: Force removal.

restart#

minitrino restart#

Restart running cluster containers (coordinator and workers). By default, applies to ‘default’ cluster.

Restart containers in a specific cluster by using the CLUSTER_NAME environment variable or the –cluster / -c option, e.g.:

minitrino -c my-cluster restart

minitrino restart [OPTIONS]

exec#

minitrino exec#

Run a command in a container (default command is /bin/bash).

minitrino exec [OPTIONS] [COMMAND]...

Options

-c, --container <container>#: Container to run the command in (defaults to current cluster’s coordinator container).

-u, --user <user>#: Username or UID

-i, --interactive#: Run the command in an interactive shell.

Arguments

COMMAND#: Optional argument(s)

resources#

minitrino resources#

Display all Docker resources in the Minitrino environment.

minitrino resources [OPTIONS]

Options

-c, --container#: Show only containers.

-v, --volume#: Show only volumes.

-i, --image#: Show only images.

-n, --network#: Show only networks.

snapshot#

minitrino snapshot#

Create a snapshot of a Minitrino environment. By default, applies to ‘default’ cluster.

Once a snapshot is created, a tarball is placed in the Minitrino lib/snapshots/ directory, usually ~/.minitrino/lib/snapshots/.

To snapshot an active environment, do not pass in the –module option.

To snapshot modules whether they are active or not, specify target modules via the –module option.

To snapshot a specific running cluster, use the CLUSTER_NAME environment variable or the –cluster / -c option, e.g.:

minitrino -c my-cluster snapshot

or snapshot all clusters via:

minitrino -c ‘*’ snapshot

minitrino snapshot [OPTIONS]

Options

-m, --module <modules>#: Specific module to snapshot.

-n, --name <name>#: Required Basename of the snapshot tarball.

-d, --directory <directory>#: Directory to save the snapshot file in.

-f, --force#: Overwrite the snapshot file if it already exists.

--no-scrub#: Do not scrub sensitive data from user config file.

modules#

minitrino modules#

Get module metadata.

minitrino modules [OPTIONS]

Options

-m, --module <modules>#: Module to display metadata for.

-t, --type <module_type>#: Module type (admin, catalog, or security).

-j, --json#: Output module metadata in JSON.

-r, --running#: Get metadata for all running modules.

config#

minitrino config#

Edit the Minitrino config file (minitrino.cfg).

minitrino config [OPTIONS]

Options

-r, --reset#: Reset the config file with default values.

lib-install#

minitrino lib-install#

Install the Minitrino library.

minitrino lib-install [OPTIONS]

Options

-v, --version <version>#: Library version.

-r, --list-releases#: List all available Minitrino library releases.

Tips and Tricks#

Operating on All Clusters#

You can use -c '*' or -c all to operate on all clusters simultaneously:

# Snapshot all clusters
minitrino -c '*' snapshot
minitrino -c all snapshot

# Stop all clusters
minitrino -c all down

Setting Environment Variables#

Environment variables can be set via the -e flag:

minitrino -e CLUSTER_VER=476 -e LIC_PATH=/path/to/license provision

Choosing Trino or Starburst Distribution#

For the provision command, you can specify the distribution using either the command-specific -i/--image flag or the global -e IMAGE= environment variable:

# Preferred method: Use the provision command's -i flag
minitrino -v provision -i starburst -m postgres

# Alternative: Use global environment variable
minitrino -v -e IMAGE=starburst provision -m postgres

Both methods are functionally equivalent, but the -i flag is more explicit and recommended.

Debug Mode#

For detailed debugging information, use verbose mode with DEBUG log level:

minitrino --verbose --log-level DEBUG provision -m hive

Interactive Container Shell#

Get an interactive shell in the coordinator container:

minitrino exec -i

Or specify a different container:

minitrino exec -c hive -i