---
title: "The cloud editinghost command"
slug: "the-cloud-editinghost-command"
abstract: "Reference for the Sitecore CLI cloud editinghost command for managing SitecoreAI editing hosts."
---
# The cloud editinghost command

> [!note]
> To use the `editinghost` command, you need the [Sitecore CLI XM Cloud plugin version 1.1.120 or later](https://doc.sitecore.com/sai/en/developers/sitecoreai/sitecore-command-line-interface/plugins/xm-cloud-plugin/install-the-xm-cloud-plugin.html "Install the XM Cloud plugin").
>
> The `editinghost` command only works with environments created with [`cloud environment create --cm-only`](https://doc.sitecore.com/sai/en/developers/sitecoreai/sitecore-command-line-interface/sitecore-cli-command-reference/the-cli-cloud-command/the-cloud-environment-command.html#UUID-32374c80-d0ca-5780-0826-1b9718cce25c_section-idm1404940219801036 "The create subcommand") and environments created using [the Decoupled Deployments beta feature](https://developers.sitecore.com/changelog/xm-cloud/03032025/improvements-to-project-creation-and-management%2C-including-separate-repositories-for-each-authoring-environment-and-editing-host).

> [!note]
> **XM Cloud is now SitecoreAI**
> Some code examples, images, and UI labels may still use XM Cloud while engineering assets are being updated.

The XM Cloud plugin for Sitecore CLI provides the `cloud editinghost` command to help you manage editing hosts for a given SitecoreAI environment.

## Usage

You can use the `cloud editinghost` command as follows:

```shell
dotnet sitecore cloud editinghost [subcommand] [options]
```

## Subcommands

You can use the following subcommands to interact with editing hosts:

- `create` - creates an editing host.
- `update` - updates the name of an existing editing host.
- `delete` - deletes an existing editing host.
- `deploy` - creates a new deployment with the specified editing host.

### The create subcommand

You can create a new editing host using the `create` subcommand. You must specify the name of your new editing host and the unique identifier of the authoring environment that you want to link to your editing host.

You can use the following options with the `create` subcommand:

| Option | Description |
| --- | --- |
| --name, -n | Required.The name of the new editing host. |
| --cm-environment-id, -cm | Required.The unique identifier of the authoring environment that you want to link to your editing host. |
| --json | Changes the response format from plain text to JSON. |
| --config | Path to the folder containing the sitecore.json file.Default: the root directory of the Sitecore project solution. |
| --verbose, -v | Write additional information about the command. |
| --trace, -t | Write diagnostics and detailed information about the command. |
| -?, -h, --help | Displays help and usage information about the command. |

For example:

```shell
dotnet sitecore cloud editinghost create --cm-environment-id <cm-id> --name "Staging"
```

### The update subcommand

Use the `update` subcommand to update the name of an existing editing host. You must specify the unique identifier of the editing host and the new name for your editing host.

You can use the following options with the `update` subcommand:

| Option | Description |
| --- | --- |
| --environment-id, -id | Required.The unique identifier for the editing host to update. To find the unique identifier of an editing host, use the cloud environment list command. |
| --name, -n | Required.The new editing host name. |
| --json | Changes the response format from plain text to JSON. |
| --config | Path to the folder containing the sitecore.json file.Default: the root directory of the Sitecore project solution. |
| --verbose, -v | Write additional information about the command. |
| --trace, -t | Write diagnostics and detailed information about the command. |
| -?, -h, --help | Display help and usage information about the command. |

For example:

```shell
dotnet sitecore cloud editinghost update --environment-id <editinghost-id> --name "Staging updated"
```

### The delete subcommand

The `delete` subcommand permanently deletes an editing host. You must specify the unique identifier of the editing host you want to delete.

You can use the following options with the `delete` subcommand:

| Option | Description |
| --- | --- |
| --environment-id, -id | Required.The unique identifier of the editing host to delete. To find the unique identifier of an editing host, use the cloud environment list command. |
| --json | Changes the response format from plain text to JSON. |
| --config | Path to the folder containing the sitecore.json file.Default: the root directory of the Sitecore project solution. |
| --verbose, -v | Write additional information about the command. |
| --trace, -t | Write diagnostics and detailed information about the command. |
| -?, -h, --help | Display help and usage information about the command. |

For example:

```shell
dotnet sitecore cloud editinghost delete --environment-id <editinghost-id>
```

### The deploy subcommand

The `deploy` subcommand creates and starts a deployment entity for an editing host. You must specify the unique identifier of the editing host.

You can use the following options with the `deploy` subcommand:

| Option | Description |
| --- | --- |
| --environment-id, -id | Required.The unique identifier of the editing host used when establishing a connection. |
| --upload, -u | If specified, the process uploads the current solution. |
| --working-dir, -dir | If specified, the process treats the path as the current solution.Default: current solution path. |
| --no-watch | Hides the status/progress information during the deployment process. When the deployment finishes, the command instantly detaches. |
| --no-start | When used, the deployment entities are created, but the deployment process won't start. You can start the deployment later using the cloud deployment start command. |
| --timeout, -to | The time in seconds to wait for the creation process to finish. |
| --json | Changes the response format from plain text to JSON. |
| --config | Path to the folder containing the sitecore.json file.Default: the root directory of the Sitecore project solution. |
| --verbose, -v | Write additional information about the command. |
| --trace, -t | Write diagnostics and detailed information about the command. |
| -?, -h, --help | Display help and usage information about the command. |

For example:

```shell
dotnet sitecore cloud editinghost deploy --environment-id <editinghost-id>
```
