2026-08-11 11:22:55 -04:00
---
# Code generated by make gen. DO NOT EDIT.
2026-09-28 15:44:10 -04:00
title : "`coder external-workspaces create`"
2026-10-20 18:51:44 -04:00
description : Create a new external workspace.
2026-08-11 11:22:55 -04:00
---
2025-08-19 10:52:31 +02:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Create a new external workspace
## Usage
```console
coder external-workspaces create [flags] [workspace]
```
## Description
```console
- Create a workspace for another user (if you have permission):
$ coder create <username>/<workspace_name>
```
## Options
### -t, --template
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
Specify a template name.
### --template-version
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
2026-10-14 11:52:36 -04:00
Specify a template version name or ID.
2025-08-19 10:52:31 +02:00
### --preset
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PRESET_NAME</code> |
Specify the name of a template version preset. Use 'none' to explicitly indicate that no preset should be used.
### --start-at
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
Specify the workspace autostart schedule. Check coder schedule start --help for the syntax.
### --stop-after
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
Specify a duration after which the workspace should shut down (e.g. 8h).
### --automatic-updates
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> |
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
### --copy-parameters-from
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
Specify the source workspace name to copy parameters from.
2026-03-16 11:54:30 -06:00
### --no-wait
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-03-16 11:54:30 -06:00
|-------------|------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CREATE_NO_WAIT</code> |
Return immediately after creating the workspace. The build will run in the background.
2025-08-19 10:52:31 +02:00
### -y, --yes
2026-10-21 10:58:04 -07:00
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
2025-08-19 10:52:31 +02:00
2026-01-16 18:04:57 -08:00
Bypass confirmation prompts.
2025-08-19 10:52:31 +02:00
2026-06-11 09:06:07 +10:00
### --build-option
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-06-11 09:06:07 +10:00
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
Build option value in the format "name=value".
### --build-options
2026-10-21 10:58:04 -07:00
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
2026-06-11 09:06:07 +10:00
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-06-11 09:06:07 +10: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
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-06-11 09:06:07 +10: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.
2025-08-19 10:52:31 +02:00
### --parameter
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
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
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
Rich parameter default values in the format "name=value".
2026-04-24 17:09:17 -04:00
### --use-parameter-defaults
2026-10-21 10:58:04 -07:00
| Property | Value |
2026-04-24 17:09:17 -04:00
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
Automatically accept parameter defaults when no value is provided.
2026-06-11 09:06:07 +10:00
### --always-prompt
2026-10-21 10:58:04 -07:00
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
2026-06-11 09:06:07 +10:00
Always prompt all parameters. Does not pull parameter values from existing workspace.
2025-08-19 10:52:31 +02:00
### -O, --org
2026-10-21 10:58:04 -07:00
| Property | Value |
2025-08-19 10:52:31 +02:00
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.