mirror of https://github.com/coder/coder.git synced 2025-07-06 15:41:45 +00:00

Files

Aaron Lehmann 0e3dc2a80f feat: influence parameter defaults through cli flag/env (#13039 )

* 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

2024-04-29 14:23:54 -04:00

1.8 KiB

Generated

Raw Blame History

update

Will update and start a given workspace if it is out of date

Usage

coder update [flags] <workspace>

Description

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

Options

--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.

--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.

--parameter-default


Type	`string-array`
Environment	`$CODER_RICH_PARAMETER_DEFAULT`

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

--always-prompt


Type	`bool`

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

1.8 KiB Generated Raw Blame History