mirror of
https://github.com/coder/coder.git
synced 2025-07-06 15:41:45 +00:00
0e3dc2a80f
* feat: influence parameter defaults through cli flag/env Add a --parameter-default flag / CODER_RICH_PARAMETER_DEFAULT environment variable which overrides default values suggested for parameters. This allows scripts or middleware wrapping the CLI to substitute defaults for parameter values beyond those defined at the template level. For example, Git repository/branch parameters can be given defaults based on the current checkout, or default parameter values can be parsed out of files inside the repo. * Rename defaults arg to defaultOverrides
72 lines
1.8 KiB
Markdown
Generated
72 lines
1.8 KiB
Markdown
Generated
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
# update
|
|
|
|
Will update and start a given workspace if it is out of date
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder update [flags] <workspace>
|
|
```
|
|
|
|
## Description
|
|
|
|
```console
|
|
Use --always-prompt to change the parameter values of the workspace.
|
|
```
|
|
|
|
## Options
|
|
|
|
### --build-option
|
|
|
|
| | |
|
|
| ----------- | -------------------------------- |
|
|
| Type | <code>string-array</code> |
|
|
| Environment | <code>$CODER_BUILD_OPTION</code> |
|
|
|
|
Build option value in the format "name=value".
|
|
|
|
### --build-options
|
|
|
|
| | |
|
|
| ---- | ----------------- |
|
|
| Type | <code>bool</code> |
|
|
|
|
Prompt for one-time build options defined with ephemeral parameters.
|
|
|
|
### --parameter
|
|
|
|
| | |
|
|
| ----------- | ---------------------------------- |
|
|
| Type | <code>string-array</code> |
|
|
| Environment | <code>$CODER_RICH_PARAMETER</code> |
|
|
|
|
Rich parameter value in the format "name=value".
|
|
|
|
### --rich-parameter-file
|
|
|
|
| | |
|
|
| ----------- | --------------------------------------- |
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
|
|
|
|
Specify a file path with values for rich parameters defined in the template.
|
|
|
|
### --parameter-default
|
|
|
|
| | |
|
|
| ----------- | ------------------------------------------ |
|
|
| Type | <code>string-array</code> |
|
|
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
|
|
|
|
Rich parameter default values in the format "name=value".
|
|
|
|
### --always-prompt
|
|
|
|
| | |
|
|
| ---- | ----------------- |
|
|
| Type | <code>bool</code> |
|
|
|
|
Always prompt all parameters. Does not pull parameter values from existing workspace.
|