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

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

View File

@ -1,38 +1,45 @@
## coder ping
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder ping
Ping a workspace
```
## Usage
```console
coder ping <workspace> [flags]
```
### Options
## Flags
```
-h, --help help for ping
-n, --num int Specifies the number of pings to perform. (default 10)
-t, --timeout duration Specifies how long to wait for a ping to complete. (default 5s)
-v, --verbose Enables verbose logging.
--wait duration Specifies how long to wait between pings. (default 1s)
```
### --num, -n
### Options inherited from parent commands
Specifies the number of pings to perform.
<br/>
| | |
| --- | --- |
| Default | <code>10</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
```
### --timeout, -t
### SEE ALSO
Specifies how long to wait for a ping to complete.
<br/>
| | |
| --- | --- |
| Default | <code>5s</code> |
- [coder](coder.md) -
### --verbose, -v
Enables verbose logging.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --wait
Specifies how long to wait between pings.
<br/>
| | |
| --- | --- |
| Default | <code>1s</code> |