Getting Nuget CLI
Windows This is quite simple. MS DOCS explain the steps quite well:
1.1 Visit Nuget.org and get the latest release (or nightly if you are the adventurous kind)
1.2 You would place the downloaded nuget.exe in a desired place (e.g. C:\Nuget\Nuget.exe).
1.3 Add this to you PATH environment variable to make it available from command line
Mac OsX or Linux These platforms require Mono to run Nuget as you essentially use the same Nuget.exe as Windows and hence the Mono runtime is your friend.
2.1. If you use Homebrew, the simplest way (and most maintainable) is to use:
# https://brewformulas.org/Mono brew install mono
Alternatively, you can download Mono for Mac. This is an installer if that makes you happy. As of this writing, using homebrew would install Mono here:
# The latest release is 5.14.0 at this time /Library/Frameworks/Mono.framework/Versions/5.14.0
If this is the first time you installed mono, you should also see a symbolic link called Current that points to the latest version of mono:
lrwxr-xr-x 1 root admin 50 3 Mar 18:03 Current -> /Library/Frameworks/Mono.framework/Versions/5.14.0
2.2. You'll get a bash script at /Library/Frameworks/Mono.framework/Commands/nuget that may resemble this:
#!/bin/sh exec /Library/Frameworks/Mono.framework/Versions/5.14.0/bin/mono $MONO_OPTIONS /Library/Frameworks/Mono.framework/Versions/5.14.0/lib/mono/nuget/nuget.exe "$@"
This script is in your $Path (thanks to brew) and you should be able to open a terminal at this point and type
# expect to see nuget help printed nuget
Updating Nuget CLI
- Windows: Open a command prompt and enter this command (assuming the path to nuget.exe is in your PATH):
nuget update -self
- Mac OsX Assuming you used homebrew to install mono, you should be able to run the same update command as Windows (as it is the same Nuget.exe). However, I found the install location for my nuget shell script (see point 2.2. in the Getting Nuget CLI section above) was only editable by root. Hence, I had to do this:
sudo nuget update -self
Side Note: For a reason I can't yet figure out, when I updated mono using brew (brew update && brew upgrade mono), the Current symbolic link did not get updated. I had to do this manually:
sudo ln -sfn /Library/Frameworks/Mono.framework/Versions/5.14.0 Current
Gotchas, tips and tricks
Default Package Cache - this is where packages get downloaded
- Linux Same as Mac
- Mac Nuget uses this config:
dotnet add <Project> package
uses config from here: (see github)
- Linux Same as mac
Adding package feeds
- Using nuget command line
nuget sources Add -Name "Feed Name" -Source "https://feed-url/nuget/v3/index.json" -Username "Username" -Password "password-or-personal-access-token"
- Using IDE
- Rider: can add both authenticated as well as public feeds
- Visual Studio: can add only public feeds through UI. use command line to add authenticated feeds.
- VS Code: Add feeds through command line. Then tasks can be used to run restore.
- .NET Core
# YOU ARE IN A DIRECTORY WITH A .sln or .csproj FILE $ dotnet restore # FROM ANYWHERE $ dotnet restore path/MyProject.csproj # OR $ dotnet restore MySolution.sln
- using settings from a custom Nuget.config
$ dotnet restore --configfile NuGet.config
- Using Nuget command line
$ nuget restore
- Adding an authenticated feed using NuGet.config file https://docs.microsoft.com/en-us/nuget/reference/nuget-config-file#packagesourcecredentials
Add a section like so:
<configuration> <packageSources> <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" /> <add key="Contoso" value="https://contoso.com/packages/" /> <add key="Test Source" value="c:\packages" /> </packageSources> <packageSourceCredentials> <Contoso> <add key="Username" value="firstname.lastname@example.org" /> <add key="Password" value="..." /> </Contoso> <Test_x0020_Source> <add key="Username" value="user" /> <add key="Password" value="..." /> </Test_x0020_Source> </packageSourceCredentials> </configuration>
Other common operations using command line
- List added sources
nuget sources list
- List packages from a named source
# NOTE: for nuget > v 4 SourceName can be the URL or the name of the source nuget list -source SourceName
- Remove a package source
nuget sources remove -name <name-here>
The mysterious case of authenticated feeds
When working with an a package feed that requires credentials (userid/password or a personal access token), beware of these gotchas!
- As of 14-02-2019, dotnet add command cannot read encrypted credentials from Nuget.config. That leaves us with the following options:
1.1. Use Nuget to add package from command line:
nuget install <package>
This will read sources from the config file for the platform in question (Mac/Linux/Windows) explained at the top of this note (see Nuget config location)
1.2. If you want to use dotnet CLI, Create a Nuget.config file that stores password in clear text. See above for the structure of the file. This file may be stored in the solution directory and it would be auto-detected by dotnet. see here. Then add package:
dotnet add <project> package --source <source-url> package-name
NOTE: If the local package cache is populated, subsequent dotnet restore would not break on an authenticated feed.
- When using an artefact feed from Azure DevOps, the restore task is able to use authenticated feeds by using service principal based authentication. see docs here