2023-05-16 16:35:39 +00:00
# Databricks CLI
2022-05-13 13:30:22 +00:00
2023-05-16 16:35:39 +00:00
[![build ](https://github.com/databricks/cli/workflows/build/badge.svg?branch=main )](https://github.com/databricks/cli/actions?query=workflow%3Abuild+branch%3Amain)
2022-05-16 11:02:12 +00:00
2023-06-21 18:26:09 +00:00
This project is in Public Preview.
2022-05-13 13:30:22 +00:00
2023-06-21 18:26:09 +00:00
Documentation about the full REST API coverage is available in the [docs folder ](docs/commands.md ).
2023-04-26 13:35:48 +00:00
2023-05-22 14:40:50 +00:00
Documentation is available at https://docs.databricks.com/dev-tools/cli/databricks-cli.html.
2022-05-13 15:43:54 +00:00
2023-04-20 11:40:48 +00:00
## Installation
2022-05-13 15:43:54 +00:00
2023-04-20 11:40:48 +00:00
This CLI is packaged as a dependency-free binary executable and may be located in any directory.
2023-06-12 14:31:22 +00:00
See https://github.com/databricks/cli/releases for releases and
[the docs pages ](https://docs.databricks.com/dev-tools/cli/databricks-cli.html ) for
installation instructions.
2022-05-13 15:43:54 +00:00
2024-05-14 10:58:55 +00:00
------
You can use the CLI via a Docker image by pulling the image from `ghcr.io` . You can find all available versions
at: https://github.com/databricks/cli/pkgs/container/cli.
```
docker pull ghcr.io/databricks/cli:latest
```
Example of how to run the CLI using the Docker image. More documentation is available at https://docs.databricks.com/dev-tools/bundles/airgapped-environment.html.
```
docker run -e DATABRICKS_HOST=$YOUR_HOST_URL -e DATABRICKS_TOKEN=$YOUR_TOKEN ghcr.io/databricks/cli:latest current-user me
```
2023-04-20 11:40:48 +00:00
## Authentication
2022-05-14 17:56:09 +00:00
2023-04-20 11:40:48 +00:00
This CLI follows the Databricks Unified Authentication principles.
You can find a detailed description at https://github.com/databricks/databricks-sdk-go#authentication.