https://github.com/databricks/setup-cli
Sets up the Databricks CLI in your GitHub Actions workflow.
https://github.com/databricks/setup-cli
Last synced: 4 months ago
JSON representation
Sets up the Databricks CLI in your GitHub Actions workflow.
- Host: GitHub
- URL: https://github.com/databricks/setup-cli
- Owner: databricks
- License: other
- Created: 2023-03-28T17:31:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-16T08:45:02.000Z (4 months ago)
- Last Synced: 2025-10-17T11:04:09.584Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 154 KB
- Stars: 17
- Watchers: 10
- Forks: 14
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# setup-cli
setup-cli makes it easy to install the [Databricks CLI](https://github.com/databricks/cli) in your environment.
It provides a composite GitHub Action and a portable installation script that can be used in most CI/CD systems and development environments.
Full documentation about installation can be found at:
* (AWS) https://docs.databricks.com/en/dev-tools/cli/install.html
* (Azure) https://learn.microsoft.com/en-us/azure/databricks/dev-tools/cli/install
* (GCP) https://docs.gcp.databricks.com/en/dev-tools/cli/install.html
## Usage
This repository contains an `install.sh` script that can be invoked to install the Databricks CLI.
To install the latest version, run the following command:
```bash
curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh
```
To install a specific version, you can replace `main` with a specific release tag:
```bash
curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/v0.273.0/install.sh | sh
```
## GitHub Actions
This repository can be used from GitHub Actions.
For a complete example of how to use the Databricks CLI in a GitHub Actions workflow, see the following guide:
* (AWS) https://docs.databricks.com/en/dev-tools/bundles/ci-cd.html
* (Azure) https://learn.microsoft.com/en-us/azure/databricks/dev-tools/bundles/ci-cd
* (GCP) https://docs.gcp.databricks.com/en/dev-tools/bundles/ci-cd.html
To always use the latest version of the Databricks CLI, use the action from the `main` branch:
```yml
- uses: databricks/setup-cli@main
```
In case you need to use a specific version of the Databricks CLI, use the action from a release tag:
```yml
- uses: databricks/setup-cli@v0.273.0
```
Replace the tag with the version you want to use.
Alternatively, you can specify the version as a parameter to the action:
```yml
- uses: databricks/setup-cli@main
with:
version: 0.273.0
```
## Preview notice
Please note that the Databricks CLI is in public preview as defined on
https://docs.databricks.com/en/release-notes/release-types.html.
This means that it has medium-to-high maturity and can be used in production.