Files
coder/docs/reference/cli/external-workspaces_create.md
T
Zach 3f76f312e4 feat(cli): add --no-wait flag to coder create (#22867)
Adds a `--no-wait` flag (CODER_CREATE_NO_WAIT) to the create command,
matching the existing pattern in `coder start`. When set, the `coder
create` command returns immediately after the workspace creation API
call succeeds instead of streaming build logs until completion.

This enables fire-and-forget workspace creation in CI/automation
contexts (e.g., GitHub Actions), where waiting for the build to finish
is unnecessary. Combined with other existing flags, users can create a
workspace with no interactivity, assuming the user is already
authenticated.
2026-03-16 11:54:30 -06:00

4.7 KiB
Generated

external-workspaces create

Create a new external workspace

Usage

coder external-workspaces create [flags] [workspace]

Description

  - Create a workspace for another user (if you have permission):

     $ coder create <username>/<workspace_name>

Options

-t, --template

Type string
Environment $CODER_TEMPLATE_NAME

Specify a template name.

--template-version

Type string
Environment $CODER_TEMPLATE_VERSION

Specify a template version name.

--preset

Type string
Environment $CODER_PRESET_NAME

Specify the name of a template version preset. Use 'none' to explicitly indicate that no preset should be used.

--start-at

Type string
Environment $CODER_WORKSPACE_START_AT

Specify the workspace autostart schedule. Check coder schedule start --help for the syntax.

--stop-after

Type duration
Environment $CODER_WORKSPACE_STOP_AFTER

Specify a duration after which the workspace should shut down (e.g. 8h).

--automatic-updates

Type string
Environment $CODER_WORKSPACE_AUTOMATIC_UPDATES
Default never

Specify automatic updates setting for the workspace (accepts 'always' or 'never').

--copy-parameters-from

Type string
Environment $CODER_WORKSPACE_COPY_PARAMETERS_FROM

Specify the source workspace name to copy parameters from.

--use-parameter-defaults

Type bool
Environment $CODER_WORKSPACE_USE_PARAMETER_DEFAULTS

Automatically accept parameter defaults when no value is provided.

--no-wait

Type bool
Environment $CODER_CREATE_NO_WAIT

Return immediately after creating the workspace. The build will run in the background.

-y, --yes

Type bool

Bypass confirmation prompts.

--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. The file should be in YAML format, containing key-value pairs for the parameters.

--parameter-default

Type string-array
Environment $CODER_RICH_PARAMETER_DEFAULT

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

-O, --org

Type string
Environment $CODER_ORGANIZATION

Select which organization (uuid or name) to use.