mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00

Files

Atif Ali cba69f3d98 docs: update SSH command format to use suffix (#18085 )

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"
/>

2025-06-02 20:13:08 -07:00

3.7 KiB

Generated

Raw Blame History

config-ssh

Add an SSH Host entry for your workspaces "ssh workspace.coder"

Usage

coder config-ssh [flags]

Description

  - 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

--ssh-config-file


Type	`string`
Environment	`$CODER_SSH_CONFIG_FILE`
Default	`~/.ssh/config`

Specifies the path to an SSH config.

--coder-binary-path


Type	`string`
Environment	`$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.

-o, --ssh-option


Type	`string-array`
Environment	`$CODER_SSH_CONFIG_OPTS`

Specifies additional SSH options to embed in each host stanza.

-n, --dry-run


Type	`bool`
Environment	`$CODER_SSH_DRY_RUN`

Perform a trial run with no changes made, showing a diff at the end.

--use-previous-options


Type	`bool`
Environment	`$CODER_SSH_USE_PREVIOUS_OPTIONS`

Specifies whether or not to keep options from previous run of config-ssh.

--ssh-host-prefix


Type	`string`
Environment	`$CODER_CONFIGSSH_SSH_HOST_PREFIX`

Override the default host prefix.

--hostname-suffix


Type	`string`
Environment	`$CODER_CONFIGSSH_HOSTNAME_SUFFIX`

Override the default hostname suffix.

--wait


Type	`yes\|no\|auto`
Environment	`$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.

--disable-autostart


Type	`bool`
Environment	`$CODER_CONFIGSSH_DISABLE_AUTOSTART`
Default	`false`

Disable starting the workspace automatically when connecting via SSH.

-y, --yes


Type	`bool`

Bypass prompts.

3.7 KiB Generated Raw Blame History