DEMO A showcase of hev ask⌘K agentic search — running on Coder's real docs. Unaffiliated with Coder; not the official documentation. Official Coder docs ↗ Add ask to your docs ↗
Documentation › config-ssh

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

Typestring
Environment$CODER_SSH_CONFIG_FILE
Default~/.ssh/config

Specifies the path to an SSH config.

—coder-binary-path

Typestring
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

Typestring-array
Environment$CODER_SSH_CONFIG_OPTS

Specifies additional SSH options to embed in each host stanza.

-n, —dry-run

Typebool
Environment$CODER_SSH_DRY_RUN

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

—use-previous-options

Typebool
Environment$CODER_SSH_USE_PREVIOUS_OPTIONS

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

—ssh-host-prefix

Typestring
Environment$CODER_CONFIGSSH_SSH_HOST_PREFIX

Override the default host prefix.

—hostname-suffix

Typestring
Environment$CODER_CONFIGSSH_HOSTNAME_SUFFIX

Override the default hostname suffix.

—wait

Typeyes|no|auto
Environment$CODER_CONFIGSSH_WAIT
Defaultauto

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

Typebool
Environment$CODER_CONFIGSSH_DISABLE_AUTOSTART
Defaultfalse

Disable starting the workspace automatically when connecting via SSH.

—force-unix-filepaths

Typebool
Environment$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 ’/’).

-y, —yes

Typebool

Bypass confirmation prompts.

esc