Home
/
Command Line
/
config-ssh

config-ssh

coder config-ssh

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

Usage

coder config-ssh [flags]

Examples

  - 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

Flags

--dry-run, -n

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

Defaultfalse

--ssh-config-file

Specifies the path to an SSH config.

Consumes$CODER_SSH_CONFIG_FILE
Default~/.ssh/config

--ssh-host-prefix

Override the default host prefix.

--ssh-option, -o

Specifies additional SSH options to embed in each host stanza.

Default[]

--use-previous-options

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

Consumes$CODER_SSH_USE_PREVIOUS_OPTIONS
Defaultfalse

--yes, -y

Bypass prompts

Defaultfalse
See an opportunity to improve our docs? Make an edit.
On this page