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

80
docs/cli/coder_config-ssh.md
View File

@ -1,14 +1,18 @@
## coder config-ssh
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder config-ssh
Add an SSH Host entry for your workspaces "ssh coder.workspace"
```
## Usage
```console
coder config-ssh [flags]
```
### Examples
## Examples
```
```console
- You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:
@ -19,38 +23,46 @@ coder config-ssh [flags]
$ coder config-ssh --dry-run
```
### Options
## Flags
```
-n, --dry-run Perform a trial run with no changes made, showing a diff at the end.
-h, --help help for config-ssh
--ssh-config-file string Specifies the path to an SSH config.
Consumes $CODER_SSH_CONFIG_FILE (default "~/.ssh/config")
-o, --ssh-option stringArray Specifies additional SSH options to embed in each host stanza.
--use-previous-options Specifies whether or not to keep options from previous run of config-ssh.
Consumes $CODER_SSH_USE_PREVIOUS_OPTIONS
-y, --yes Bypass prompts
```
### --dry-run, -n
### Options inherited from parent commands
Perform a trial run with no changes made, showing a diff at the end.
<br/>
| | |
| --- | --- |
| 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
```
### --ssh-config-file
### SEE ALSO
Specifies the path to an SSH config.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> |
- [coder](coder.md) -
### --ssh-option, -o
Specifies additional SSH options to embed in each host stanza.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --use-previous-options
Specifies whether or not to keep options from previous run of config-ssh.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
| Default | <code>false</code> |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |