Command line utility

dask cluster

Manage dask clusters.

Create, List, Scale and Delete your dask clusters with dask-ctl.

See https://dask-ctl.readthedocs.io/en/latest/cli.html for more info.

dask cluster [OPTIONS] COMMAND [ARGS]...

create

Create a Dask cluster from a spec file.

dask cluster create [OPTIONS]

Options

-f, --spec-file-path <spec_file_path>

delete

Delete a Dask cluster.

NAME is the name of the cluster to delete. Run dask cluster list for all available options.

dask cluster delete [OPTIONS] NAME

Arguments

NAME

Required argument

discovery

Cluster discovery subcommands.

dask cluster discovery [OPTIONS] COMMAND [ARGS]...

disable

Disable a discovery method.

dask cluster discovery disable [OPTIONS] NAME

Arguments

NAME

Required argument

enable

Enable a discovery method.

dask cluster discovery enable [OPTIONS] NAME

Arguments

NAME

Required argument

list

List installed discovery methods.

Dask clusters can be created by many different packages. Each package has the option to register a method to discover clusters it creates. This command lists all discovery methods registered on your system.

dask cluster discovery list [OPTIONS]

list

List Dask clusters.

DISCOVERY can be optionally set to restrict which discovery method to use. Run dask cluster discovery list for all available options.

dask cluster list [OPTIONS] [DISCOVERY]

Arguments

DISCOVERY

Optional argument

scale

Scale a Dask cluster.

NAME is the name of the cluster to scale. Run dask cluster list for all available options.

N_WORKERS is the number of workers to scale to.

dask cluster scale [OPTIONS] NAME N_WORKERS

Arguments

NAME

Required argument

N_WORKERS

Required argument

snippet

Get code snippet for connecting to a cluster.

NAME is the name of the cluster to get a snippet for. Run dask cluster list for all available options.

dask cluster snippet [OPTIONS] NAME

Arguments

NAME

Required argument

version

Show the dask-ctl version.

dask cluster version [OPTIONS]