Databricks CLI
Go to file
shreyas-goenka 10b245d10c
Move `ConfigUsed` to `libs/command` (#2440)
## Changes
This PR moves `ConfigUsed` from the root package to `libs/command`.

## Why
Having the ConfigUsed function in the root package is a problem because
that means we cannot use that function from outside the `root` package
since doing so often leads to an import cycle (because `root` imports
everything implicitly).

Moving it to a separate package that consolidates the read interaction
and solves the import cycle issue. Example where this would have
simplified code:
https://github.com/databricks/cli/pull/2432#discussion_r1983368092

I'd like to send PRs to do the same for the workspace client and account
client as well. I'll wait however until this one is merged incase people
have concerns about the approach here.

## Tests
Existing tests.
2025-03-06 17:08:55 +00:00
.codegen Enable Automated tagging workflow (#2361) 2025-03-06 15:30:01 +00:00
.github Enable Automated tagging workflow (#2361) 2025-03-06 15:30:01 +00:00
.vscode Update VSCode settings to resolve files named `script` as shell scripts (#2419) 2025-03-05 10:02:40 +00:00
acceptance Add libs/patchwheel: insert dynamic version in whl (#2427) 2025-03-06 10:28:30 +00:00
bundle Store DBR version in context (#2438) 2025-03-06 13:01:43 +00:00
cmd Move `ConfigUsed` to `libs/command` (#2440) 2025-03-06 17:08:55 +00:00
docker Followup improvements to the Docker setup script (#1369) 2024-04-18 20:52:11 +00:00
docs Removed autogenerated docs for the CLI commands (#1392) 2024-04-23 13:25:25 +00:00
integration Store DBR version in context (#2438) 2025-03-06 13:01:43 +00:00
internal Add the `auth.ProcessEnv` function (#2404) 2025-03-04 14:47:11 +00:00
libs Move `ConfigUsed` to `libs/command` (#2440) 2025-03-06 17:08:55 +00:00
.codegen.json Enable Automated tagging workflow (#2361) 2025-03-06 15:30:01 +00:00
.git-blame-ignore-revs Add .git-blame-ignore-revs with linter-related mass change commits (#2000) 2024-12-12 10:54:00 +01:00
.gitattributes Bump github.com/databricks/databricks-sdk-go from 0.56.1 to 0.57.0 (#2321) 2025-02-10 12:50:52 +00:00
.gitignore add .idea to .gitignore (#2375) 2025-02-25 12:17:50 +00:00
.golangci.yaml Fix incorrect TestingT.Errorf usage and enable linting for this (#2182) 2025-01-20 08:07:42 +00:00
.goreleaser.yaml Address goreleaser deprecation warning (#1872) 2024-10-31 12:09:23 +00:00
.mockery.yaml Use mockery to generate mocks compatible with testify/mock (#1190) 2024-02-08 15:18:53 +00:00
.package.json Enable Automated tagging workflow (#2361) 2025-03-06 15:30:01 +00:00
CHANGELOG.md [Release] Release v0.243.0 (#2435) 2025-03-05 15:42:40 +00:00
Dockerfile Followup improvements to the Docker setup script (#1369) 2024-04-18 20:52:11 +00:00
LICENSE Trim trailing whitespace (#1206) 2024-02-15 16:23:48 +00:00
Makefile Disable ruff cache (#2430) 2025-03-05 08:45:51 +01:00
NEXT_CHANGELOG.md Enable Automated tagging workflow (#2361) 2025-03-06 15:30:01 +00:00
NOTICE acc: Allow mixing custom stubs with default server impl (#2334) 2025-02-11 15:03:41 +00:00
README.md Add privacy notice to README (#1841) 2024-10-28 18:19:55 +00:00
go.mod Upgrade Go SDK to 0.59.0 (#2425) 2025-03-05 10:20:51 +00:00
go.sum Upgrade Go SDK to 0.59.0 (#2425) 2025-03-05 10:20:51 +00:00
main.go Add regression tests for CLI error output (#1566) 2024-07-10 06:38:06 +00:00
main_test.go Fix ability to import the CLI repository as module (#1671) 2024-08-12 14:20:04 +00:00
ruff.toml Enable Automated tagging workflow (#2361) 2025-03-06 15:30:01 +00:00
tagging.py Enable Automated tagging workflow (#2361) 2025-03-06 15:30:01 +00:00

README.md

Databricks CLI

build

This project is in Public Preview.

Documentation is available at https://docs.databricks.com/dev-tools/cli/databricks-cli.html.

Installation

This CLI is packaged as a dependency-free binary executable and may be located in any directory. See https://github.com/databricks/cli/releases for releases and the Databricks documentation for detailed information about installing the CLI.


Homebrew

We maintain a Homebrew tap for installing the Databricks CLI. You can find instructions for how to install, upgrade and downgrade the CLI using Homebrew here.


Docker

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

Authentication

This CLI follows the Databricks Unified Authentication principles.

You can find a detailed description at https://github.com/databricks/databricks-sdk-go#authentication.

Privacy Notice

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.