mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
cba69f3d98
Refactor the workspace SSH command syntax across the project to use the "workspace.coder" format instead of "coder.workspace". This standardizes the SSH host entries for better consistency and clarity. This is a follow-up from #17445 and recommends using the suffix-based format for all new Coder versions. <img width="418" alt="image" src="https://github.com/user-attachments/assets/3893f840-9ce1-4803-a013-736068feb328" />
62 lines
2.2 KiB
Plaintext
62 lines
2.2 KiB
Plaintext
coder v0.0.0-devel
|
|
|
|
USAGE:
|
|
coder config-ssh [flags]
|
|
|
|
Add an SSH Host entry for your workspaces "ssh workspace.coder"
|
|
|
|
- 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
|
|
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 '/').
|
|
|
|
--hostname-suffix string, $CODER_CONFIGSSH_HOSTNAME_SUFFIX
|
|
Override the default hostname suffix.
|
|
|
|
--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.
|