Files
coder/docs/reference/cli/create.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

194 lines
6.2 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: "`coder create`"
description: Create a workspace.
---
2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Create a workspace
## Usage
```console
coder create [flags] [workspace]
2023-03-23 17:42:20 -05:00
```
## Description
```console
- Create a workspace for another user (if you have permission):
$ coder create <username>/<workspace_name>
```
2023-03-23 17:42:20 -05:00
## Options
### -t, --template
| Property | Value |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
Specify a template name.
2023-03-23 17:42:20 -05:00
### --template-version
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
Specify a template version name or ID.
### --preset
| Property | Value |
|-------------|---------------------------------|
| 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.
2023-03-23 17:42:20 -05:00
### --start-at
| Property | Value |
|-------------|----------------------------------------|
2023-03-23 17:42:20 -05: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
| Property | Value |
|-------------|------------------------------------------|
2023-03-23 17:42:20 -05: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
2023-03-23 17:42:20 -05:00
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> |
2023-03-23 17:42:20 -05:00
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
### --copy-parameters-from
| Property | Value |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
Specify the source workspace name to copy parameters from.
2023-03-23 17:42:20 -05:00
### --no-wait
| Property | Value |
|-------------|------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CREATE_NO_WAIT</code> |
Return immediately after creating the workspace. The build will run in the background.
2023-03-23 17:42:20 -05:00
### -y, --yes
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
2023-03-23 17:42:20 -05:00
Bypass confirmation prompts.
### --build-option
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
Build option value in the format "name=value".
### --build-options
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| Property | Value |
|-------------|-----------------------------------------|
| 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
| Property | Value |
|-------------|-------------------------------------------------|
| 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.
### --parameter
| Property | Value |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
| Property | Value |
|-------------|-----------------------------------------|
| 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
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
Rich parameter default values in the format "name=value".
### --use-parameter-defaults
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
Automatically accept parameter defaults when no value is provided.
### --always-prompt
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
### -O, --org
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.