Files
coder/docs/reference/cli/update.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

126 lines
4.0 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: "`coder update`"
description: "Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first."
---
2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
2025-06-23 09:12:37 +01:00
Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.
2023-03-23 17:42:20 -05:00
## Usage
```console
coder update [flags] <workspace>
```
## Description
```console
Use --always-prompt to change the parameter values of the workspace.
```
## Options
### -y, --yes
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --template-version
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Start with a version of the workspace template, by name or ID. Defaults to the active version.
### --stop-template-version
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
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 | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
Build option value in the format "name=value".
### --build-options
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
Set the value of ephemeral parameters defined in the template. The format is "name=value".
### --prompt-ephemeral-parameters
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
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 | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
2023-03-23 17:42:20 -05:00
### --rich-parameter-file
| Property | Value |
|-------------|-----------------------------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
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 | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
Rich parameter default values in the format "name=value".
### --use-parameter-defaults
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
Automatically accept parameter defaults when no value is provided.
### --always-prompt
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.