coder/cli/testdata/coder_config-ssh_--help.golden

1.8 KiB

Usage: coder config-ssh [flags]
 
Add an SSH Host entry for your workspaces "ssh coder.workspace"
 
- 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
-n, --dry-run bool, $CODER_SSH_DRY_RUN
Perform a trial run with no changes made, showing a diff at the end.
 
--force-unix-filepaths bool, $CODER_CONFIGSSH_UNIX_FILEPATHS
By default, 'config-ssh' uses the os path separator when writing the
ssh config. This might be an issue in Windows machine that use a
unix-like shell. This flag forces the use of unix file paths (the
forward slash '/').
 
--ssh-config-file string, $CODER_SSH_CONFIG_FILE (default: ~/.ssh/config)
Specifies the path to an SSH config.
 
--ssh-host-prefix string, $CODER_CONFIGSSH_SSH_HOST_PREFIX
Override the default host prefix.
 
-o, --ssh-option string-array, $CODER_SSH_CONFIG_OPTS
Specifies additional SSH options to embed in each host stanza.
 
--use-previous-options bool, $CODER_SSH_USE_PREVIOUS_OPTIONS
Specifies whether or not to keep options from previous run of
config-ssh.
 
--wait yes|no|auto, $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.
 
-y, --yes bool
Bypass prompts.
 
---
Run `coder --help` for a list of global options.