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/ssh.md
Generated
+47 -47
View File
@@ -12,15 +12,14 @@ coder ssh [flags] <workspace>
## Options
### --disable-autostart
### --stdio
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
| | |
| ----------- | ----------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
Disable starting the workspace automatically when connecting via SSH.
Specifies whether to emit SSH output over stdin/stdout.
### -A, --forward-agent
@@ -49,41 +48,15 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
### -l, --log-dir
### --workspace-poll-interval
| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
| | |
| ----------- | ------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
Specify the directory containing SSH diagnostic log files.
### --no-wait
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
### -R, --remote-forward
| | |
| ----------- | -------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
Enable remote port forwarding (remote_port:local_address:local_port).
### --stdio
| | |
| ----------- | ----------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
Specifies whether to emit SSH output over stdin/stdout.
Specifies how often to poll for workspace automated shutdown.
### --wait
@@ -95,12 +68,39 @@ Specifies whether to emit SSH output over stdin/stdout.
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.
### --workspace-poll-interval
### --no-wait
| | |
| ----------- | ------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
Specifies how often to poll for workspace automated shutdown.
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
### -l, --log-dir
| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
Specify the directory containing SSH diagnostic log files.
### -R, --remote-forward
| | |
| ----------- | -------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
Enable remote port forwarding (remote_port:local_address:local_port).
### --disable-autostart
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.