.NET tools installation

To use the .NET tools, you must have the .NET 8 SDK installed on your computer. To verify your installation, run the following command:

RequestResponse
dotnet --list-sdks

You can install .NET tools either globally or locally in a specific directory (for example, in a project or customer directory). Depending on the operating system, the tools are installed at the following path:

Operating system

Path

Windows

%USERPROFILE%\.dotnet\tools

Linux/macOS

$$HOME/.dotnet/tools

Global

You can install the .NET tools globally.

Install

To install the .NET tools globally, run the following command:

RequestResponse
dotnet tool install --global --add-source https://nuget.sitecore.com/resources/v3/index.json ch-cli

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

RequestResponse
dotnet ch-cli

Update

To update the CLI, run the following command:

RequestResponse
dotnet tool update --global --add-source https://nuget.sitecore.com/resources/v3/index.json ch-cli

Uninstall

To uninstall the CLI, run the following command:

RequestResponse
dotnet tool uninstall --global ch-cli

Local

You can install the .NET tools locally. Before you can install the tools locally, you must install the manifest.

To install the manifest:

  • In the command line, navigate to the desired folder, and run the following command:

    RequestResponse
    dotnet new tool-manifest
    

Install

To install the CLI locally, run the following command:

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

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

RequestResponse
dotnet ch-cli
Note

If you installed the local tool in a shared repository, other developers can install the tool by running the following command:

dotnet tool restore

Update

To update the CLI, run the following command:

RequestResponse
dotnet tool update --add-source https://nuget.sitecore.com/resources/v3/index.json ch-cli

Uninstall

To uninstall the CLI, run the following command:

RequestResponse
dotnet tool uninstall ch-cli

Do you have some feedback for us?

If you have suggestions for improving this article,