Add databricks quickstart command#5464
Merged
Merged
Conversation
Introduce a top-level `databricks quickstart` command that prints a short introduction to the CLI: authentication, profile selection, building with Databricks Asset Bundles, and where to go next. It prints a human-friendly guide by default and a denser, agent-oriented version when run in a non-interactive terminal (for example, when invoked by a coding agent). The detection uses cmdio.IsPromptSupported and is intentionally simple for now, leaving room for smarter agent detection later. Co-authored-by: Isaac
Co-authored-by: Isaac
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Collaborator
|
Commit: 99473a3
24 interesting tests: 15 SKIP, 7 KNOWN, 2 flaky
Top 27 slowest tests (at least 2 minutes):
|
mihaimitrea-db
approved these changes
Jun 8, 2026
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
On Windows the embedded quickstart markdown was checked out with CRLF, so stripFrontmatter (which matches an LF fence "---\n") left the skill frontmatter in the output. That broke the unit test and the acceptance golden on Windows only. Add a .gitattributes forcing eol=lf for these go:embed files so the embedded content is identical on every platform, matching the existing convention in acceptance/ and integration/. Also switch stripFrontmatter from strings.Index to strings.Cut to fix the failing modernize lint check. Co-authored-by: Isaac Signed-off-by: simonfaltum <simon.faltum@databricks.com>
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
deco-sdk-tagging Bot
added a commit
that referenced
this pull request
Jun 10, 2026
## Release v1.3.0 ### Notable Changes * The `direct` deployment engine is now Generally Available and the default for new deployments. To opt out, set `engine: terraform` under `bundle` in your `databricks.yml` or set `DATABRICKS_BUNDLE_ENGINE=terraform`. Existing deployments keep their current engine; see https://docs.databricks.com/aws/en/dev-tools/bundles/direct to migrate. ### CLI * Added the `databricks quickstart` command, a short introduction to the CLI that prints a human-friendly guide interactively and an agent-oriented version when run non-interactively ([#5464](#5464)). * Add `databricks version --check` to report whether a newer CLI version is available and print the upgrade command for the detected install method ([#5469](#5469)). * `databricks auth describe` now verifies credentials against both the workspace and account endpoints before reporting a failure, fixing false "Unable to authenticate" errors for account console profiles ([#5479](#5479)). * `databricks auth login` no longer prompts for workspace selection when logging in to an account console host (`https://accounts.*`). Pass `--workspace-id` explicitly to store a workspace ID on such a profile ([#5504](#5504)). * `databricks auth profiles --skip-validate` no longer makes any network calls; the host metadata fetch is skipped along with validation ([#5530](#5530)). ### Bundles * Set the default `data_security_mode` to `DATA_SECURITY_MODE_AUTO` in bundle templates ([#5452](#5452)). * Mark vector search index index_subtype as backend_default to prevent drift after deployment ([#5454](#5454)). * `bundle deployment migrate`: handle resources added to or removed from `databricks.yml` since the last Terraform deploy ([#5463](#5463)). * Add the `genie_spaces` bundle resource for managing Databricks Genie spaces as code, plus `bundle generate genie-space` to import an existing space. Direct deployment engine only ([#5282](#5282)). * Fix spurious recreate of schemas and volumes whose names use mixed case ([#5531](#5531)).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Someone running the Databricks CLI for the first time has no built-in starting point. They have to go find docs, work out auth and profiles, and guess at how to actually build something.
databricks quickstartgives them a short, opinionated introduction right in the terminal.It serves coding agents too: an agent with no Databricks skill loaded can run
databricks quickstartto orient itself (auth, profiles, building with Asset Bundles) before attempting work.Changes
Before: there was no
quickstartcommand.Now:
databricks quickstartprints a short introduction covering authentication, profile selection, building with Databricks Asset Bundles, and where to go next.cmd/quickstartpackage, registered incmd/cmd.go.quickstart-human.md(the default) andquickstart-agent.md(denser and agent-oriented; it is also thedatabricks-quickstartskill, so its YAML frontmatter is stripped before printing).cmdio.IsPromptSupportedand is deliberately simple for now, leaving room for smarter agent detection later.Test plan
cmd/quickstart/quickstart_test.go).acceptance/quickstart); root-help golden updated to include the new command../task fmt-q,./task lint-q, and./task checksall clean.databricks quickstartnon-interactively to confirm the agent version prints with frontmatter stripped.This pull request and its description were written by Isaac.