synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): rework CLI docs (#6312)

Browse Source
This commit is contained in:
Ammar Bandukwala
2023-02-22 19:53:21 -06:00
committed by GitHub
parent 43e8ba0811
commit f6a8c360e5
71 changed files with 2342 additions and 2087 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
docs/cli/coder_ssh.md
View File

@ -1,48 +1,66 @@
## coder ssh
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder ssh
Start a shell into a workspace
```
## Usage
```console
coder ssh <workspace> [flags]
```
### Options
## Flags
```
-A, --forward-agent Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
Consumes $CODER_SSH_FORWARD_AGENT
-G, --forward-gpg Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on both the client and workspace. The GPG agent must already be running locally and will not be started for you. If a GPG agent is already running in the workspace, it will be attempted to be killed.
Consumes $CODER_SSH_FORWARD_GPG
-h, --help help for ssh
--identity-agent string Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
Consumes $CODER_SSH_IDENTITY_AGENT
--no-wait Specifies whether to wait for a workspace to become ready before logging in (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.
Consumes $CODER_SSH_NO_WAIT
--stdio Specifies whether to emit SSH output over stdin/stdout.
Consumes $CODER_SSH_STDIO
--workspace-poll-interval duration Specifies how often to poll for workspace automated shutdown.
Consumes $CODER_WORKSPACE_POLL_INTERVAL (default 1m0s)
```
### --forward-agent, -A
### Options inherited from parent commands
Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_FORWARD_AGENT</code> |
| Default | <code>false</code> |
```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
```
### --forward-gpg, -G
### SEE ALSO
Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on both the client and workspace. The GPG agent must already be running locally and will not be started for you. If a GPG agent is already running in the workspace, it will be attempted to be killed.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_FORWARD_GPG</code> |
| Default | <code>false</code> |
- [coder](coder.md) -
### --identity-agent
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_IDENTITY_AGENT</code> |
### --no-wait
Specifies whether to wait for a workspace to become ready before logging in (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_NO_WAIT</code> |
| Default | <code>false</code> |
### --stdio
Specifies whether to emit SSH output over stdin/stdout.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_STDIO</code> |
| Default | <code>false</code> |
### --workspace-poll-interval
Specifies how often to poll for workspace automated shutdown.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m0s</code> |