Files
coder/docs/cli/coder_config-ssh.md
T

75 lines
1.3 KiB
Markdown
Raw Normal View History

2023-02-22 19:53:21 -06:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder config-ssh
2023-01-27 15:10:40 -03:00
Add an SSH Host entry for your workspaces "ssh coder.workspace"
2023-02-22 19:53:21 -06:00
## Usage
```console
2023-01-27 15:10:40 -03:00
coder config-ssh [flags]
```
2023-02-22 19:53:21 -06:00
## Examples
2023-01-27 15:10:40 -03:00
2023-02-22 19:53:21 -06:00
```console
2023-01-27 15:10:40 -03:00
- 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
```
2023-02-22 19:53:21 -06:00
## Flags
2023-01-27 15:10:40 -03:00
2023-02-22 19:53:21 -06:00
### --dry-run, -n
2023-01-27 15:10:40 -03:00
2023-02-22 19:53:21 -06:00
Perform a trial run with no changes made, showing a diff at the end.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
2023-01-27 15:10:40 -03:00
2023-02-22 19:53:21 -06:00
### --ssh-config-file
2023-01-27 15:10:40 -03:00
2023-02-22 19:53:21 -06:00
Specifies the path to an SSH config.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> |
2023-01-27 15:10:40 -03:00
### --ssh-host-prefix
Override the default host prefix.
<br/>
| | |
| --- | --- |
2023-02-22 19:53:21 -06:00
### --ssh-option, -o
Specifies additional SSH options to embed in each host stanza.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --use-previous-options
Specifies whether or not to keep options from previous run of config-ssh.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
| Default | <code>false</code> |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |