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

44
docs/cli/coder_scaletest.md
View File

@ -1,42 +1,18 @@
## coder scaletest
<!-- DO NOT EDIT | GENERATED CONTENT -->
Run a scale test against the Coder API
### Synopsis
# coder scaletest
Perform scale tests against the Coder server.
```
## Usage
```console
coder scaletest [flags]
```
### Options
## Subcommands
```
-h, --help help for scaletest
```
### Options inherited from parent commands
```
--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
```
### SEE ALSO
- [coder](coder.md) -
- [coder scaletest cleanup](coder_scaletest_cleanup.md) - Cleanup any orphaned scaletest resources
- [coder scaletest create-workspaces](coder_scaletest_create-workspaces.md) - Creates many workspaces and waits for them to be ready
| Name | Purpose |
| --------------------------------------------------------------------- | ------------------------------------------------------ |
| [<code>cleanup</code>](./coder_scaletest_cleanup) | Cleanup any orphaned scaletest resources |
| [<code>create-workspaces</code>](./coder_scaletest_create-workspaces) | Creates many workspaces and waits for them to be ready |