`coder schedule start`, `stop`, and `extend` printed the updated schedule as a fixed table with no `-o` or `-c`, while `coder schedule show` has both. All four commands now share one formatter with the same row type, default columns, `-o table|json`, and `-c`, so the output of a change and of `show` is interchangeable. **Behavior change:** Adds `-o` and `-c` to the three commands. The default table output changes slightly: the WORKSPACE column no longer includes the favorite-star prefix, matching `schedule show`. Other columns are unchanged. <details> <summary>Decisions</summary> - Previously these commands rendered `WorkspaceListRow`, which prefixes the workspace name with a favorite icon. Using `scheduleListRow` for consistency with `schedule show` drops that prefix. </details> Closes [CLI-15](https://linear.app/codercom/issue/CLI-15) _This PR was generated by Coder Agents on behalf of @nickvigilante._
55 lines
1.5 KiB
Markdown
Generated
55 lines
1.5 KiB
Markdown
Generated
---
|
|
# Code generated by make gen. DO NOT EDIT.
|
|
title: "`coder schedule stop`"
|
|
description: Edit workspace stop schedule
|
|
---
|
|
|
|
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
Edit workspace stop schedule
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder schedule stop [flags] <workspace-name> { <duration> | manual }
|
|
```
|
|
|
|
## Description
|
|
|
|
```console
|
|
Schedules a workspace to stop after a given duration has elapsed.
|
|
* Workspace runtime is measured from the time that the workspace build completed.
|
|
* The minimum scheduled stop time is 1 minute.
|
|
* The workspace template may place restrictions on the maximum shutdown time.
|
|
* Changes to workspace schedules only take effect upon the next build of the workspace,
|
|
and do not affect a running instance of a workspace.
|
|
|
|
When enabling scheduled stop, enter a duration in one of the following formats:
|
|
* 3h2m (3 hours and two minutes)
|
|
* 3h (3 hours)
|
|
* 2m (2 minutes)
|
|
* 2 (2 minutes)
|
|
|
|
$ coder schedule stop my-workspace 2h30m
|
|
```
|
|
|
|
## Options
|
|
|
|
### -c, --column
|
|
|
|
| | |
|
|
|---------|---------------------------------------------------------------------------|
|
|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
|
|
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
|
|
|
|
Columns to display in table output.
|
|
|
|
### -o, --output
|
|
|
|
| | |
|
|
|---------|--------------------------|
|
|
| Type | <code>table\|json</code> |
|
|
| Default | <code>table</code> |
|
|
|
|
Output format.
|