Compiling Sitecore CLI Commands

Sitecore CLI is a powerful tool that allows developers to interact with Sitecore Instance through a command line interface.

Sitecore has provided another interface called Sitecore CLI which includes huge list of cli commands  which you can use for development, deployment and even DevOps processes especially helpful when working with Sitecore Headless (XM Cloud, JSS) or Sitecore Experience Platform in modern development workflows.

Since you will find many documents explaining how you can install and start with Sitecore CLI but in this blog I would like to compile all commands which I have used till now while development OR which are frequently used.

Downloads

You can download the Latest version of Sitecore CLI from this link.

If you have already installed CLI in your environment, then you can choose to upgrade to latest version, But if you are starting new then same link will guide you the steps to start with it.

Note: I have setup an alias in Powershell for dotnet sitecore to only sitecore, So if you have not setup it then you can use dotnet sitecore instead of sitecore for below mentioned commands.

Prerequisites

  1. Dotnet 8 version must be installed in your system.
  2. Sitecore Management Services package must be installed.

Initialization & Setup

1. Sitecore Init
            Command > sitecore init
            Description: Initializes Sitecore CLI in your project directory.

2. Sitecore login
            Command > sitecore login --authority https://<sitecore identity server> 
                                 --cm https://<sitecore instance> --allow-write true
            Description: Authenticates you with the Sitecore instance.

3. Using Client Secret
            Command > 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>
4. Sitecore Logout
            Command > sitecore logout
            Description: Logs out of the Sitecore instance.

Serialization

1. Enable Plugin
            Command > dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization
            Description: Enables serialization beyond version 4.

2. Sitecore Pull 
            Command > sitecore ser pull
            Description: Pulls Sitecore items into your local filesystem (serialization folder).

3. Sitecore Pull (For specific module)
            Command > sitecore ser pull --items-path src\Project\MySitecoreApp\serialization

4. Sitecore Push
            Command > sitecore ser push
            Description: Pushes local serialized items to Sitecore instance

5. Sitecore Push (To specific item path)
            Command > dotnet sitecore publish item --path /sitecore/content/Home -sub -rel

6. Check Status
            Command > sitecore ser status
            Description: Shows which serialized items have changed.
7. Status Reset
            Command > sitecore ser reset
            Description: Resets the tracked state of serialized items. Most useful when 
                                if serialization gets stuck or confused.
8. Check Difference
            Command > sitecore ser diff -s <SOURCE_PATH> -d <DESTINATION_PATH>
            Description: It will help you identify differences in item definitions

9. Validate Item
            Command > sitecore ser validate
            Description: It will allow you to check the issues in serialized items.

10. Watch
            Command > sitecore ser watch
            Description: You can use this command to set auto sync with your dev environment. 
                                  It actually watches for the changes in .yml file and keep it sync with 
                                  local or dev env. 

Publishing

1. Enable the publishing feature
            Command > sitecore plugin add -n Sitecore.DevEx.Extensibility.Publishing

2. Publish
            Command > sitecore publish -c Prototype/
            Description: It will publish all items from master to web database

3. Publish Specific item
            Command > sitecore publish item --path /sitecore/content/Home -sub -rel

4. Publish Language Specfic
            Command > sitecore publish -l en-US,en-CA

Create Package

1. Create sitecore package:
            Command > sitecore package create --path .\packages\MyPackage.zip 
                                --items-path src\serialization
            Description: Creates a package based on a source directory.

2. Package install:
            Command > sitecore package install --path .\packages\MyPackage.zip
            Description: Install the package file

Miscellaneous


1. Create Template
            Command > sitecore new template --name "Article Page" 
                                 --path "src/Project/MySitecoreApp/serialization/Templates"

2. Create Rendering
            Command > sitecore new rendering --name "Hero Banner" 
                                 --path "src/Project/MySitecoreApp/serialization/Renderings"

3. Check CLI Version
            Command > sitecore –version

Summary

In this blog I tried compiling most used commands for Sitecore CLI with their usage and description. Sitecore is upgrading to newer version of Sitecore CLI and it is strongly recommend to upgrade to latest version. You can follow this page link for more details with more/detailed command options https://doc.sitecore.com/xp/en/developers/latest/developer-tools/sitecore-command-line-interface.html

Comments

Post a Comment

Popular posts from this blog

Working with Device Detection Module in Sitecore

Image
  What is Device Detection in Sitecore? Sitecore has an in-built feature called Device Detection which helps to detect at which device the content is shown into. When I say in-built that means its included as a standard feature in Sitecore XP 9.0 and later. This feature is also present in Sitecore XM Cloud , hence you do not need to buy a separate add-on or module to utilize device detection features.   The information gather from Device Detection Module can help content makers, allowing them to tailor the website experience based on the device type they are accessing it with, such as by displaying different layouts or content depending on screen size and capabilities. For Example, An iPhone and Android users might be looking at different content on same page.   Moreover, developers uses the same mechanism to personalize the components based on the device specific audience. They can setup Device Layout based on specific device parameters or can use the in-built rules...
Read more

Setup A/B Testing in Sitecore - Part 1

Image
  Setup A/B Testing in Sitecore - Part 1 In this article we will understand What is A/B Testing, Types of Testing in Sitecore, Actual Use Case and later we will see how we can setup A/B Testing in Sitecore XP solution with Rendering having different data source items.   Before we go further, lets understand WHAT IS A/B Testing ? A/B testing, also known as split testing, is a method used in marketing and product development to compare two versions of something to determine which one performs better. In an A/B test, two versions, A and B, are created, with one varying element between them. This element could be anything from the wording of an email subject line, the design of a web page, the placement of a button, or even the pricing of a product.   The versions, A and B, are then randomly  shown to similar audiences or users, and their responses are measured and compared. The version that performs better in terms of predefined metrics (such as click-through rate, conv...
Read more

Working with Webhooks in Sitecore - Part 1

Image
  Working with Webhooks in Sitecore - Part 1 In this blog we will understand the concept of Webhooks and how we can use them in Sitecore. So before jumping into Webhooks in Sitecore, first lets understand what webhooks are?   What is a Webhook? They are typically created to connect/link different applications. They are much like API but different from them. Webhooks are one way that apps can send automated messages or information to other apps.   Consider an example below:     Suppose, there is a user facing front application which showcase the product catalogs to its customers. This application is responsible for booking an order from its users. BUT the logistics is handle by different application.   The second application (logistic app) has setup a webhook which is exposed over http and waiting to receive any confirmed orders. Once someone place any order which can be called as an event for the first application, then along with its operation it is passin...
Read more