The CLI login command
Describes the DevEx CLI login command that manages plugins that contain additional CLI commands.
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.
The Sitecore CLI login
command is initiated within the Sitecore CLI by using the following:
dotnet sitecore login [options]
You can use the following options with the login
command:
Option | Required? | Description |
---|---|---|
| No | Identity authority for the environment, such as identity server or AAD tenant URL. |
| No | Named Sitecore environment to use. Default: |
| No | Sitecore content management hostname to connect to. |
| No | Enable writing data to the environment. |
| No | Use client credentials (for CI/CD, shared secret). |
| No | The OAuth ClientID to send. Defaults to |
| No | The OAuth client secret to send. Only used for client credentials authentication. |
| No | Path to the root |
| No | Display developer help and usage information about the command. |
| No | Outputs additional diagnostics and detailed information about the command. |
The following are examples of using the login
command for interactive user login:
Command | Result |
---|---|
dotnet sitecore login --authority https://<Sitecore identity server> --cm http://<Sitecore instance> --allow-write true dotnet 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://<Sitecore identity server> --cm http://<sitecore instance> --allow-write true --client-credentials true --client-id <client id> --client-secret <client secret> | Use the non-interactive client login. |
For more information, refer to logging in to a Sitecore instance using the CLI.