mirror of
https://github.com/coder/coder.git
synced 2025-07-12 00:14:10 +00:00
91f900ec64
* docs: expand on TTL flags * make: gen * Discard changes to site/src/api/api.ts * Discard changes to site/src/xServices/templateVersion/templateVersionXService.ts --------- Co-authored-by: Muhammad Atif Ali <matifali@live.com> Co-authored-by: Muhammad Atif Ali <atif@coder.com>
115 lines
3.1 KiB
Markdown
Generated
115 lines
3.1 KiB
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
# templates edit
|
|
|
|
Edit the metadata of a template by name.
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder templates edit [flags] <template>
|
|
```
|
|
|
|
## Options
|
|
|
|
### --allow-user-autostart
|
|
|
|
| | |
|
|
| ------- | ----------------- |
|
|
| Type | <code>bool</code> |
|
|
| Default | <code>true</code> |
|
|
|
|
Allow users to configure autostart for workspaces on this template. This can only be disabled in enterprise.
|
|
|
|
### --allow-user-autostop
|
|
|
|
| | |
|
|
| ------- | ----------------- |
|
|
| Type | <code>bool</code> |
|
|
| Default | <code>true</code> |
|
|
|
|
Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled in enterprise.
|
|
|
|
### --allow-user-cancel-workspace-jobs
|
|
|
|
| | |
|
|
| ------- | ----------------- |
|
|
| Type | <code>bool</code> |
|
|
| Default | <code>true</code> |
|
|
|
|
Allow users to cancel in-progress workspace jobs.
|
|
|
|
### --default-ttl
|
|
|
|
| | |
|
|
| ---- | --------------------- |
|
|
| Type | <code>duration</code> |
|
|
|
|
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
|
|
|
|
### --description
|
|
|
|
| | |
|
|
| ---- | ------------------- |
|
|
| Type | <code>string</code> |
|
|
|
|
Edit the template description.
|
|
|
|
### --display-name
|
|
|
|
| | |
|
|
| ---- | ------------------- |
|
|
| Type | <code>string</code> |
|
|
|
|
Edit the template display name.
|
|
|
|
### --failure-ttl
|
|
|
|
| | |
|
|
| ------- | --------------------- |
|
|
| Type | <code>duration</code> |
|
|
| Default | <code>0h</code> |
|
|
|
|
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
|
|
|
|
### --icon
|
|
|
|
| | |
|
|
| ---- | ------------------- |
|
|
| Type | <code>string</code> |
|
|
|
|
Edit the template icon path.
|
|
|
|
### --inactivity-ttl
|
|
|
|
| | |
|
|
| ------- | --------------------- |
|
|
| Type | <code>duration</code> |
|
|
| Default | <code>0h</code> |
|
|
|
|
Specify an inactivity TTL for workspaces created from this template. It is the amount of time the workspace is not used before it is be stopped and auto-locked. This includes across multiple builds (e.g. auto-starts and stops). This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
|
|
|
|
### --max-ttl
|
|
|
|
| | |
|
|
| ---- | --------------------- |
|
|
| Type | <code>duration</code> |
|
|
|
|
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to "Max lifetime" in the UI.
|
|
|
|
### --name
|
|
|
|
| | |
|
|
| ---- | ------------------- |
|
|
| Type | <code>string</code> |
|
|
|
|
Edit the template name.
|
|
|
|
### -y, --yes
|
|
|
|
| | |
|
|
| ---- | ----------------- |
|
|
| Type | <code>bool</code> |
|
|
|
|
Bypass prompts.
|