2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
# start
Start a workspace
## Usage
```console
coder start [flags] <workspace>
```
## Options
2025-03-25 13:54:53 +01:00
### --no-wait
| | |
|------|-------------------|
| Type | <code>bool</code> |
Return immediately after starting the workspace.
2024-03-15 11:24:38 -05:00
### -y, --yes
2023-11-02 14:41:34 -05:00
| | |
2025-01-03 18:12:59 +05:00
|------|-------------------|
2023-11-02 14:41:34 -05:00
| Type | <code>bool</code> |
2024-03-15 11:24:38 -05:00
Bypass prompts.
2023-11-02 14:41:34 -05:00
2023-08-09 13:00:25 +02:00
### --build-option
| | |
2025-01-03 18:12:59 +05:00
|-------------|----------------------------------|
2023-08-09 13:00:25 +02:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
Build option value in the format "name=value".
2023-07-13 12:56:02 +02:00
### --build-options
| | |
2025-01-03 18:12:59 +05:00
|------|-------------------|
2023-07-13 12:56:02 +02:00
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
2024-10-16 23:54:12 +02:00
### --ephemeral-parameter
| | |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2024-10-16 23:54:12 +02:00
| 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
| | |
2025-01-03 18:12:59 +05:00
|-------------|-------------------------------------------------|
2024-10-16 23:54:12 +02:00
| 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.
2023-11-02 14:41:34 -05:00
### --parameter
| | |
2025-01-03 18:12:59 +05:00
|-------------|------------------------------------|
2023-11-02 14:41:34 -05:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
2025-01-03 18:12:59 +05:00
|-------------|-----------------------------------------|
2023-11-02 14:41:34 -05:00
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
2024-10-09 10:04:24 +05:30
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.
2023-11-02 14:41:34 -05:00
2024-04-29 11:23:54 -07:00
### --parameter-default
| | |
2025-01-03 18:12:59 +05:00
|-------------|--------------------------------------------|
2024-04-29 11:23:54 -07:00
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
Rich parameter default values in the format "name=value".
2024-03-15 11:24:38 -05:00
### --always-prompt
2023-03-23 17:42:20 -05:00
| | |
2025-01-03 18:12:59 +05:00
|------|-------------------|
2023-03-23 17:42:20 -05:00
| Type | <code>bool</code> |
2024-03-15 11:24:38 -05:00
Always prompt all parameters. Does not pull parameter values from existing workspace.