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,40 +1,45 @@
## coder list
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder list
List workspaces
```
## Usage
```console
coder list [flags]
```
### Options
## Flags
```
-a, --all Specifies whether all workspaces will be listed or not.
-c, --column strings Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after (default [workspace,template,status,last built,outdated,starts at,stops after])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")
--search string Search for a workspace with a query. (default "owner:me")
```
### --all, -a
### Options inherited from parent commands
Specifies whether all workspaces will be listed or not.
<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
```
### --column, -c
### SEE ALSO
Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after
<br/>
| | |
| --- | --- |
| Default | <code>[workspace,template,status,last built,outdated,starts at,stops after]</code> |
- [coder](coder.md) -
### --output, -o
Output format. Available formats: table, json
<br/>
| | |
| --- | --- |
| Default | <code>table</code> |
### --search
Search for a workspace with a query.
<br/>
| | |
| --- | --- |
| Default | <code>owner:me</code> |