dotnet tool install
This article applies to: ✔️ .NET Core 3.1 SDK and later versions
Name
dotnet tool install - Installs the specified .NET tool on your machine.
Synopsis
dotnet tool install <PACKAGE_NAME> -g|--global
[--add-source <SOURCE>] [--configfile <FILE>] [--disable-parallel]
[--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
[--no-cache] [--prerelease]
[--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
[--version <VERSION_NUMBER>]
dotnet tool install <PACKAGE_NAME> --tool-path <PATH>
[--add-source <SOURCE>] [--configfile <FILE>] [--disable-parallel]
[--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
[--no-cache] [--prerelease]
[--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
[--version <VERSION_NUMBER>]
dotnet tool install <PACKAGE_NAME> [--local]
[--add-source <SOURCE>] [--configfile <FILE>]
[--create-manifest-if-needed] [--disable-parallel]
[--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
[--no-cache] [--prerelease]
[--tool-manifest <PATH>] [-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 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
--globaloption. - To install a global tool in a custom location, use the
--tool-pathoption. - To install a local tool, omit the
--globaland--tool-pathoptions.
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_NAMEName/ID of the NuGet package that contains the .NET tool to install.
Options
--add-source <SOURCE>Adds an additional NuGet package source to use during installation. Feeds are accessed in parallel, not sequentially in some order of precedence. If the same package and version is in multiple feeds, the fastest feed wins. For more information, see What happens when a NuGet package is installed?.
--configfile <FILE>The NuGet configuration file (nuget.config) to use. If specified, only the settings from this file will be used. If not specified, the hierarchy of configuration files from the current directory will be used. For more information, see Common NuGet Configurations.
--create-manifest-if-neededApplies to local tools. To find a manifest, the search algorithm searches up the directory tree for
dotnet-tools.jsonor a.configfolder that contains adotnet-tools.jsonfile.If a tool-manifest can't be found and the
--create-manifest-if-neededoption is set to false, theCannotFindAManifestFileerror occurs.If a tool-manifest can't be found and the
--create-manifest-if-neededoption is set to true, the tool creates a manifest automatically. It chooses a folder for the manifest as follows:- Walk up the directory tree searching for a directory that has a
.gitsubfolder. If one is found, create the manifest in that directory. - If the previous step doesn't find a directory, walk up the directory tree searching for a directory that has a
.sln/gitfile. If one is found, create the manifest in that directory. - If neither of the previous two steps finds a directory, create the manifest in the current working directory.
- Walk up the directory tree searching for a directory that has a
--disable-parallelPrevent restoring multiple projects in parallel.
--framework <FRAMEWORK>Specifies the target framework to install the tool for. By default, the .NET SDK tries to choose the most appropriate target framework.
-g|--globalSpecifies that the installation is user wide. Can't be combined with the
--tool-pathoption. Omitting both--globaland--tool-pathspecifies a local tool installation.
-?|-h|--helpPrints out a description of how to use the command.
--ignore-failed-sourcesTreat package source failures as warnings.
--interactiveAllows the command to stop and wait for user input or action. For example, to complete authentication.
--localUpdate the tool and the local tool manifest. Can't be combined with the
--globaloption or the--tool-pathoption.--no-cacheDon't cache packages and HTTP requests.
--prereleaseInclude prerelease packages.
--tool-manifest <PATH>Path to the manifest file.
--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
--globaland--tool-pathspecifies 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], anddiag[nostic]. For more information, see LoggerVerbosity.
--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 dotnetsayInstalls dotnetsay as a global tool in the default location.
dotnet tool install dotnetsay --tool-path c:\global-toolsInstalls dotnetsay as a global tool in a specific Windows directory.
dotnet tool install dotnetsay --tool-path ~/binInstalls dotnetsay as a global tool in a specific Linux/macOS directory.
dotnet tool install -g dotnetsay --version 2.0.0Installs version 2.0.0 of dotnetsay as a global tool.
dotnet tool install dotnetsayInstalls dotnetsay as a local tool for the current directory.
See also
Feedback
Submit and view feedback for