2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates edit
Edit the metadata of a template by name.
## Usage
```console
coder templates edit [flags] <template>
```
## Options
2024-03-15 11:24:38 -05:00
### --name
| | |
2025-01-03 18:12:59 +05:00
|------|---------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
Edit the template name.
### --display-name
| | |
2025-01-03 18:12:59 +05:00
|------|---------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
Edit the template display name.
### --description
| | |
2025-01-03 18:12:59 +05:00
|------|---------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
Edit the template description.
### --deprecated
| | |
2025-01-03 18:12:59 +05:00
|------|---------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
### --icon
| | |
2025-01-03 18:12:59 +05:00
|------|---------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>string</code> |
Edit the template icon path.
### --default-ttl
| | |
2025-01-03 18:12:59 +05:00
|------|-----------------------|
2024-03-15 11:24:38 -05:00
| 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.
2024-02-12 23:00:35 -08:00
### --activity-bump
| | |
2025-01-03 18:12:59 +05:00
|------|-----------------------|
2024-02-12 23:00:35 -08:00
| Type | <code>duration</code> |
Edit the template activity bump - workspaces created from this template will have their shutdown time bumped by this value when activity is detected. Maps to "Activity bump" in the UI.
2024-03-15 11:24:38 -05:00
### --autostart-requirement-weekdays
2024-08-20 14:47:46 +10:00
| | |
2025-01-03 18:12:59 +05:00
|------|------------------------------------------------------------------------------------|
2024-08-20 14:47:46 +10:00
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|all]</code> |
2024-03-15 11:24:38 -05:00
Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.
2024-03-20 10:37:57 -05:00
### --autostop-requirement-weekdays
2024-08-20 14:47:46 +10:00
| | |
2025-01-03 18:12:59 +05:00
|------|-------------------------------------------------------------------------------------|
2024-08-20 14:47:46 +10:00
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|none]</code> |
2024-03-20 10:37:57 -05:00
Edit the template autostop requirement weekdays - workspaces created from this template must be restarted on the given weekdays. To unset this value for the template (and disable the autostop requirement for the template), pass 'none'.
### --autostop-requirement-weeks
| | |
2025-01-03 18:12:59 +05:00
|------|------------------|
2024-03-20 10:37:57 -05:00
| Type | <code>int</code> |
Edit the template autostop requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.
2024-03-15 11:24:38 -05:00
### --failure-ttl
| | |
2025-01-03 18:12:59 +05:00
|---------|-----------------------|
2024-03-15 11:24:38 -05:00
| 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.
### --dormancy-threshold
| | |
2025-01-03 18:12:59 +05:00
|---------|-----------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --dormancy-auto-deletion
| | |
2025-01-03 18:12:59 +05:00
|---------|-----------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
### --allow-user-cancel-workspace-jobs
| | |
2025-01-03 18:12:59 +05:00
|---------|-------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to cancel in-progress workspace jobs.
2023-04-04 22:48:35 +10:00
### --allow-user-autostart
| | |
2025-01-03 18:12:59 +05:00
|---------|-------------------|
2023-04-04 22:48:35 +10:00
| 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
| | |
2025-01-03 18:12:59 +05:00
|---------|-------------------|
2023-04-04 22:48:35 +10:00
| 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.
2024-03-15 11:24:38 -05:00
### --require-active-version
2023-03-23 17:42:20 -05:00
2024-03-15 11:24:38 -05:00
| | |
2025-01-03 18:12:59 +05:00
|---------|--------------------|
2024-03-15 11:24:38 -05:00
| Type | <code>bool</code> |
| Default | <code>false</code> |
2023-03-23 17:42:20 -05:00
2024-11-01 15:43:51 -04:00
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require -automatic-updates-enterprise for more details.
2023-03-23 17:42:20 -05:00
2024-01-05 16:04:14 -05:00
### --private
| | |
2025-01-03 18:12:59 +05:00
|---------|--------------------|
2024-01-05 16:04:14 -05:00
| Type | <code>bool</code> |
| Default | <code>false</code> |
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
2023-03-23 17:42:20 -05:00
### -y, --yes
| | |
2025-01-03 18:12:59 +05:00
|------|-------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
2026-01-16 18:04:57 -08:00
Bypass confirmation prompts.
2024-07-01 11:04:45 -10:00
### -O, --org
| | |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------|
2024-07-01 11:04:45 -10:00
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.