Method ssh

cli/ssh.go:116–887

()

}

func (r *RootCmd) ssh() *serpent.Command {
	var (
		stdio               bool
		tty                 bool
		hostPrefix          string
		hostnameSuffix      string
		forceNewTunnel      bool
		forwardAgent        bool
		forwardGPG          bool
		identityAgent       string
		wsPollInterval      time.Duration
		waitEnum            string
		noWait              bool
		logDirPath          string
		remoteForwards      []string
		env                 []string
		usageApp            string
		disableAutostart    bool
		networkInfoDir      string
		networkInfoInterval time.Duration

		containerName string
		containerUser string
	)
	cmd := &serpent.Command{
		Annotations: workspaceCommand,
		Use:         "ssh <workspace> [command]",
		Short:       "Start a shell into a workspace or run a command",
		Long: "This command does not have full parity with the standard SSH command. For users who need the full functionality of SSH, create an ssh configuration with `coder config-ssh`.\n\n" +
			FormatExamples(
				Example{
					Description: "Use `--` to separate and pass flags directly to the command executed via SSH.",
					Command:     "coder ssh <workspace> -- ls -la",
				},
			),
		Middleware: serpent.Chain(
			// Require at least one arg for the workspace name
			func(next serpent.HandlerFunc) serpent.HandlerFunc {
				return func(i *serpent.Invocation) error {
					got := len(i.Args)
					if got < 1 {
						return xerrors.New("expected the name of a workspace")
					}

					return next(i)
				}
			},
		),
		CompletionHandler: func(inv *serpent.Invocation) []string {
			client, err := r.InitClient(inv)
			if err != nil {
				return []string{}
			}

			res, err := client.Workspaces(inv.Context(), codersdk.WorkspaceFilter{
				Owner: codersdk.Me,
			})
			if err != nil {