opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(cli): replace clibase with external coder/serpent (#12252)

Browse Source
This commit is contained in:
Ammar Bandukwala
2024-03-15 11:24:38 -05:00
committed by GitHub
parent bed2545636
commit 496232446d
185 changed files with 3770 additions and 7221 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/config-ssh.md
Generated
+34 -34
View File
@@ -25,34 +25,6 @@ workspaces:
## Options
### --coder-binary-path
| | |
| ----------- | ------------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
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
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
### -n, --dry-run
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
Perform a trial run with no changes made, showing a diff at the end.
### --ssh-config-file
| | |
@@ -63,14 +35,14 @@ Perform a trial run with no changes made, showing a diff at the end.
Specifies the path to an SSH config.
### --ssh-host-prefix
### --coder-binary-path
| | |
| ----------- | --------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
| | |
| ----------- | ------------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
Override the default host prefix.
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
@@ -81,6 +53,15 @@ Override the default host prefix.
Specifies additional SSH options to embed in each host stanza.
### -n, --dry-run
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
Perform a trial run with no changes made, showing a diff at the end.
### --use-previous-options
| | |
@@ -90,6 +71,15 @@ Specifies additional SSH options to embed in each host stanza.
Specifies whether or not to keep options from previous run of config-ssh.
### --ssh-host-prefix
| | |
| ----------- | --------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
Override the default host prefix.
### --wait
| | |
@@ -100,6 +90,16 @@ Specifies whether or not to keep options from previous run of config-ssh.
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 | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
### -y, --yes
| | |