config-ssh
config-ssh
Add an SSH Host entry for your workspaces "ssh coder.workspace"
Usage
coder config-ssh [flags]
Description
- You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:
$ coder config-ssh -o ForwardAgent=yes
- You can use --dry-run (or -n) to see the changes that would be made:
$ coder config-ssh --dry-run
Options
--ssh-config-file
| Type | string |
| Environment | $CODER_SSH_CONFIG_FILE |
| Default | ~/.ssh/config |
Specifies the path to an SSH config.
--coder-binary-path
| Type | string |
| Environment | $CODER_SSH_CONFIG_BINARY_PATH |
Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.
-o, --ssh-option
| Type | string-array |
| Environment | $CODER_SSH_CONFIG_OPTS |
Specifies additional SSH options to embed in each host stanza.
-n, --dry-run
| Type | bool |
| Environment | $CODER_SSH_DRY_RUN |
Perform a trial run with no changes made, showing a diff at the end.
--use-previous-options
| Type | bool |
| Environment | $CODER_SSH_USE_PREVIOUS_OPTIONS |
Specifies whether or not to keep options from previous run of config-ssh.
--ssh-host-prefix
| Type | string |
| Environment | $CODER_CONFIGSSH_SSH_HOST_PREFIX |
Override the default host prefix.
--wait
| Type | enum[yes|no|auto] |
| Environment | $CODER_CONFIGSSH_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.
--disable-autostart
| Type | bool |
| Environment | $CODER_CONFIGSSH_DISABLE_AUTOSTART |
| Default | false |
Disable starting the workspace automatically when connecting via SSH.
-y, --yes
| Type | bool |
Bypass prompts.
See an opportunity to improve our docs? Make an edit.
On this page