mirror of https://github.com/coder/coder.git synced 2026-06-03 13:08:25 +00:00

Files

T

Kacper Sawicki 7b1dcd9846 feat(cli): add enterprise external-workspaces CLI command (#19287 )

This pull request introduces support for external workspace management, allowing users to register and manage workspaces that are provisioned and managed outside of the Coder.

* coder external-workspaces create - Creates a new external workspace (this command extends coder create)
  * Example: coder external-workspaces create ext-workspace --template=externally-managed-workspace -y
  * Checks if template has coder_external_agent resource before creating a workspace
* coder external-workspaces list - Lists all external workspaces
* coder external-workspaces agent-instructions <workspace name> <agent name> - Retrieves agent connection instruction
  * Example: coder external-workspaces agent-instructions ext-workspace main --output=json

2025-08-19 10:52:31 +02:00

4.0 KiB

Generated

Raw Blame History

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.

-y, --yes


Type	`bool`

Bypass 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.

4.0 KiB Generated Raw Blame History