2023-04-20 11:40:48 +00:00
|
|
|
# Bricks CLI
|
2022-05-13 13:30:22 +00:00
|
|
|
|
2023-04-20 11:40:48 +00:00
|
|
|
[](https://github.com/databricks/bricks/actions?query=workflow%3Abuild+branch%3Amain)
|
2022-05-16 11:02:12 +00:00
|
|
|
|
2023-04-20 11:40:48 +00:00
|
|
|
This project is in private preview.
|
2022-05-13 13:30:22 +00:00
|
|
|
|
2023-04-26 13:35:48 +00:00
|
|
|
Documentation about the full REST API coverage is avaialbe in the [docs folder](docs/commands.md).
|
|
|
|
|
|
2023-04-20 11:40:48 +00:00
|
|
|
Documentation is available at https://docs.databricks.com/dev-tools/cli/bricks-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.
|
2022-05-13 15:43:54 +00:00
|
|
|
|
2023-04-20 11:40:48 +00:00
|
|
|
For convenient access, copy the `bricks` binary to any directory listed in `$PATH`.
|
2022-05-13 15:43:54 +00:00
|
|
|
|
2023-04-20 11:40:48 +00:00
|
|
|
Confirm the binary works by executing `bricks version`.
|
2022-05-13 15:43:54 +00:00
|
|
|
|
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.
|
