Skip to main content

Note

Databricks recommends that you use newer Databricks CLI versions 0.200 and above instead of legacy Databricks CLI versions 0.17 and below (located in this repository). You can find the new CLI at https://github.com/databricks/cli.

If you have been using the code in this repository as a Python SDK for interacting with the Databricks APIs, we recommend you use the new dedicated SDK package that can be found at https://github.com/databricks/databricks-sdk-py.

databricks-cli

Build status https://codecov.io/gh/databricks/databricks-cli/branch/main/graph/badge.svg

The Databricks Command Line Interface (CLI) is an open source tool which provides an easy to use interface to the Databricks platform. The CLI is built on top of the Databricks REST APIs.

Note: This CLI is no longer under active development and has been released as an experimental client.

Please leave bug reports as issues on our GitHub project.

Requirements

  • Python Version > 2.7.9 or > 3.6

Installation

To install simply run pip install --upgrade databricks-cli

Then set up authentication using username/password or authentication token. Credentials are stored at ~/.databrickscfg.

  • databricks configure (enter hostname/username/password at prompt)

  • databricks configure --token (enter hostname/auth-token at prompt)

Multiple connection profiles are also supported with databricks configure --profile <profile> [--token]. The connection profile can be used as such: databricks workspace ls --profile <profile>.

To test that your authentication information is working, try a quick test like databricks workspace ls.

Known Issues

AttributeError: 'module' object has no attribute 'PROTOCOL_TLSv1_2'

The Databricks web service requires clients speak TLSV1.2. The built in version of Python for MacOS does not have this version of TLS built in.

To use the Databricks CLI you must install a version of Python that has ssl.PROTOCOL_TLSv1_2. For MacOS, the easiest way may be to install Python with Homebrew.

Using Docker

# build image
docker build -t databricks-cli .

# run container
docker run -it databricks-cli

# run command in docker
docker run -it databricks-cli fs --help

Documentation

For the latest CLI documentation, see

Metadata

Release files for databricks-cli 0.17.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for databricks-cli 0.17.8
File Size Uploaded
databricks-cli-0.17.8.tar.gz 85.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for databricks-cli 0.17.8
File Interpreter ABI Platform
databricks_cli-0.17.8-py2-none-any.whl Python 2 none any Details

Total release size: 235.6 kB

Release files / databricks-cli-0.17.8.tar.gz

Download URL databricks-cli-0.17.8.tar.gz
Size 85.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1d5ef6520ea3ed403d58f24538641bd8eeb163621f5054205fcf643578698579
BLAKE2b-256 checksum
How to use checksums
0b5fe032f8679bf4c7f88ac68d285b0caa53bf428127e5e60dd7e6c99585f582
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/2.7

Release files / databricks_cli-0.17.8-py2-none-any.whl

Download URL databricks_cli-0.17.8-py2-none-any.whl
Size 150.4 kB
Tags Python 2
SHA-256 checksum
How to use checksums
dfb7d3aeec17489b6051789bf7321694d875ea487be8652f8f58fabceead7d9e
BLAKE2b-256 checksum
How to use checksums
afd0d14ec29bef1b012e3585704e1c1396b15fdf6d86b65090177d8f4598a24f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/2.7

Release history Release notifications | RSS feed

This release

0.17.8 This release

2 release files

0.17.6

2 release files

0.17.5

2 release files

0.17.3

2 release files

0.17.2

2 release files

0.17.1

2 release files

0.17.0

2 release files

0.16.8

2 release files

0.16.7

2 release files

0.16.5

2 release files

0.16.2

2 release files

0.16.1

2 release files

0.16.0

2 release files

0.14.3

2 release files

0.14.2

2 release files

0.14.1

2 release files

0.13.0

2 release files

0.12.2

2 release files

0.12.1

1 release file

0.12.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.7

2 release files

0.8.6

2 release files

0.8.5

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page