Skip to content

experimental/ssh: improve --help copy and surface serverless flags#5156

Open
TanishqDatabricks wants to merge 1 commit intodatabricks:mainfrom
TanishqDatabricks:ssh-help-copy
Open

experimental/ssh: improve --help copy and surface serverless flags#5156
TanishqDatabricks wants to merge 1 commit intodatabricks:mainfrom
TanishqDatabricks:ssh-help-copy

Conversation

@TanishqDatabricks
Copy link
Copy Markdown

Summary

  • databricks ssh: common-workflows examples now lead with serverless (no flags), with the dedicated-cluster path as a follow-up.
  • databricks ssh connect: Long description groups example invocations by serverless vs dedicated. Unhides --name, --accelerator, --ide, --environment-version so users can discover them via --help.
  • databricks ssh setup: tightened Short/Long to clarify it's for dedicated clusters; users on serverless should just use connect.

CUJ: https://docs.google.com/document/d/1WnIg2vrnPR98cMay8OTY1zJ4yWcKBAHdZUXi5AhYylU/edit?tab=t.7erhv6e67uw#heading=h.kj99al6d2ch
Tracked at DECO-27026 (under epic DECO-27015 FY27Q2 P0 [IDE-Remote] CLI UX).

Test plan

  • Run databricks ssh --help and verify serverless examples appear first
  • Run databricks ssh connect --help and verify --name, --accelerator, --ide, --environment-version are visible (not hidden)
  • Run databricks ssh setup --help and verify it references dedicated clusters and points users to connect for serverless

This pull request and its description were written by Isaac.

Updates the help text for `databricks ssh`, `databricks ssh connect`, and
`databricks ssh setup` based on the May 1 2026 Remote Development CUJ.

- `databricks ssh`: common-workflows examples now lead with serverless
  (no flags), with the dedicated-cluster path as a follow-up.
- `databricks ssh connect`: Long description groups example invocations
  by serverless vs dedicated. Unhides --name, --accelerator, --ide,
  --environment-version so users can discover them via --help.
- `databricks ssh setup`: tightened Short/Long to clarify it's for
  dedicated clusters; users on serverless should just use connect.

Co-authored-by: Isaac
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

An authorized user can trigger integration tests manually by following the instructions below:

Trigger:
go/deco-tests-run/cli

Inputs:

  • PR number: 5156
  • Commit SHA: 4d4faffa426dc35e7a3ba0be04cb8cd4d4d0a32a

Checks will be approved automatically on success.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

Waiting for approval

Based on git history, these people are best suited to review:

  • @ilia-db -- recent work in experimental/ssh/cmd/

Eligible reviewers: @andrewnester, @anton-107, @denik, @pietern, @renaudhartert-db, @shreyas-goenka, @simonfaltum

Suggestions based on git history. See OWNERS for ownership rules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant