Share via


labs command group

Note

This information applies to Databricks CLI versions 0.205 and above. The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The labs command group within the Databricks CLI contains commands to manage available experimental Databricks Labs applications.

For more information about available Databricks Labs applications, see the following:

databricks labs clear-cache

Clears cache entries for Databricks Labs from all relevant locations.

databricks labs clear-cache [flags]

Options

Global flags

databricks labs install

Install an available Databricks Labs application.

databricks labs install NAME [flags]

Arguments

NAME

    The name of the project to install

Options

--offline

    If installing in offline mode, set this flag to true.

Global flags

databricks labs installed

List all Databricks Labs applications that were installed on your local development machine.

databricks labs installed [flags]

Options

Global flags

Examples

databricks labs installed

databricks labs list

List all Databricks Labs applications that are available for installation on your local development machine.

databricks labs list [flags]

Options

Global flags

Examples

databricks labs list

databricks labs show

Show information about a Databricks Labs application that you installed on your local development machine.

databricks labs show NAME [flags]

Arguments

NAME

    The name of the project to show information about

Options

Global flags

databricks labs uninstall

Uninstall a Databricks Labs application that you installed.

databricks labs uninstall NAME [flags]

Arguments

NAME

    The name of the project to uninstall

Options

Global flags

databricks labs upgrade

Upgrade a Databricks Labs application that you installed.

databricks labs upgrade NAME [flags]

Arguments

NAME

    The name of the project to upgrade

Options

Global flags

Global flags

--debug

  Whether to enable debug logging.

-h or --help

    Display help for the Databricks CLI or the related command group or the related command.

--log-file string

    A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.

--log-format format

    The log format type, text or json. The default value is text.

--log-level string

    A string representing the log format level. If not specified then the log format level is disabled.

-o, --output type

    The command output type, text or json. The default value is text.

-p, --profile string

    The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.

--progress-format format

    The format to display progress logs: default, append, inplace, or json

-t, --target string

    If applicable, the bundle target to use