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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

58 lines
2.1 KiB
Plaintext
Raw Normal View History

2023-09-08 13:21:33 -05:00
coder v0.0.0-devel
2023-03-23 17:42:20 -05:00
USAGE:
2023-09-08 13:21:33 -05:00
coder config-ssh [flags]
2023-09-08 13:21:33 -05:00
Add an SSH Host entry for your workspaces "ssh coder.workspace"
2023-09-08 13:21:33 -05: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
OPTIONS:
--coder-binary-path string, $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.
--disable-autostart bool, $CODER_CONFIGSSH_DISABLE_AUTOSTART (default: false)
Disable starting the workspace automatically when connecting via SSH.
-n, --dry-run bool, $CODER_SSH_DRY_RUN
2023-03-23 17:42:20 -05:00
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)
2023-03-23 17:42:20 -05:00
Specifies the path to an SSH config.
--ssh-host-prefix string, $CODER_CONFIGSSH_SSH_HOST_PREFIX
2023-03-23 17:42:20 -05:00
Override the default host prefix.
-o, --ssh-option string-array, $CODER_SSH_CONFIG_OPTS
2023-03-23 17:42:20 -05:00
Specifies additional SSH options to embed in each host stanza.
--use-previous-options bool, $CODER_SSH_USE_PREVIOUS_OPTIONS
2023-03-23 17:42:20 -05:00
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
2023-03-23 17:42:20 -05:00
Bypass prompts.
2023-09-08 13:21:33 -05:00
———
2023-03-23 17:42:20 -05:00
Run `coder --help` for a list of global options.