2023-09-08 13:21:33 -05:00
|
|
|
coder v0.0.0-devel
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
USAGE:
|
2024-12-05 02:32:52 +01:00
|
|
|
coder create [flags] [workspace]
|
2022-12-20 22:17:51 +02:00
|
|
|
|
2023-09-08 13:21:33 -05:00
|
|
|
Create a workspace
|
2023-07-14 09:48:02 -04:00
|
|
|
|
2023-09-08 13:21:33 -05:00
|
|
|
- Create a workspace for another user (if you have permission):
|
|
|
|
|
|
|
|
|
|
$ coder create <username>/<workspace_name>
|
2023-07-14 09:48:02 -04:00
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
OPTIONS:
|
2024-07-01 11:04:45 -10:00
|
|
|
-O, --org string, $CODER_ORGANIZATION
|
|
|
|
|
Select which organization (uuid or name) to use.
|
|
|
|
|
|
2026-06-11 09:06:07 +10:00
|
|
|
--always-prompt bool
|
|
|
|
|
Always prompt all parameters. Does not pull parameter values from
|
|
|
|
|
existing workspace.
|
|
|
|
|
|
2023-10-06 13:27:12 +04:00
|
|
|
--automatic-updates string, $CODER_WORKSPACE_AUTOMATIC_UPDATES (default: never)
|
|
|
|
|
Specify automatic updates setting for the workspace (accepts 'always'
|
|
|
|
|
or 'never').
|
|
|
|
|
|
2026-06-11 09:06:07 +10:00
|
|
|
--build-option string-array, $CODER_BUILD_OPTION
|
|
|
|
|
Build option value in the format "name=value".
|
|
|
|
|
DEPRECATED: Use --ephemeral-parameter instead.
|
|
|
|
|
|
|
|
|
|
--build-options bool
|
|
|
|
|
Prompt for one-time build options defined with ephemeral parameters.
|
|
|
|
|
DEPRECATED: Use --prompt-ephemeral-parameters instead.
|
|
|
|
|
|
2023-11-09 19:22:47 +01:00
|
|
|
--copy-parameters-from string, $CODER_WORKSPACE_COPY_PARAMETERS_FROM
|
|
|
|
|
Specify the source workspace name to copy parameters from.
|
|
|
|
|
|
2026-06-11 09:06:07 +10:00
|
|
|
--ephemeral-parameter string-array, $CODER_EPHEMERAL_PARAMETER
|
|
|
|
|
Set the value of ephemeral parameters defined in the template. The
|
|
|
|
|
format is "name=value".
|
|
|
|
|
|
2026-03-16 11:54:30 -06:00
|
|
|
--no-wait bool, $CODER_CREATE_NO_WAIT
|
|
|
|
|
Return immediately after creating the workspace. The build will run in
|
|
|
|
|
the background.
|
|
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
--parameter string-array, $CODER_RICH_PARAMETER
|
2023-08-09 13:00:25 +02:00
|
|
|
Rich parameter value in the format "name=value".
|
|
|
|
|
|
2024-04-29 11:23:54 -07:00
|
|
|
--parameter-default string-array, $CODER_RICH_PARAMETER_DEFAULT
|
|
|
|
|
Rich parameter default values in the format "name=value".
|
|
|
|
|
|
2025-07-28 14:46:04 +01:00
|
|
|
--preset string, $CODER_PRESET_NAME
|
|
|
|
|
Specify the name of a template version preset. Use 'none' to
|
|
|
|
|
explicitly indicate that no preset should be used.
|
2026-06-11 09:06:07 +10:00
|
|
|
|
|
|
|
|
--prompt-ephemeral-parameters bool, $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.
|
2025-07-28 14:46:04 +01:00
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
|
2023-03-23 17:42:20 -05:00
|
|
|
Specify a file path with values for rich parameters defined in the
|
2024-10-09 10:04:24 +05:30
|
|
|
template. The file should be in YAML format, containing key-value
|
|
|
|
|
pairs for the parameters.
|
2022-12-20 22:17:51 +02:00
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
--start-at string, $CODER_WORKSPACE_START_AT
|
2023-03-23 17:42:20 -05:00
|
|
|
Specify the workspace autostart schedule. Check coder schedule start
|
|
|
|
|
--help for the syntax.
|
|
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
--stop-after duration, $CODER_WORKSPACE_STOP_AFTER
|
2023-03-23 17:42:20 -05:00
|
|
|
Specify a duration after which the workspace should shut down (e.g.
|
|
|
|
|
8h).
|
|
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
-t, --template string, $CODER_TEMPLATE_NAME
|
2023-03-23 17:42:20 -05:00
|
|
|
Specify a template name.
|
|
|
|
|
|
2024-10-11 18:30:11 +05:30
|
|
|
--template-version string, $CODER_TEMPLATE_VERSION
|
2026-10-14 11:52:36 -04:00
|
|
|
Specify a template version name or ID.
|
2024-10-11 18:30:11 +05:30
|
|
|
|
2026-01-16 18:04:57 -08:00
|
|
|
--use-parameter-defaults bool, $CODER_WORKSPACE_USE_PARAMETER_DEFAULTS
|
|
|
|
|
Automatically accept parameter defaults when no value is provided.
|
|
|
|
|
|
2023-09-14 17:48:29 -07:00
|
|
|
-y, --yes bool
|
2026-01-16 18:04:57 -08:00
|
|
|
Bypass confirmation prompts.
|
2023-03-23 17:42:20 -05:00
|
|
|
|
2023-09-08 13:21:33 -05:00
|
|
|
———
|
2023-03-23 17:42:20 -05:00
|
|
|
Run `coder --help` for a list of global options.
|