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

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
+7 -36
View File
@@ -1,8 +1,6 @@
## coder schedule stop
<!-- DO NOT EDIT | GENERATED CONTENT -->
Edit workspace stop schedule
### Synopsis
# coder schedule stop
Schedules a workspace to stop after a given duration has elapsed.
@@ -19,41 +17,14 @@ When enabling scheduled stop, enter a duration in one of the following formats:
- 2m (2 minutes)
- 2 (2 minutes)
```
## Usage
```console
coder schedule stop <workspace-name> { <duration> | manual } [flags]
```
### Examples
## Examples
```
```console
$ coder schedule stop my-workspace 2h30m
```
### Options
```
-h, --help help for stop
```
### 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 schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces