2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
# config-ssh
2025-06-02 20:13:08 -07:00
Add an SSH Host entry for your workspaces "ssh workspace.coder"
2023-03-23 17:42:20 -05:00
## Usage
```console
coder config-ssh [flags]
```
## Description
```console
- You can use -o (or --ssh-option) so set SSH options to be used for all your
2023-09-07 17:28:22 -04:00
workspaces:
2023-03-23 17:42:20 -05:00
2023-09-07 17:28:22 -04:00
$ coder config-ssh -o ForwardAgent=yes
2023-03-23 17:42:20 -05:00
- You can use --dry-run (or -n) to see the changes that would be made:
2023-09-07 17:28:22 -04:00
$ coder config-ssh --dry-run
2023-03-23 17:42:20 -05:00
```
## Options
### --ssh-config-file
| | |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> |
Specifies the path to an SSH config.
2024-03-15 11:24:38 -05:00
### --coder-binary-path
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
| | |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.
2023-03-23 17:42:20 -05:00
### -o, --ssh-option
| | |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTS</code> |
Specifies additional SSH options to embed in each host stanza.
2024-03-15 11:24:38 -05:00
### -n, --dry-run
| | |
2025-01-03 18:12:59 +05:00
|-------------|---------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
Perform a trial run with no changes made, showing a diff at the end.
2023-03-23 17:42:20 -05:00
### --use-previous-options
| | |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
Specifies whether or not to keep options from previous run of config-ssh.
2024-03-15 11:24:38 -05:00
### --ssh-host-prefix
| | |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
Override the default host prefix.
2025-04-07 12:11:04 +04:00
### --hostname-suffix
| | |
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_HOSTNAME_SUFFIX</code> |
Override the default hostname suffix.
2023-06-08 17:06:50 +03:00
### --wait
| | |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------|
2024-08-20 14:47:46 +10:00
| Type | <code>yes\|no\|auto</code> |
2023-06-08 17:06:50 +03:00
| Environment | <code>$CODER_CONFIGSSH_WAIT</code> |
| Default | <code>auto</code> |
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.
2024-03-15 11:24:38 -05:00
### --disable-autostart
| | |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
2023-03-23 17:42:20 -05:00
### -y, --yes
| | |
2025-01-03 18:12:59 +05:00
|------|-------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
2026-01-16 18:04:57 -08:00
Bypass confirmation prompts.