Function newSSHCmd

pkg/cmd/codespace/ssh.go:49–144

(app *App)

}

func newSSHCmd(app *App) *cobra.Command {
	var opts sshOptions

	sshCmd := &cobra.Command{
		Use:   "ssh [<flags>...] [-- <ssh-flags>...] [<command>]",
		Short: "SSH into a codespace",
		Long: heredoc.Docf(`
			The %[1]sssh%[1]s command is used to SSH into a codespace. In its simplest form, you can
			run %[1]sgh cs ssh%[1]s, select a codespace interactively, and connect.

			The %[1]sssh%[1]s command will automatically create a public/private ssh key pair in the
			%[1]s~/.ssh%[1]s directory if you do not have an existing valid key pair. When selecting the
			key pair to use, the preferred order is:

			1. Key specified by %[1]s-i%[1]s in %[1]s<ssh-flags>%[1]s
			2. Automatic key, if it already exists
			3. First valid key pair in ssh config (according to %[1]sssh -G%[1]s)
			4. Automatic key, newly created

			The %[1]sssh%[1]s command also supports deeper integration with OpenSSH using a %[1]s--config%[1]s
			option that generates per-codespace ssh configuration in OpenSSH format.
			Including this configuration in your %[1]s~/.ssh/config%[1]s improves the user experience
			of tools that integrate with OpenSSH, such as Bash/Zsh completion of ssh hostnames,
			remote path completion for %[1]sscp/rsync/sshfs%[1]s, %[1]sgit%[1]s 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 %[1]sssh%[1]s, not %[1]sgh cs ssh%[1]s).

			Note that the codespace you are connecting to must have an SSH server pre-installed.
			If the docker image being used for the codespace does not have an SSH server,
			install it in your %[1]sDockerfile%[1]s or, for codespaces that use Debian-based images,
			you can add the following to your %[1]sdevcontainer.json%[1]s:

				"features": {
					"ghcr.io/devcontainers/features/sshd:1": {
						"version": "latest"
					}
				}
		`, "`"),
		Example: heredoc.Doc(`
			$ gh codespace ssh

			$ gh codespace ssh --config > ~/.ssh/codespaces
			$ printf 'Match all\nInclude ~/.ssh/codespaces\n' >> ~/.ssh/config
		`),
		PreRunE: func(c *cobra.Command, args []string) error {
			if opts.stdio {
				if opts.selector.codespaceName == "" {
					return errors.New("`--stdio` requires explicit `--codespace`")
				}
				if opts.config {
					return errors.New("cannot use `--stdio` with `--config`")
				}
				if opts.serverPort != 0 {
					return errors.New("cannot use `--stdio` with `--server-port`")
				}
				if opts.profile != "" {
					return errors.New("cannot use `--stdio` with `--profile`")