1aa9e32a2b
This adds a flag matching `--ssh-host-prefix` from `coder config-ssh` to `coder ssh`. By trimming a custom prefix from the argument, we can set up wildcard-based `Host` entries in SSH config for the IDE plugins (and eventually `coder config-ssh`). We also replace `--` in the argument with `/`, so ownership can be specified in wildcard-based SSH hosts like `<owner>--<workspace>`. Replaces #16087. Part of https://github.com/coder/coder/issues/14986. Related to https://github.com/coder/coder/pull/16078 and https://github.com/coder/coder/pull/16080.
4.8 KiB
Generated
ssh
Start a shell into a workspace
Usage
coder ssh [flags] <workspace>
Options
--stdio
| Type | bool |
| Environment | $CODER_SSH_STDIO |
Specifies whether to emit SSH output over stdin/stdout.
--ssh-host-prefix
| Type | string |
| 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.
-A, --forward-agent
| Type | bool |
| Environment | $CODER_SSH_FORWARD_AGENT |
Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
-G, --forward-gpg
| Type | bool |
| 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
| Type | string |
| Environment | $CODER_SSH_IDENTITY_AGENT |
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
--workspace-poll-interval
| Type | duration |
| Environment | $CODER_WORKSPACE_POLL_INTERVAL |
| Default | 1m |
Specifies how often to poll for workspace automated shutdown.
--wait
| Type | yes|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
| Type | bool |
| 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
| Type | string |
| Environment | $CODER_SSH_LOG_DIR |
Specify the directory containing SSH diagnostic log files.
-R, --remote-forward
| Type | string-array |
| Environment | $CODER_SSH_REMOTE_FORWARD |
Enable remote port forwarding (remote_port:local_address:local_port).
-e, --env
| Type | string-array |
| Environment | $CODER_SSH_ENV |
Set environment variable(s) for session (key1=value1,key2=value2,...).
--network-info-dir
| Type | string |
Specifies a directory to write network information periodically.
--network-info-interval
| Type | duration |
| Default | 5s |
Specifies the interval to update network information.
--disable-autostart
| Type | bool |
| Environment | $CODER_SSH_DISABLE_AUTOSTART |
| Default | false |
Disable starting the workspace automatically when connecting via SSH.