The Databricks command-line interface (also known as the Databricks CLI) utility provides an easy-to-use interface to automate the Databricks platform from your terminal, command prompt, or automation scripts. See What is the Databricks CLI?.
This article demonstrates how to quickly install and configure the Databricks CLI.
Confirm local machine requirementsâThis tutorial assumes that:
For Linux or macOS, you have Homebrew installed.
For Windows, you have winget, Chocolatey, or Windows Subsystem for Linux (WSL) installed. For installation instructions, see your operating system's documentation.
First, install the Databricks CLI:
If it is not already installed, install the Databricks CLI as follows:
Use Homebrew to install the Databricks CLI by running the following two commands:
Bash
brew tap databricks/tap
brew install databricks
You can use winget, Chocolatey or Windows Subsystem for Linux (WSL) to install the Databricks CLI. If you cannot use winget
, Chocolatey, or WSL, you should skip this procedure and use the Command Prompt or PowerShell to install the Databricks CLI from source instead.
note
Installing the Databricks CLI with Chocolatey is Experimental.
To use winget
to install the Databricks CLI, run the following two commands, and then restart your Command Prompt:
Bash
winget search databricks
winget install Databricks.DatabricksCLI
To use Chocolatey to install the Databricks CLI, run the following command:
Bash
choco install databricks-cli
To use WSL to install the Databricks CLI:
Install curl
and zip
through WSL. For more information, see your operating system's documentation.
Use WSL to install the Databricks CLI by running the following command:
Bash
curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh
Confirm that the Databricks CLI is installed by running the following command, which displays the current version of the installed Databricks CLI. This version should be 0.205.0 or above:
note
If you run databricks
but get an error such as command not found: databricks
, or if you run databricks -v
and a version number of 0.18 or below is listed, this means that your machine cannot find the correct version of the Databricks CLI executable. To fix this, see Verify your CLI installation.
Next, configure access to your Databricks workspace.
note
This tutorial uses OAuth user-to-machine (U2M) authentication to authenticate the CLI using your Databricks user account. To configure the CLI to use other Databricks authentication types, see Authentication for the Databricks CLI.
Use the Databricks CLI to initiate OAuth token management locally by running the following command for each target account or workspace.
For account-level operations, in the following command, replace the following placeholders:
<account-console-url>
with your Databricks https://accounts.cloud.databricks.com.<account-id>
with your Databricks account ID. See Locate your account ID.Bash
databricks auth login --host <account-console-url> --account-id <account-id>
For workspace-level operations, in the following command, replace <workspace-url>
with your Databricks workspace instance URL, for example https://dbc-a1b2345c-d6e7.cloud.databricks.com
.
Bash
databricks auth login --host <workspace-url>
The Databricks CLI prompts you to save the information that you entered as a Databricks configuration profile. Press Enter
to accept the suggested profile name, or enter the name of a new or existing profile. Any existing profile with the same name is overwritten with the information that you entered. You can use profiles to quickly switch your authentication context among multiple accounts or workspaces.
To get a list of any existing profiles, in a separate terminal or command prompt, use the Databricks CLI to run the command databricks auth profiles
. To view a specific profile's existing settings, run the command databricks auth env --profile <profile-name>
.
In your web browser, complete the on-screen instructions to log in to your Databricks account or workspace.
To view a profile's current OAuth token value and the token's upcoming expiration timestamp, run one of the following commands:
For account-level operations, run the following commands:
databricks auth token -p <profile-name>
databricks auth token --host <workspace-url> --account-id <account-id>
databricks auth token --host <workspace-url> --account-id <account-id> -p <profile-name>
If you have multiple profiles with the same --host
and --account-id
values, you might need to specify the --host
, --account-id
, and -p
options together to help the Databricks CLI find the correct matching OAuth token information.
For workspace-level operations, run the following commands:
databricks auth token -p <profile-name>
databricks auth token --host <workspace-url>
databricks auth token --host <workspace-url> -p <profile-name>
If you have multiple profiles with the same --host
values, you might need to specify the --host
and -p
options together to help the Databricks CLI find the correct matching OAuth token information.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4