dotnet-installer/Documentation/manpages/sdk/dotnet-tool-install.1
2018-05-30 15:52:55 +00:00

116 lines
3.4 KiB
Groff

.\"t
.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "dotnet tool install command \- .NET Core CLI" "1" "" "" ".NET Core"
.hy
.SH dotnet tool install
.PP
.SH NAME
.PP
\f[C]dotnet\ tool\ install\f[] \- Installs the specified .NET Core Global Tool on your machine.
.SH SYNOPSIS
.IP
.nf
\f[C]
dotnet\ tool\ install\ <PACKAGE_NAME>\ <\-g|\-\-global>\ [\-\-add\-source]\ [\-\-configfile]\ [\-\-framework]\ [\-v|\-\-verbosity]\ [\-\-version]
dotnet\ tool\ install\ <PACKAGE_NAME>\ <\-\-tool\-path>\ [\-\-add\-source]\ [\-\-configfile]\ [\-\-framework]\ [\-v|\-\-verbosity]\ [\-\-version]
dotnet\ tool\ install\ <\-h|\-\-help>
\f[]
.fi
.SH DESCRIPTION
.PP
The \f[C]dotnet\ tool\ install\f[] command provides a way for you to install .NET Core Global Tools on your machine.
To use the command, you either have to specify that you want a user\-wide installation using the \f[C]\-\-global\f[] option or you specify a path to install it using the \f[C]\-\-tool\-path\f[] option.
.PP
Global Tools are installed in the following directories by default when you specify the \f[C]\-g\f[] (or \f[C]\-\-global\f[]) option:
.PP
.TS
tab(@);
l l.
T{
OS
T}@T{
Path
T}
_
T{
Linux/macOS
T}@T{
\f[C]$HOME/.dotnet/tools\f[]
T}
T{
Windows
T}@T{
\f[C]%USERPROFILE%\\.dotnet\\tools\f[]
T}
.TE
.SS Arguments
.PP
\f[C]PACKAGE_NAME\f[]
.PP
Name/ID of the NuGet package that contains the .NET Core Global Tool to install.
.SH OPTIONS
.PP
\f[C]\-\-add\-source\ <SOURCE>\f[]
.PP
Adds an additional NuGet package source to use during installation.
.PP
\f[C]\-\-configfile\ <FILE>\f[]
.PP
The NuGet configuration (\f[I]nuget.config\f[]) file to use.
.PP
\f[C]\-\-framework\ <FRAMEWORK>\f[]
.PP
Specifies the target framework to install the tool for.
By default, the .NET Core SDK tries to choose the most appropriate target framework.
.PP
\f[C]\-g|\-\-global\f[]
.PP
Specifies that the installation is user wide.
Can't be combined with the \f[C]\-\-tool\-path\f[] option.
If you don't specify this option, you must specify the \f[C]\-\-tool\-path\f[] option.
.PP
\f[C]\-h|\-\-help\f[]
.PP
Prints out a short help for the command.
.PP
\f[C]\-\-tool\-path\ <PATH>\f[]
.PP
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.
Can't be combined with the \f[C]\-\-global\f[] option.
If you don't specify this option, you must specify the \f[C]\-\-global\f[] option.
.PP
\f[C]\-v|\-\-verbosity\ <LEVEL>\f[]
.PP
Sets the verbosity level of the command.
Allowed values are \f[C]q[uiet]\f[], \f[C]m[inimal]\f[], \f[C]n[ormal]\f[], \f[C]d[etailed]\f[], and \f[C]diag[nostic]\f[].
.PP
\f[C]\-\-version\ <VERSION_NUMBER>\f[]
.PP
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.
.SH EXAMPLES
.PP
Installs the dotnetsay Global Tool in the default location:
.PP
\f[C]dotnet\ tool\ install\ \-g\ dotnetsay\f[]
.PP
Installs the dotnetsay Global Tool on a specific Windows folder:
.PP
\f[C]dotnet\ tool\ install\ dotnetsay\ \-\-tool\-path\ c:\\global\-tools\f[]
.PP
Installs the dotnetsay Global Tool on a specific Linux/macOS folder:
.PP
\f[C]dotnet\ tool\ install\ dotnetsay\ \-\-tool\-path\ ~/bin\f[]
.PP
Installs version 2.0.0 of the dotnetsay Global Tool:
.PP
\f[C]dotnet\ tool\ install\ \-g\ dotnetsay\ \-\-version\ 2.0.0\f[]
.SS See also
.PP
\&.NET Core Global Tools
.SH AUTHORS
mairaw.