ssh

ssh

Start a shell into a workspace

Usage

coder ssh [flags] <workspace>

Options

-A, --forward-agent

Typebool
Environment$CODER_SSH_FORWARD_AGENT

Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.

-G, --forward-gpg

Typebool
Environment$CODER_SSH_FORWARD_GPG

Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on both the client and workspace. The GPG agent must already be running locally and will not be started for you. If a GPG agent is already running in the workspace, it will be attempted to be killed.

--identity-agent

Typestring
Environment$CODER_SSH_IDENTITY_AGENT

Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.

--log-dir

Typestring
Environment$CODER_SSH_LOG_DIR
Default/tmp

Specify the location for the log files.

-l, --log-to-file

Typebool
Environment$CODER_SSH_LOG_TO_FILE

Enable diagnostic logging to file.

--no-wait

Typebool
Environment$CODER_SSH_NO_WAIT

Specifies whether to wait for a workspace to become ready before logging in (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.

--stdio

Typebool
Environment$CODER_SSH_STDIO

Specifies whether to emit SSH output over stdin/stdout.

--workspace-poll-interval

Typeduration
Environment$CODER_WORKSPACE_POLL_INTERVAL
Default1m

Specifies how often to poll for workspace automated shutdown.

See an opportunity to improve our docs? Make an edit.
On this page