docs(spaces-dev-mode): surface SSH command, lead with SSH over VS Code#2488
Merged
Conversation
SSH is the underlying connection mechanism — VS Code rides on top of it — but the page currently mentions VS Code first and tells readers to find the SSH instructions in the UI modal. Reframe the intro accordingly and show the actual `ssh <subdomain>@ssh.hf.space` command plus a snippet to fetch the subdomain via `HfApi.space_info()`, so anyone reading the docs (humans or agents) can connect without going through the UI.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
mishig25
reviewed
May 20, 2026
mishig25
reviewed
May 20, 2026
| The Dev Mode allows you to update your Space much quicker by overriding the Docker image. | ||
|
|
||
| The Dev Mode Docker image starts your application as a sub-process, allowing you to restart it without stopping the Space container itself. It also starts a VS Code server and a SSH server in the background for you to connect to the Space. | ||
| The Dev Mode Docker image starts your application as a sub-process, allowing you to restart it without stopping the Space container itself. It also starts an SSH server (and a VS Code server on top of it) in the background, so you can connect to the Space from any editor or terminal. |
Collaborator
There was a problem hiding this comment.
Nit: "VS Code on top of SSH" only holds for local VS Code/Cursor. The in-product VS Code (web) option is served over HTTPS, not SSH.
mishig25
approved these changes
May 20, 2026
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.
Summary
ssh <subdomain>@ssh.hf.spacecommand and a snippet to derive the subdomain, instead of pointing at the UI modal.Why
Today the SSH command lives only in the UI modal — invisible to agents and scripts reading the doc. A Codex agent recently spent ~15 min working around a VS Code marketplace 429 because the page made Dev Mode look VS-Code-shaped; once told "just SSH" it connected immediately.
Docs only.
Note
Low Risk
Low risk docs-only changes that clarify how to connect via SSH/VS Code; no product code or behavior is modified.
Overview
Updates the Spaces Dev Mode docs to lead with SSH as the primary connection mechanism, clarifying that VS Code/editor access is layered on top of the same SSH endpoint.
Adds an explicit
ssh <space-subdomain>@ssh.hf.spacecommand plus a smallhuggingface_hubsnippet to fetch the Space subdomain programmatically, and rewords the intro to distinguish the SSH server (local editors/terminals) from the in-product VS Code Web server.Reviewed by Cursor Bugbot for commit 5e4daf6. Bugbot is set up for automated code reviews on this repo. Configure here.