Sitecore CLI Serialization - Installation and troubleshooting

-

CLI was one of the topics for Ideas for Hackathon 2022. That was the first day when I was trying to install CLI. I was having a few issues when installing it so gave up. After several tries, I finally installed it.

CLI - Sitecore Command Line Interface (CLI) allows console communication with a Sitecore instance. You can install Sitecore CLI either as a local tool for individual projects or as a global tool for all projects.


Let’s see how to install Sitecore CLI in your project,

You must have .NET Core installed on your workstation before installing the Sitecore CLI. To install Sitecore CLI as a local project tool:

1.     If you have not already done so, install Sitecore Management Services.

2.     Open a terminal with administrator privileges.

3.     Run the following commands to install Sitecore CLI.

cd <project folder>

dotnet new tool-manifest

dotnet nuget add source -n Sitecore https://sitecore.myget.org/F/sc-packages/api/v3/index.json

dotnet tool install Sitecore.CLI


    4.    Run the following commands to install Sitecore CLI.

dotnet sitecore init

    5.    Install the required Publishing and Serialization plugin

dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization
dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Publishing

    6.      Log in to a Sitecore instance with Sitecore Command Line Interface:

To log in to a Sitecore instance, Sitecore Command Line Interface (CLI) allows two flows of authentication and authorization:

  •          An interactive user login, using a device code flow.
  •          A non-interactive client login, using a client credentials flow. This is used by clients such as Continuous Integration servers.

I used interactive user login. For non-interactive client login use https://doc.sitecore.com/xp/en/developers/101/developer-tools/configure-a-non-interactive-client-login.html

Using Interactive user login, Login with this command:

dotnet sitecore login --authority https://<Sitecore identity server> --cm http://<Sitecore instance> --allow-write true

I faced 2 errors when I was trying to run this.

Error connecting to https://sc102identityserver.dev.local/.well- known/openid-configuration: Bad Gateway

i.  The above error is due to an invalid license file at C:\inetpub\wwwroot\sc102identityserver \sitecoreruntime


Error connecting to https://sc102identityserver.dev.local/.well-known/openid-configuration: Internal Server Error

                    ii.   The above error is since AspNetCoreModuleV2 was missing in IIS modules for the identityserver


AspNetCoreModuleV2 module is part of the .ASP.NET Core Hosting Bundle, and can be found in the Microsoft Documentation.

After installing the .NET Core Hosting Bundle locally the issue was resolved, and the missing module can be seen in the Modules list.



7.     After fixing both the errors, finally I was able to login successfully.



8.     Create a file under your project folder *.modules.json.

9.     You can define your module path in sitecore.json

10.      After setting all this, use the CLI serialization command. This command handles the serialization of items. You can use the command as follows:

dotnet sitecore ser [subcommand] [options]


I will cover how to implement the Serialization commands with the code in the upcoming series.... :)

Think Sitecore!
Thank You!



















 


 


Comments

Post a Comment

Popular posts from this blog

ZERO DOWNTIME - SOLR SWITCH INDEX REBUILD

-
Image
We always have to worry about downtime or slowness in the website when the index is triggered. Our website search might stop or a few functionalities will be missing. You can set up Solr to rebuild an index in a separate core so that the rebuilding does not affect the search index that is currently used. Once the index’s rebuilding and optimization are completed, Sitecore switches the two cores to get the expected output. The SwitchOnRebuildSolrSearchIndex class inherits from the SolrSearchIndex class and adds the capability of maintaining two cores for a particular index. Sitecore switches the primary and secondary cores by sending a  SWAP  request to Solr. Please follow the below steps: Let’s have “sitecore_web_index” as the Primary core . Copy the “sitecore_web_index” in C:\solrx\server\cores_data and create a Secondary core named “sitecore_web_index_rebuild”. Similarly copy the “sitecore_web_index” folder in C:\solrx\server\solr and create another fol...
Read more

Alternate URLs Using Aliases In Sitecore

-
Image
Sitecore determines the default URL for an item based on its path, for instance the default URL for /sitecore/content/home/career/path/jobs is [sitename] /career/path/jobs . In some cases, it is useful to have shorter URLs that map to longer paths, for instance,[sitename]/jobs may be preferable as alternate URLs through a feature known as Aliases . To create an alias i n the Content Editor:  1. Go to Content Editor, click on the Page,  On the  Presentation   tab, in the   URL   group, click   Aliases . 2.  In the  Aliases  dialog box, in the  Name  field, enter the alias name. 3.  Click  Add. 4. W hen you have finished defining the aliases you want, click  OK . To create an alias i n the Experience Editor:  1. Click on the Page, Goto to Experience Editor ,  On the  Presentation   tab, in the   URL   group, click   Aliases . 2.  In the  Aliases  dialog box, in the...
Read more