New
The Gartner Hype Cycle Emerging Technologies Report is out!

Download now

Home
/
Command Line
/
templates edit

templates edit

templates edit

Edit the metadata of a template by name.

Usage

coder templates edit [flags] <template>

Options

--activity-bump

Typeduration

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.

--allow-user-autostart

Typebool
Defaulttrue

Allow users to configure autostart for workspaces on this template. This can only be disabled in enterprise.

--allow-user-autostop

Typebool
Defaulttrue

Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled in enterprise.

--allow-user-cancel-workspace-jobs

Typebool
Defaulttrue

Allow users to cancel in-progress workspace jobs.

--autostart-requirement-weekdays

Typestring-array

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'.

--default-ttl

Typeduration

Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.

--deprecated

Typestring

Sets the template as deprecated. Must be a message explaining why the template is deprecated.

--description

Typestring

Edit the template description.

--display-name

Typestring

Edit the template display name.

--dormancy-auto-deletion

Typeduration
Default0h

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.

--dormancy-threshold

Typeduration
Default0h

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.

--failure-ttl

Typeduration
Default0h

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

Typestring

Edit the template icon path.

--max-ttl

Typeduration

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

Typestring

Edit the template name.

--private

Typebool
Defaultfalse

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.

--require-active-version

Typebool
Defaultfalse

Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.

-y, --yes

Typebool

Bypass prompts.

See an opportunity to improve our docs? Make an edit.
On this page