mirror of
https://github.com/coder/coder.git
synced 2025-07-18 14:17:22 +00:00
docs: Add CLI docs (#5879)
This commit is contained in:
41
docs/cli/coder_list.md
Normal file
41
docs/cli/coder_list.md
Normal file
@ -0,0 +1,41 @@
|
||||
## coder list
|
||||
|
||||
List workspaces
|
||||
|
||||
```
|
||||
coder list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-a, --all Specifies whether all workspaces will be listed or not.
|
||||
-c, --column stringArray Specify a column to filter in the table. Available columns are: workspace, template, status, last_built, outdated, starts_at, stops_after
|
||||
-h, --help help for list
|
||||
--search string Search for a workspace with a query. (default "owner:me")
|
||||
```
|
||||
|
||||
### 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) -
|
||||
|
||||
###### Auto generated by spf13/cobra on 27-Jan-2023
|
Reference in New Issue
Block a user