synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +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

46
docs/cli/coder_schedule.md
View File

@ -1,40 +1,20 @@
## coder schedule
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder schedule
Schedule automated start and stop times for workspaces
```
## Usage
```console
coder schedule { show | start | stop | override } <workspace> [flags]
```
### Options
## Subcommands
```
-h, --help help for schedule
```
### 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 schedule override-stop](coder_schedule_override-stop.md) - Edit stop time of active workspace
- [coder schedule show](coder_schedule_show.md) - Show workspace schedule
- [coder schedule start](coder_schedule_start.md) - Edit workspace start schedule
- [coder schedule stop](coder_schedule_stop.md) - Edit workspace stop schedule
| Name | Purpose |
| ------------------------------------------------------------ | ---------------------------------- |
| [<code>override-stop</code>](./coder_schedule_override-stop) | Edit stop time of active workspace |
| [<code>show</code>](./coder_schedule_show) | Show workspace schedule |
| [<code>start</code>](./coder_schedule_start) | Edit workspace start schedule |
| [<code>stop</code>](./coder_schedule_stop) | Edit workspace stop schedule |