Local installation

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

Note

You must be an admin to install, update, or uninstall the CLI.

Important

The ch-one-cli is built using .NET 8 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, ZIP files, 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:

choco install Sitecore.ContentHubOne.Cli --source https://nuget.sitecore.com/resources/v2/

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

ch-one-cli --version

Update the CLI on Windows

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

choco upgrade Sitecore.ContentHubOne.Cli --source https://nuget.sitecore.com/resources/v2/

Uninstall the CLI on Windows

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

choco uninstall Sitecore.ContentHubOne.Cli

macOS or 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.

Note

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

Install the CLI on macOS or Linux

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

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

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

ch-one-cli --version

Update the CLI on macOS or Linux

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

brew update && brew upgrade

Uninstall the CLI on macOS or Linux

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

brew uninstall ch-one-cli

If you have suggestions for improving this article, let us know!