Skip to main content

coder start

On this page

Start a workspace

Usage

coder start [flags] <workspace>

Options

--no-wait

PropertyValue
Typebool

Return immediately after starting the workspace.

--template-version

PropertyValue
Typestring

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

-y, --yes

PropertyValue
Typebool

Bypass confirmation prompts.

--build-option

PropertyValue
Typestring-array
Environment$CODER_BUILD_OPTION

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

--build-options

PropertyValue
Typebool

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

--ephemeral-parameter

PropertyValue
Typestring-array
Environment$CODER_EPHEMERAL_PARAMETER

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

--prompt-ephemeral-parameters

PropertyValue
Typebool
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

PropertyValue
Typestring-array
Environment$CODER_RICH_PARAMETER

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

--rich-parameter-file

PropertyValue
Typestring
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

PropertyValue
Typestring-array
Environment$CODER_RICH_PARAMETER_DEFAULT

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

--use-parameter-defaults

PropertyValue
Typebool
Environment$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS

Automatically accept parameter defaults when no value is provided.

--always-prompt

PropertyValue
Typebool

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