docs: document SSH access for Jobs#2557
Open
Wauplin wants to merge 3 commits into
Open
Conversation
Document the new --ssh / ssh=True option that opens an interactive SSH session into a running Job, plus the new `hf jobs ssh <job_id>` command (with --dry-run and -i/--identity-file). Includes CLI and Python examples, the ssh://<job_id>@ssh.hf.jobs endpoint format, and access requirements (write access to the namespace + a registered SSH key). SSH is not billed on top of the job's hardware price. Complements #2551 which covers exposing ports. Co-Authored-By: Claude Opus 4.8 <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. |
XciD
approved these changes
Jun 12, 2026
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
julien-c
reviewed
Jun 12, 2026
julien-c
left a comment
julien-c
left a comment
Member
There was a problem hiding this comment.
does this use Expose Ports under the hood? (which would make sense i guess)
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.
Document
hf jobs ssh ...Depends on:
huggingface_hub1.20 to be released first.Details
Adds an SSH section to
docs/hub/jobs-configuration.mdwith:--sshflag (CLI) /ssh=True(Python API) to make a Job's container reachable over SSHhf jobs ssh <job_id>commandssh://<job_id>@ssh.hf.jobsendpointjob.status.ssh_urlattributessh -L/-R(e.g. access a TensorBoard running in a training Job, or let the Job reach a local resource)SSH is not billed.
SSH not supported for scheduled jobs.
🤖 Generated with Claude Code