The CLI login command

Sitecore Command Line Interface reference

Version:

The Sitecore CLI includes a login command that allows developers to log into a Sitecore instance.

Note

Sitecore CLI login command requires the use of Sitecore Identity.

Usage

The Sitecore CLI login command is initiated within the Sitecore CLI by using the following:

dotnet sitecore login [options]

Options

You can use the following options with the login command:

Option	Required?	Description
`--authority, --auth`	No	Identity authority for the environment, such as identity server or AAD tenant URL.
`--environment, -n`	No	Named Sitecore environment to use. Default: `'default'`.
`--cm`	No	Sitecore content management hostname to connect to.
`--allow-write`	No	Enable writing data to the environment.
`--client-credentials`	No	Use client credentials (for CI/CD, shared secret).
`--client-id`	No	The OAuth ClientID to send. Defaults to `'Device'` for device auth, and `'SitecoreCLIServer'` for client credentials.
`--client-secret`	No	The OAuth client secret to send. Only used for client credentials authentication.
`--config, -c`	No	Path to the root `sitecore.json` directory. Default: current working directory.
`--help, -h, -?`	No	Display developer help and usage information about the command.
`--trace, -t`	No	Outputs additional diagnostics and detailed information about the command.

Examples

The following are examples of using the login command for interactive user login:

Command: Result
dotnet sitecore login --authority https:// --cm http:// --allow-write truedotnet sitecore login: Output:


Logging in to Sitecore. You should see a browser window open shortly.
[DeviceLogin] User Code : 1234
[DeviceLogin] Authentication url : https://id.[host].localhost/device?userCode=1234
[DeviceLogin] Authorization pending. Waiting.
[DeviceLogin] Authorization pending. Waiting.
Your login is complete. You can close the browser tab now.
Login information has been saved.

The following are examples of using the login command for non-interactive user login:

Command: Description
dotnet sitecore login --authority https:// --cm http:// --allow-write true --client-credentials true --client-id --client-secret : Use the non-interactive client login.

For more information, refer to logging in to a Sitecore instance using the CLI.

If you have suggestions for improving this article, let us know!