Local installation

You can install the Content Hub command line interface (CLI) locally.

Note

You must be an admin to install, update, or uninstall the CLI. When you uninstall the binaries, remove the extracted binary file and clean up the configuration in the user account directory.

Important

The ch-cli is built using .NET 6 and OS compatibility is determined by the .NET runtime. Verify that your operating system is supported before you start.

Windows

Chocolatey is software management automation for Windows that wraps installers, executables, zips, and scripts into compiled packages. Before you begin, ensure Chocolatey is installed.

Install the CLI on Windows

To install the CLI on Windows, run the following command.

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

To verify the installation was successful, run the following command:

RequestResponse
ch-cli --version

Update the binary files

To update the binary files:

  1. Download the latest version.

  2. Extract the archive.

  3. On the command line, navigate to the location of the archive and run the following command:

    RequestResponse
    ch-cli.exe --version

Update the CLI on Windows

To update the CLI on Windows, run the following command:

RequestResponse
choco upgrade sitecore.ch.cli

Uninstall the CLI on Windows

To uninstall the CLI on Windows, run the following command:

RequestResponse
choco uninstall sitecore.ch.cli

macOS

Homebrew is a free and open-source software package management system that simplifies the installation of software. Before you begin, ensure Homebrew is installed.

Note

The minimum required OS version for macOS is version 10.13 High Sierra.

Install the CLI on macOS

To install the CLI on macOS, run the following commands:

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

To verify the installation was successful, run the following command:

RequestResponse
ch-cli --version

Update the binary files

To update the binary files:

  1. Download the latest version.

  2. Extract the archive.

  3. On the command line, navigate to the location of the archive and run the following command:

    RequestResponse
    ./ch-cli

Update the CLI on macOS

To update the CLI on macOS, run the following command:

RequestResponse
brew update && brew upgrade

Uninstall the CLI on macOS

To uninstall the CLI on macOS, run the following command:

RequestResponse
brew uninstall ch-cli

Linux

Homebrew is a free and open-source software package management system that simplifies the installation of software. Before you begin, ensure Homebrew is installed.

To install the CLI on Linux

To install the CLI on Linux, run the following commands:

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

To verify the installation was successful, run the following command:

RequestResponse
ch-cli --version

Update the binary files

Linux uses the following types of binaries:

  • linux-x64 - for most desktop distributions using glibc.

  • linux-musl-x64 - for lightweight distributions (for example, Alpine Linux) using musl.

To update the binary files:

  1. Download the latest version.

  2. Extract the archive.

  3. On the command line, navigate to the location of the archive and run the following command:

    RequestResponse
    ./ch-cli

Do you have some feedback for us?

If you have suggestions for improving this article,