Skip to main content

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 under active development and is released as an experimental client. This means that interfaces are still subject to change.

If you’re interested in contributing to the project please reach out. In addition, 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.3

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.3
File Size Uploaded Provenance Actions
databricks-cli-0.17.3.tar.gz 77.9 kB Without provenance Details for databricks-cli-0.17.3.tar.gz

Built distribution (wheel)

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

Total release size: 221.9 kB

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

Download URL databricks-cli-0.17.3.tar.gz
Size 77.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2f00f3e70e859809f0595885ec76fc73ba60ad0cccd69564f7df5d95b6c90066
BLAKE2b-256 checksum
How to use checksums
0d90c292931799688d2d790f4c738562eb274ad64f7b8dc6aee1cab25c7e590c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/2.7

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

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

Security for databricks-cli 0.17.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.17.3 This release

2 release files No provenance

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