Document hf spaces ssh in the Spaces Dev Mode guide#2534
Merged
Conversation
Add a CLI shortcut to the Dev Mode SSH section: `hf spaces ssh` resolves the Space subdomain and opens the session for you, with `--dry-run` and `-i` examples plus an `--auto` note. Complements the existing manual `ssh <subdomain>@ssh.hf.space` instructions; the existing "register your SSH key" line covers the prerequisite for both paths. Added in huggingface_hub v1.17.0 (huggingface/huggingface_hub#4241). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
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. |
Member
Author
|
cc @Wauplin @hanouticelina (sorry on a bit of a docs alignment sprint today...) |
Wauplin
approved these changes
Jun 4, 2026
Wauplin
left a comment
Contributor
There was a problem hiding this comment.
(sorry on a bit of a docs alignment sprint today...)
Thanks a lot for taking care of these!
pcuenca
reviewed
Jun 4, 2026
|
|
||
| ```shell | ||
| # SSH into the Space's Dev Mode container | ||
| hf spaces ssh username/my-space |
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
4 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.
What
Adds the
hf spaces sshCLI command to the SSH section of the Spaces Dev Modeguide. It resolves the Space subdomain and opens the session for you — a
shortcut to the existing manual
ssh <subdomain>@ssh.hf.spaceflow.Examples added: basic connect,
--dry-run(print the command instead ofconnecting),
-i(identity file), and an--autonote (enable Dev Mode withoutprompting), plus a link to the
hf spaces sshCLI reference (the page didn'tpreviously link to the CLI docs). The existing "register your SSH public key at
/settings/keys" line already covers the prerequisite for both the manual and CLI
paths.
Added in huggingface_hub v1.17.0 (huggingface/huggingface_hub#4241).
Verified against live v1.17.0
--dry-runprintsssh <namespace>-<repo>@ssh.hf.space— matches thesubdomain form already documented above it
--autoenables Dev Mode without prompting🤖 Generated with Claude Code
Note
Low Risk
Documentation-only change with no runtime or security impact.
Overview
The Spaces Dev Mode guide’s SSH section now documents
hf spaces sshas a shortcut that resolves the Space subdomain and opens the session, alongside the existing manualssh <subdomain>@ssh.hf.spaceflow.New shell examples cover basic connect,
--dry-run,-ifor an identity file, and a note on--autoto enable Dev Mode without prompting. A link to thehf spaces sshCLI reference was added; prerequisite SSH key setup is unchanged.Reviewed by Cursor Bugbot for commit 4907909. Bugbot is set up for automated code reviews on this repo. Configure here.