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

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

Browse Source
This commit is contained in:
Ammar Bandukwala
2023-02-23 01:53:21 +00: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
docs/cli/coder_speedtest.md
+26 -28
View File
@@ -1,39 +1,37 @@
## coder speedtest
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder speedtest
Run upload and download tests from your machine to a workspace
```
## Usage
```console
coder speedtest <workspace> [flags]
```
### Options
## Flags
```
-d, --direct Specifies whether to wait for a direct connection before testing speed.
--direction string Specifies whether to run in reverse mode where the client receives and the server sends. (up|down) (default "down")
-h, --help help for speedtest
-t, --time duration Specifies the duration to monitor traffic. (default 5s)
```
### --direct, -d
### Options inherited from parent commands
Specifies whether to wait for a direct connection before testing speed.
<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
```
### --direction
### SEE ALSO
Specifies whether to run in reverse mode where the client receives and the server sends. (up|down)
<br/>
| | |
| --- | --- |
| Default | <code>down</code> |
- [coder](coder.md) -
### --time, -t
Specifies the duration to monitor traffic.
<br/>
| | |
| --- | --- |
| Default | <code>5s</code> |