GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
GH-CODESPACE-SSH(1) GitHub CLI manual GH-CODESPACE-SSH(1)

gh-codespace-ssh - SSH into a codespace

gh codespace ssh [<flags>...] [-- <ssh-flags>...] [<command>]

The 'ssh' command is used to SSH into a codespace. In its simplest form, you can run 'gh cs ssh', select a codespace interactively, and connect.

The 'ssh' command also supports deeper integration with OpenSSH using a format. Including this configuration in your ~/.ssh/config improves the user experience of tools that integrate with OpenSSH, such as bash/zsh completion of ssh hostnames, remote path completion for scp/rsync/sshfs, git ssh remotes, and so on.

Once that is set up (see the second example below), you can ssh to codespaces as if they were ordinary remote hosts (using 'ssh', not 'gh cs ssh').

-c, --codespace <string>
Name of the codespace

--config
Write OpenSSH configuration to stdout

-d, --debug
Log debug data to a file

--debug-file <string>
Path of the file log to

--profile <string>
Name of the SSH profile to use

--server-port <int>
SSH server port number (0 => pick unused)

$ gh codespace ssh
$ gh codespace ssh --config > ~/.ssh/codespaces
$ echo 'include ~/.ssh/codespaces' >> ~/.ssh/config'

gh-codespace(1)
May 2022

Search for    or go to Top of page |  Section 1 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.