Start a shell into a workspace or run a command
Usagecoder ssh [flags] <workspace> [command]
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`. - Use `--` to separate and pass flags directly to the command executed via SSH.: $ coder ssh <workspace> -- ls -la
bool
Environment $CODER_SSH_STDIO
Specifies whether to emit SSH output over stdin/stdout.
--ssh-host-prefix Typestring
Environment $CODER_SSH_SSH_HOST_PREFIX
Strip this prefix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command.
--hostname-suffix Typestring
Environment $CODER_SSH_HOSTNAME_SUFFIX
Strip this suffix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. The suffix must be specified without a leading . character.
-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.
--workspace-poll-interval Typeduration
Environment $CODER_WORKSPACE_POLL_INTERVAL
Default 1m
Specifies how often to poll for workspace automated shutdown.
--wait Typeyes|no|auto
Environment $CODER_SSH_WAIT
Default auto
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
--no-wait Typebool
Environment $CODER_SSH_NO_WAIT
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
-l, --log-dir Typestring
Environment $CODER_SSH_LOG_DIR
Specify the directory containing SSH diagnostic log files.
-R, --remote-forward Typestring-array
Environment $CODER_SSH_REMOTE_FORWARD
Enable remote port forwarding (remote_port:local_address:local_port).
-e, --env Typestring-array
Environment $CODER_SSH_ENV
Set environment variable(s) for session (key1=value1,key2=value2,...).
--network-info-dirSpecifies a directory to write network information periodically.
--network-info-intervalSpecifies the interval to update network information.
--disable-autostart Typebool
Environment $CODER_SSH_DISABLE_AUTOSTART
Default false
Disable starting the workspace automatically when connecting via SSH.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4