| title | description | keywords | author | manager | ms.date | ms.topic | ms.prod | ms.technology | ms.devlang | ms.assetid |
|---|---|---|---|---|---|---|---|---|---|---|
dotnet-install scripts reference |
dotnet-install scripts reference |
.NET, .NET Core |
mairaw |
wpickett |
06/20/2016 |
article |
.net-core |
.net-core-technologies |
dotnet |
59b9c456-2bfd-4adc-8202-a1c6a0a6c787 |
dotnet-install.ps1 | dotnet-install.sh - script used to install the Command Line Interface (CLI) tools and shared runtime
Windows:
dotnet-install.ps1 [-Channel] [-Version] [-InstallDir] [-Debug] [-NoPath] [-SharedRuntime]
OS X/Linux:
dotnet-install.sh [--channel] [--version] [--install-dir] [--debug] [--no-path] [--shared-runtime]
The dotnet-install scripts are used to perform a non-admin install of the CLI toolchain and the shared runtime. You can download the scripts from our CLI GitHub repo.
Their main use case is to help with automation scenarios and non-admin installations. There are two scripts, one for PowerShell that works on Windows and a bash script that works on Linux/OS X. They both have the same behavior. Bash script also "understands" PowerShell switches so you can use them across the board.
Installation scripts will download the ZIP/tarball file from the CLI build drops and will proceed to install it in either the default location or in a location specified by --install-dir. By default, the installation script
will download the SDK and install it; if you want to get just the shared runtime, you can specify the --shared-runtime argument.
By default, the script will add the install location to the $PATH for the current session. This can be overridden if the --no-path argument is used.
Before running the script, please install all the required dependencies.
You can install a specific version using the --version argument. The version needs to be specified as 3-part version (for example 1.0.0-13232). If omitted, it will default to the first global.json file found in the hierarchy above the folder where the script was invoked in that contains the sdkVersion property. If that is not present, it will use Latest.
You can also use this script to get the SDK or shared runtime debug binaries with debug symbols by using the --debug argument. If you do not do this on first install and realize you do need debug symbols later on, you can re-run the script with this argument and the version of the bits you installed.
Options are different between script implementations.
-Channel [CHANNEL]
Which channel (for example, "future", "preview", "production") to install from. The default value is "Production".
-Version [VERSION]
Which version of CLI to install; you need to specify the version as 3-part version (i.e. 1.0.0-13232). If omitted, it will default to the first global.json that contains the sdkVersion property; if that is not present, it will use Latest.
-InstallDir [DIR]
Path to install to. The directory is created if it doesn't exist. The default value is %LocalAppData%\.dotnet.
-Debug
true to indicate that larger packages containing debugging symbols should be used; otherwise, false. The default value is false.
-NoPath
true to indicate that the prefix/installdir are not exported to the path for the current session; otherwise, false. The default value is false, that is, the PATH is modified. This makes the CLI tools available immediately after install.
-SharedRuntime
true to install just the shared runtime bits; false to install the entire SDK. The default value is false.
--channel [CHANNEL]
Which channel (for example "future", "preview", "production") to install from. The default value is "Production".
--version [VERSION]
Which version of CLI to install; you need to specify the version as 3-part version (i.e. 1.0.0-13232). If omitted, it will default to the first global.json that contains the sdkVersion property; if that is not present, it will use Latest.
--install-dir [DIR]
Path to where to install. The directory is created if it doesn't exist. The default value is $HOME/.dotnet.
--debug
true to indicate that larger packages containing debugging symbols should be used; otherwise, false. The default value is false.
--no-path
true to indicate that the prefix/installdir are not exported to the path for the current session; otherwise, false. The default value is false, that is, the PATH is modified. This makes the CLI tools available immediately after install.
--shared-runtime
true to install just the shared runtime bits; false to install the entire SDK. The default value is false.
Windows:
./dotnet-install.ps1 -Channel Future
OS X/Linux:
./dotnet-install.sh --channel Future
Installs the dev latest version to the default location.
Windows:
./dotnet-install.ps1 -Channel preview -InstallDir C:\cli
OS X/Linux:
./dotnet-install.sh --channel preview --install-dir ~/cli
Installs the latest preview to the specified location.