Skip to main content

quickstart command

note

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

The quickstart command within the Databricks CLI prints a short introduction to the Databricks CLI, covering authentication, profiles, building with Declarative Automation Bundles, and where to go next.

By default, the command prints a human-friendly guide. When stdout is not an interactive terminal (for example, when a coding agent runs the command), it prints a denser, agent-oriented version instead.

databricks quickstart [flags]

Options

This command has no options other than the global flags.

Global flags

Examples

The following example prints the Databricks CLI quickstart guide:

Bash
databricks quickstart

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

On this page