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: adopt markdownlint and markdown-table-formatter for *.md (#15831)

Browse Source 
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
This commit is contained in:
Muhammad Atif Ali
2025-01-03 13:12:59 +00:00
committed by GitHub
co-authored by Edward Angert
parent 08463c27d8
commit 94f5d52fdc
255 changed files with 18279 additions and 16786 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/cli/ssh.md
Generated
+11 -12
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ssh
Start a shell into a workspace
@@ -15,7 +14,7 @@ coder ssh [flags] <workspace>
### --stdio
| | |
| ----------- | ----------------------------- |
|-------------|-------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
@@ -24,7 +23,7 @@ Specifies whether to emit SSH output over stdin/stdout.
### -A, --forward-agent
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_AGENT</code> |
@@ -33,7 +32,7 @@ Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
### -G, --forward-gpg
| | |
| ----------- | ----------------------------------- |
|-------------|-------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_GPG</code> |
@@ -42,7 +41,7 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b
### --identity-agent
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_IDENTITY_AGENT</code> |
@@ -51,7 +50,7 @@ Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent
### --workspace-poll-interval
| | |
| ----------- | ------------------------------------------- |
|-------------|---------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
@@ -61,7 +60,7 @@ Specifies how often to poll for workspace automated shutdown.
### --wait
| | |
| ----------- | ---------------------------- |
|-------------|------------------------------|
| Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_SSH_WAIT</code> |
| Default | <code>auto</code> |
@@ -71,7 +70,7 @@ Specifies whether or not to wait for the startup script to finish executing. Aut
### --no-wait
| | |
| ----------- | ------------------------------- |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
@@ -80,7 +79,7 @@ Enter workspace immediately after the agent has connected. This is the default i
### -l, --log-dir
| | |
| ----------- | ------------------------------- |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
@@ -89,7 +88,7 @@ Specify the directory containing SSH diagnostic log files.
### -R, --remote-forward
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
@@ -98,7 +97,7 @@ Enable remote port forwarding (remote_port:local_address:local_port).
### -e, --env
| | |
| ----------- | --------------------------- |
|-------------|-----------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_ENV</code> |
@@ -107,7 +106,7 @@ Set environment variable(s) for session (key1=value1,key2=value2,...).
### --disable-autostart
| | |
| ----------- | ----------------------------------------- |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |