Nick Vigilante
2ee96f82f9
Screen readers announce a table header cell with no text as an unnamed column, and axe reports it as empty-table-header. - clidocgen writes "Property | Value" over each option's metadata table instead of an empty header row; the CLI reference is regenerated. - The port-forwarding CORS matrix labels its corner cells (From user, From workspace, To user, To workspace, To app). - Four Markdown matrices get a corner label, byte-identical to #30873. - docshtmlcheck (make lint/docs-html) now fails on empty header cells in Markdown pipe tables and raw HTML tables, naming the file, line, and the table's first header. Assisted-by: AI
6.5 KiB
Generated
title, description
| title | description |
|---|---|
| `coder templates edit` | Edit the metadata of a template by name. |
Edit the metadata of a template by name.
Usage
coder templates edit [flags] <template>
Options
--name
| Property | Value |
|---|---|
| Type | string |
Edit the template name.
--display-name
| Property | Value |
|---|---|
| Type | string |
Edit the template display name.
--description
| Property | Value |
|---|---|
| Type | string |
Edit the template description.
--deprecated
| Property | Value |
|---|---|
| Type | string |
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
--icon
| Property | Value |
|---|---|
| Type | string |
Edit the template icon path.
--default-ttl
| Property | Value |
|---|---|
| Type | duration |
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
--activity-bump
| Property | Value |
|---|---|
| Type | duration |
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.
--autostop-reminder
| Property | Value |
|---|---|
| Type | duration |
Edit how long before the autostop deadline a reminder notification is sent for workspaces created from this template, in Go duration format (e.g. 1h, 30m). Set to 0 to disable.
--autostart-requirement-weekdays
| Property | Value |
|---|---|
| Type | [monday|tuesday|wednesday|thursday|friday|saturday|sunday|all] |
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'.
--autostop-requirement-weekdays
| Property | Value |
|---|---|
| Type | [monday|tuesday|wednesday|thursday|friday|saturday|sunday|none] |
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
| Property | Value |
|---|---|
| Type | int |
Edit the template autostop requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.
--failure-ttl
| Property | Value |
|---|---|
| Type | duration |
| Default | 0h |
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
| Property | Value |
|---|---|
| Type | duration |
| Default | 0h |
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
| Property | Value |
|---|---|
| Type | duration |
| Default | 0h |
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.
--agents-allowed
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
Allow Coder Agents to create workspaces using this template.
--allow-user-cancel-workspace-jobs
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
Allow users to cancel in-progress workspace jobs.
--allow-user-autostart
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
Allow users to configure autostart for workspaces on this template. This can only be disabled with a Premium license.
--allow-user-autostop
| Property | Value |
|---|---|
| Type | bool |
| Default | true |
Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled with a Premium license.
--require-active-version
| Property | Value |
|---|---|
| Type | bool |
| Default | false |
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is a Premium feature. See https://coder.com/docs/admin/templates/managing-templates#template-update-policies for more details.
--private
| Property | Value |
|---|---|
| Type | bool |
| Default | false |
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.
-y, --yes
| Property | Value |
|---|---|
| Type | bool |
Bypass confirmation prompts.
-O, --org
| Property | Value |
|---|---|
| Type | string |
| Environment | $CODER_ORGANIZATION |
Select which organization (uuid or name) to use.