Files
coder/docs/cli/templates_edit.md

3.7 KiB
Generated

templates edit

Edit the metadata of a template by name.

Usage

coder templates edit [flags] <template>

Options

--allow-user-autostart

Type bool
Default true

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

--allow-user-autostop

Type bool
Default true

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 bool
Default true

Allow users to cancel in-progress workspace jobs.

--autostart-requirement-weekdays

Type string-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

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.

--description

Type string

Edit the template description.

--display-name

Type string

Edit the template display name.

--failure-ttl

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.

--icon

Type string

Edit the template icon path.

--inactivity-ttl

Type duration
Default 0h

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 duration

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 string

Edit the template name.

--require-active-version

Type bool
Default false

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

Type bool

Bypass prompts.