Skip to content

experimental/ssh: improve --help copy for ssh commands#5325

Open
TanishqDatabricks wants to merge 6 commits into
databricks:mainfrom
TanishqDatabricks:ssh-help-copy-clean
Open

experimental/ssh: improve --help copy for ssh commands#5325
TanishqDatabricks wants to merge 6 commits into
databricks:mainfrom
TanishqDatabricks:ssh-help-copy-clean

Conversation

@TanishqDatabricks
Copy link
Copy Markdown

Summary

  • Updates help text for databricks ssh, databricks ssh connect, and databricks ssh setup to reflect current workflows (serverless-first, dedicated clusters as follow-up)
  • Unhides --name, --accelerator, --ide, and --environment-version flags on connect so users can discover them via --help
  • Tightens setup description to clarify it's for dedicated clusters only

Test plan

  • databricks ssh --help, databricks ssh connect --help, databricks ssh setup --help show updated copy

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
Contributor

ghost commented May 25, 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.

@TanishqDatabricks TanishqDatabricks marked this pull request as draft May 25, 2026 20:08
@TanishqDatabricks TanishqDatabricks marked this pull request as ready for review May 25, 2026 20:08
@anton-107 anton-107 self-requested a review May 26, 2026 07:02
Copy link
Copy Markdown
Contributor

@anton-107 anton-107 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for cleaning up the help copy — direction is right. A few changes before merging:

1. Keep --environment-version hidden

This flag still isn't ready for users to discover via --help. Please restore cmd.Flags().MarkHidden("environment-version") in experimental/ssh/cmd/connect.go.

Unhiding --name, --accelerator, and --ide is fine.

2. Misaligned # comments in ssh.go workflow block

The first example uses two tabs before #, the other two use spaces. Actual rendered output of databricks ssh --help:

  databricks ssh connect --ide=cursor                       		# connect to serverless through Cursor
  databricks ssh setup --name=<connection> --cluster=<cluster-id>   # update ~/.ssh/config so you can reconnect to a dedicated cluster
  ssh <connection>                                                  # connect to dedicated cluster after setup

The first # lands ~4 columns to the right of the other two (tab expands to the next 8-column tabstop). Replace the tabs with spaces so all three # align.

Same nit in connect.go: databricks ssh connect --accelerator=<GPU_type>\t# AI Runtime uses a tab. Renders fine in isolation but is inconsistent — spaces would be cleaner.

3. Inconsistent placeholder: <name> vs <connection>

  • ssh setup --help: `ssh <name>`
  • ssh --help workflow: ssh <connection> and --name=<connection>

Pick one. <name> matches the flag name; <connection> reads as a concept but loses the link. Either is fine — just be consistent across both files.

Test plan

The PR's test plan checkbox is unchecked. Please run all three --help outputs and eyeball them before re-requesting review — that's what caught issue #2 here.

@github-actions
Copy link
Copy Markdown
Contributor

ghost commented May 26, 2026

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

Trigger:
go/deco-tests-run/cli

Inputs:

  • PR number: 5325
  • Commit SHA: d7da1cc9fbfc8de630e651bdf30df2c51d3f38dd

Checks will be approved automatically on success.

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.

2 participants