mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00

Files

Ammar Bandukwala dd97fe2bce chore(cli): replace lipgloss with coder/pretty (#9564 )

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.

2023-09-07 16:28:22 -05:00

3.0 KiB

Generated

Raw Blame History

config-ssh

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

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

--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.

-n, --dry-run


Type	`bool`
Environment	`$CODER_SSH_DRY_RUN`

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

--ssh-config-file


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

Specifies the path to an SSH config.

--ssh-host-prefix


Type	`string`
Environment	`$CODER_CONFIGSSH_SSH_HOST_PREFIX`

Override the default host prefix.

-o, --ssh-option


Type	`string-array`
Environment	`$CODER_SSH_CONFIG_OPTS`

Specifies additional SSH options to embed in each host stanza.

--use-previous-options


Type	`bool`
Environment	`$CODER_SSH_USE_PREVIOUS_OPTIONS`

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

--wait


Type	`enum[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.

-y, --yes


Type	`bool`

Bypass prompts.

3.0 KiB Generated Raw Blame History