databricks-cli/README.md

# Databricks CLI

[![build](https://github.com/databricks/cli/workflows/build/badge.svg?branch=main)](https://github.com/databricks/cli/actions?query=workflow%3Abuild+branch%3Amain)

This project is in public preview.

Documentation about the full REST API coverage is avaialbe in the [docs folder](docs/commands.md).

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 docs pages](https://docs.databricks.com/dev-tools/cli/databricks-cli.html) for
installation instructions.

## Authentication

This CLI follows the Databricks Unified Authentication principles.

You can find a detailed description at https://github.com/databricks/databricks-sdk-go#authentication.
Rename bricks -> databricks (#389) ## Changes Rename all instances of "bricks" to "databricks". ## Tests * Confirmed the goreleaser build works, uses the correct new binary name, and produces the right archives. * Help output is confirmed to be correct. * Output of `git grep -w bricks` is minimal with a couple changes remaining for after the repository rename. 2023-05-16 16:35:39 +00:00			`# Databricks CLI`
Initial commit 2022-05-13 13:30:22 +00:00
Rename bricks -> databricks (#389) ## Changes Rename all instances of "bricks" to "databricks". ## Tests * Confirmed the goreleaser build works, uses the correct new binary name, and produces the right archives. * Help output is confirmed to be correct. * Output of `git grep -w bricks` is minimal with a couple changes remaining for after the repository rename. 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)`
run tests on push or PR 2022-05-16 11:02:12 +00:00
Update README to reflect public preview status (#491) 2023-06-16 14:37:10 +00:00			`This project is in public preview.`
Initial commit 2022-05-13 13:30:22 +00:00
Added `bricks` OpenAPI commands (#362) Adds documentation for generated commands 2023-04-26 13:35:48 +00:00			`Documentation about the full REST API coverage is avaialbe in the [docs folder](docs/commands.md).`

Rename: bricks -> databricks (#393) ## Changes related to https://github.com/databricks/databricks-vscode/pull/721 ## Rename env vars `BRICKS_CLI_PATH` -> `DATABRICKS_CLI_PATH` `BRICKS_OUTPUT_FORMAT` -> `DATABRICKS_OUTPUT_FORMAT` `BRICKS_LOG_FILE` -> `DATABRICKS_LOG_FILE` `BRICKS_LOG_LEVEL` -> `DATABRICKS_LOG_LEVEL` `BRICKS_LOG_FORMAT` -> `DATABRICKS_LOG_FORMAT` `BRICKS_PROGRESS_FORMAT` -> `DATABRICKS_CLI_PROGRESS_FORMAT` `BRICKS_UPSTREAM` -> `DATABRICKS_CLI_UPSTREAM` `BRICKS_UPSTREAM_VERSION` -> `DATABRICKS_CLI_UPSTREAM_VERSION` 2023-05-22 14:40:50 +00:00			`Documentation is available at https://docs.databricks.com/dev-tools/cli/databricks-cli.html.`
Added `launch` command and release pipeline 2022-05-13 15:43:54 +00:00
Update README (#350) ## Changes It was out of date. Update with a link to the preview documentation. --------- Co-authored-by: Miles Yucht <miles@databricks.com> 2023-04-20 11:40:48 +00:00			`## Installation`
Added `launch` command and release pipeline 2022-05-13 15:43:54 +00:00
Update README (#350) ## Changes It was out of date. Update with a link to the preview documentation. --------- Co-authored-by: Miles Yucht <miles@databricks.com> 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.`
Add installation instructions (#458) ## Changes Add installation instructions to the README. 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.`
Added `launch` command and release pipeline 2022-05-13 15:43:54 +00:00
Update README (#350) ## Changes It was out of date. Update with a link to the preview documentation. --------- Co-authored-by: Miles Yucht <miles@databricks.com> 2023-04-20 11:40:48 +00:00			`## Authentication`
updated dependencies 2022-05-14 17:56:09 +00:00
Update README (#350) ## Changes It was out of date. Update with a link to the preview documentation. --------- Co-authored-by: Miles Yucht <miles@databricks.com> 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.`