The CLI connect command

Current version: 10.3

The CLI connect command helps connect your environment to another existing environment. After the connection, your environment uses login information from the reference/base environment and can override the host and alloWrite properties.

Usage

The structure for the Sitecore CLI environment command is:

RequestResponseshell
 dotnet sitecore connect [options]

Options

You can use the following options with the connect command:

Option

Description

-n, --environment-name

Required.

Named Sitecore environment to use.

--cm

Required.

Sitecore content management hostname to connect to.

-r, --ref

Required.

Reference to base environment.

-c, --config

Path to root sitecore.config directory (default: cwd).

--allow-write

Enables writing data to the environment.

-t, --trace

Write more additional diagnostic and performance data.

-?, -h, --help

Show help and usage information.

Examples

To use the connect command, you must provide the values for the options --environment-name, --cm, and --ref. For example:

RequestResponseshell
dotnet sitecore connect --cm https://hostname --environment-name newEnv --ref default

If the operation is successful, the command prints out:

RequestResponseshell
Environment 'newEnv' has been connected to 'default' environment

Do you have some feedback for us?

If you have suggestions for improving this article,