HomeReferenceCommand Linecoder update

`coder update`

On this page

Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.

Usage

coder update [flags] <workspace>

Description

Use --always-prompt to change the parameter values of the workspace.

Options

-y, --yes

Property	Value
Type	`bool`

Bypass confirmation prompts.

--template-version

Property	Value
Type	`string`

Start with a version of the workspace template, by name or ID. Defaults to the active version.

--stop-template-version

Property	Value
Type	`string`

Stop with a version of the workspace template, by name or ID. Only applies when the workspace is started. Defaults to the workspace's current version.

--build-option

Property	Value
Type	`string-array`
Environment	`$CODER_BUILD_OPTION`

Build option value in the format "name=value".

--build-options

Property	Value
Type	`bool`

Prompt for one-time build options defined with ephemeral parameters.

--ephemeral-parameter

Property	Value
Type	`string-array`
Environment	`$CODER_EPHEMERAL_PARAMETER`

Set the value of ephemeral parameters defined in the template. The format is "name=value".

--prompt-ephemeral-parameters

Property	Value
Type	`bool`
Environment	`$CODER_PROMPT_EPHEMERAL_PARAMETERS`

Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for.

--parameter

Property	Value
Type	`string-array`
Environment	`$CODER_RICH_PARAMETER`

Rich parameter value in the format "name=value".

--rich-parameter-file

Property	Value
Type	`string`
Environment	`$CODER_RICH_PARAMETER_FILE`

Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters.

--parameter-default

Property	Value
Type	`string-array`
Environment	`$CODER_RICH_PARAMETER_DEFAULT`

Rich parameter default values in the format "name=value".

--use-parameter-defaults

Property	Value
Type	`bool`
Environment	`$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS`

Automatically accept parameter defaults when no value is provided.

--always-prompt

Property	Value
Type	`bool`

Always prompt all parameters. Does not pull parameter values from existing workspace.