Files
coder/docs/reference/cli/update.md
T
Nick Vigilante b6aab35a7b feat!: confirm before coder update restarts a running workspace (#30150)
`coder update` stopped and restarted a running workspace without asking
and had no `-y`, while `coder restart` and the dashboard's update dialog
both confirm first.

It now asks for confirmation before stopping a running workspace, using
the dashboard's wording that updating can delete non-persistent data.
`-y` skips it, and also answers the existing "Enqueue another stop?"
prompt.

**Behavior change:** **New prompt; can break scripts.** `coder update`
on a running workspace without `-y` now blocks on stdin, or fails if
stdin is closed.
Stopped workspaces don't prompt.
Parameter prompts such as `--always-prompt` aren't affected by `-y`.

The [Update
workspaces](https://coder.com/docs/user-guides/workspace-management#update-with-the-cli)
guide now notes the prompt and `-y`.

<details>
<summary>Decisions</summary>

- Mirrors `coder restart`'s prompt pattern.
- Doc-check suggested a row in the 2.29 to 2.34 ESR upgrade guide. This
change ships after 2.34, so it's documented in the user guide instead.

</details>

Closes [CLI-34](https://linear.app/codercom/issue/CLI-34)

_This PR was generated by Coder Agents on behalf of @nickvigilante._
2026-09-30 14:31:43 -04:00

3.5 KiB
Generated

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

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

Type bool

Bypass confirmation prompts.

--build-option

Type string-array
Environment $CODER_BUILD_OPTION

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

--build-options

Type bool

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

--ephemeral-parameter

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

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

Type string-array
Environment $CODER_RICH_PARAMETER

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

--rich-parameter-file

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

Type string-array
Environment $CODER_RICH_PARAMETER_DEFAULT

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

--use-parameter-defaults

Type bool
Environment $CODER_WORKSPACE_USE_PARAMETER_DEFAULTS

Automatically accept parameter defaults when no value is provided.

--always-prompt

Type bool

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