mirror of
https://github.com/coder/coder.git
synced 2026-06-06 14:38:23 +00:00
Ammar Bandukwala
dd97fe2bce
This change will improve over CLI performance and "snappiness" as well as substantially reduce our test times. Preliminary benchmarks show `coder server --help` times cut from 300ms to 120ms on my dogfood instance. The inefficiency of lipgloss disproportionately impacts our system, as all help text for every command is generated whenever any command is invoked. The `pretty` API could clean up a lot of the code (e.g., by replacing complex string concatenations with Printf), but this commit is too expansive as is so that work will be done in a follow up.
52 lines
1.9 KiB
Plaintext
52 lines
1.9 KiB
Plaintext
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
|
|
|
|
[1mOptions[0m
|
|
--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.
|
|
|
|
-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.
|