Desktop

The command line interface (CLI) can be installed on your desktop.

Prerequisites

The ch-cli is built using .NET 6. Therefore, the OS compatibility is determined by the .NET runtime. Check this compatibility table to make sure that your operating system is supported.

This section contains the following:

1. Install
2. Update
3. Uninstall

Install

Windows

Chocolatey

Chocolatey is software management automation for Windows that wraps installers, executables, zips, and scripts into compiled packages.

As an admin, install the CLI:

choco install sitecore.ch.cli --source https://nuget.sitecore.com/resources/v3/index.json

Verify that the installation was successful:

ch-cli --version

Binaries

1. Download the latest version.

   Asset	Hash of the release artifact
   ch-cli-win-x64.1.1.1.zip	e92d9b9fd63b9c47bd19bcb3de91255d411dbb6081582122d2a65239c804a2d4

2. Extract the archive to a location of your choice.

3. Navigate to that location on the command line and execute ch-cli.exe --version.

macOS

Homebrew

Homebrew is a free and open-source software package management system that simplifies the installation of software on Apple's macOS operating system.

Install the CLI:

brew tap sitecore/content-hub
brew install ch-cli

Verify that the installation was successful:

ch-cli --version

Binaries

1. Download the latest version.

   Asset	Hash of the release artifact
   ch-cli-osx-x64.1.1.1.zip	dbbd548aae9d599d82a68867379871b01b9bf0080c01ab812c1e16af1ddae669

2. Extract the archive to a location of your choice.

3. Navigate to that location on the command line and execute ./ch-cli.

Linux

The Homebrew package manager can be used on Linux to simplify the installation of software on Linux distributions.

Homebrew

Install the CLI:

brew tap sitecore/content-hub
brew install ch-cli

Verify that the installation was successful:

ch-cli --version

Binaries

There are two types of binaries for Linux:

• linux-x64 for most desktop distributions using glibc
• linux-musl-x64 for lightweight distributions (e.g. Alpine Linux) using musl

1. Download the latest version:

   Asset	Hash of the release artifact
   ch-cli-linux-musl-x64.1.1.1.tar.gz	3cf796c636fddbb46ebc3c0b16f041e264af0c7865b5ce5a00f653623a8b6314
   ch-cli-linux-x64.1.1.1.tar.gz	3c34103281cfb03d0e8b818f40abdaf57d2728039469326812a2b456c007a8ca

2. Extract the archive.

3. Navigate to that location on the command line and execute ./ch-cli.

Update

To update the version of the CLI:

Chocolatey

choco upgrade sitecore.ch.cli

Homebrew

brew update && brew upgrade

Binaries

Repeat the procedure for your operating system as described in the previous section.

Uninstall

To uninstall the CLI:

Chocolatey

choco uninstall sitecore.ch.cli

Homebrew

brew uninstall ch-cli

Binaries

Remove the extracted binary file. Additionally, you can clean up the configuration in the user account directory.