dotnet tool install

This article applies to: ✔️ .NET Core 2.1 SDK and later versions

Name

dotnet tool install - Installs the specified .NET Core tool on your machine.

Synopsis

dotnet tool install <PACKAGE_NAME> -g|--global
    [--add-source <SOURCE>] [--configfile <FILE>]
    [--framework <FRAMEWORK>] [-v|--verbosity <LEVEL>]
    [--version <VERSION_NUMBER>]

dotnet tool install <PACKAGE_NAME> --tool-path <PATH>
    [--add-source <SOURCE>] [--configfile <FILE>]
    [--framework <FRAMEWORK>] [-v|--verbosity <LEVEL>]
    [--version <VERSION_NUMBER>]

dotnet tool install <PACKAGE_NAME>
    [--add-source <SOURCE>] [--configfile <FILE>]
    [--framework <FRAMEWORK>] [-v|--verbosity <LEVEL>]
    [--version <VERSION_NUMBER>]

dotnet tool install -h|--help

Description

The dotnet tool install command provides a way for you to install .NET Core tools on your machine. To use the command, you specify one of the following installation options:

  • To install a global tool in the default location, use the --global option.
  • To install a global tool in a custom location, use the --tool-path option.
  • To install a local tool, omit the --global and --tool-path options.

Local tools are available starting with .NET Core SDK 3.0.

Global tools are installed in the following directories by default when you specify the -g or --global option:

OS Path
Linux/macOS $HOME/.dotnet/tools
Windows %USERPROFILE%\.dotnet\tools

Local tools are added to a dotnet-tools.json file in a .config directory under the current directory. If a manifest file doesn't exist yet, create it by running the following command:

dotnet new tool-manifest

For more information, see Install a local tool.

Arguments

  • PACKAGE_NAME

    Name/ID of the NuGet package that contains the .NET Core tool to install.

Options

  • add-source <SOURCE>

    Adds an additional NuGet package source to use during installation.

  • configfile <FILE>

    The NuGet configuration (nuget.config) file to use.

  • framework <FRAMEWORK>

    Specifies the target framework to install the tool for. By default, the .NET Core SDK tries to choose the most appropriate target framework.

  • -g|--global

    Specifies that the installation is user wide. Can't be combined with the --tool-path option. Omitting both --global and --tool-path specifies a local tool installation.

  • -h|--help

    Prints out a short help for the command.

  • tool-path <PATH>

    Specifies the location where to install the Global Tool. PATH can be absolute or relative. If PATH doesn't exist, the command tries to create it. Omitting both --global and --tool-path specifies a local tool installation.

  • -v|--verbosity <LEVEL>

    Sets the verbosity level of the command. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].

  • --version <VERSION_NUMBER>

    The version of the tool to install. By default, the latest stable package version is installed. Use this option to install preview or older versions of the tool.

Examples

  • dotnet tool install -g dotnetsay

    Installs dotnetsay as a global tool in the default location.

  • dotnet tool install dotnetsay --tool-path c:\global-tools

    Installs dotnetsay as a global tool in a specific Windows directory.

  • dotnet tool install dotnetsay --tool-path ~/bin

    Installs dotnetsay as a global tool in a specific Linux/macOS directory.

  • dotnet tool install -g dotnetsay --version 2.0.0

    Installs version 2.0.0 of dotnetsay as a global tool.

  • dotnet tool install dotnetsay

    Installs dotnetsay as a local tool for the current directory.

See also