JetBrains Rider 2024.1 Help

Consume NuGet packages

You can install, update, and remove NuGet packages via the NuGet window Alt+Shift+7 and NuGet quick list Ctrl+P, N.

Browse installed and available NuGet packages

By default, the Packages tab of the window shows all packages installed in the whole solution, but you can change the view to only show packages of a specific project. To do so, use the scope selector next to the search field:

JetBrains Rider: choosing a project to manage NuGet packages

Available packages for the selected scope are always shown below the installed packages.

Packages that are referenced from other installed packages are displayed in the Implicitly Installed category. Their versions are shown in parentheses because you cannot upgrade or downgrade them. To learn which package references an implicitly installed one, right-click it and choose Quick NuGet Documentation or press Ctrl+Q.

You can select installed or available packages in the left part of the Packages tab, and use the right part to check package details, as well as to install, upgrade/downgrade, or remove the package in specific projects:

Rider: managing NuGet packages

Restore and Upgrade NuGet packages

Rider provides two algorithms for restoring NuGet packages:

  • Normal — calls the standard NuGet restore mechanism, which can be slow, especially on .NET projects. It is available in the main menu (Tools | NuGet | NuGet Restore), in the NuGet quick list Ctrl+P, N, and by clicking Restore Restore on the NuGet window toolbar.

  • Force — performs a number of heuristics to determine which packages should be restored. The 'Force' algorithm works almost instantaneously, however there could be cases where it fails to restore some packages. Tools | NuGet | NuGet Force Restore) or in the NuGet quick list Ctrl+P, N.

When you open a solution, Rider will automatically apply the 'Light' algorithm to restore missing packages. If necessary, you can change the auto-restore behaviour on the NuGet settings page, which you can also open by clicking NuGet Settings NuGet Settings on the NuGet window toolbar.

To upgrade the installed packages, click Upgrade Packages in Solution Upgrade Packages in Solution on the NuGet window toolbar and then choose which packages should be upgraded.

Alternatively, you can select one of the installed packages in the left-hand side of the NuGet window choose the desired version in the right part, and then upgrade/downgrade specific projects to this package version.

Find and install NuGet packages

To find a NuGet package, use the search field and the list of Available packages, which appears under the list of Installed packages.

In the search field, you can enter a package name to look for or use prefixes: T: to look for types and N: to look for namespaces.

By default, Rider searches all available package sources, but you can limit the search scope using the corresponding selector:

Rider: choosing NuGet package sources

A single click on a package source will select the source and deselect all others. You can Shift-click to select multiple sources or click All feeds to select all.

Install or upgrade/downgrade a NuGet package

  1. Find the desired package as described above and select it in the left part of the Packages tab

  2. In the right part of the tab, choose a project where you want to install the selected package. If your solution contains too many projects, you may want to use the scope selector on the toolbar to display specific project and hide all others.

  3. Use the Prerelease checkbox on the toolbar to show or hide pre-release versions of the package.

  4. Use the Version selector in the right tab to choose the desired version of the package.

  5. Before installing the selected package, you may want to check which dependent packages will be installed. To do so, expand Frameworks and Dependencies in the right part:

    Rider: Dependencies of the selected NuGet package
  6. Depending on the selected package version, and on whether the selected package is installed in the selected project, you will be able to install, upgrade or downgrade the package.

    After installing a new package, you will see it's readme.txt file in the editor so that you will be able to check if any additional steps are required after installing.

    If config file/XDT transformations are implemented in the package, JetBrains Rider will run them to help in adding required entries, for example to an App.config or Web.config file.

The easiest way to start the search for a NuGet package is to use the corresponding Alt+Enter action that becomes available for unresolved namespaces:

Finding NuGet package by namespace with JetBrains Rider

... and types:

Finding NuGet packages by type with JetBrains Rider

In any case, JetBrains Rider will open the NuGet window, where you will see all packages that contain the desired type or namespace.

Manage package sources

In the Sources tab of the NuGet window, Rider lists all NuGet configuration files discovered on your machine. You can add, remove, or edit package sources for the selected config file on the right panel, or click these files to open them in the editor.

If necessary, you can add or remove package sources manually, by editing the packageSources section of a configuration file. For example:

<packageSources> <add key="My online package source" value="https://some.address/"/> <add key="My local package source" value="C:\NuGetPackages\"/> </packageSources>

Credential providers for private NuGet feeds

JetBrains Rider lets you authenticate to private NuGet feeds that use with different authentication methods.

Authentication prompt for username/password combination

In the Sources tab of the NuGet window, you can edit or add a feed and add credentials in the form of a username/password combination.

The URL to private feeds is often shared with team members in the NuGet.config file that sits next to the solution file, so that everyone on the team can connect to such private feed. On the first load of such solution where package restore is required, JetBrains Rider will prompt for credentials.

When credentials are correct, they are stored in JetBrains Rider’s password store so that you don’t have to re-enter credentials each time you access a NuGet feed. The password store is configurable on the Appearance and Behavior | System Settings | Passwords page of settings  Ctrl+Alt+S.

JetBrains Rider also has integrated credential providers for MyGet and Visual Studio Team Services (VSTS).

Use authentication plugins

For private feeds that use plugin-based authentication method, such as the one provided by Azure Artifacts, you need to change the Use credential providers preference on the Build, Execution, Deployment | NuGet page of settings  Ctrl+Alt+S to NuGet/.NET CLI plugins or to NuGet/.NET CLI plugins, then Rider integrated (if you use different authentication methods) and then restart JetBrains Rider.

Once authentication plugins support is enabled, the %USERPROFILE%\.nuget\plugins (Windows) and $HOME/.nuget/plugins (Linux/macOS) path will be monitored for credential provider plugins that are applicable, and JetBrains Rider will use those to perform necessary authentications.

NuGet options

You can configure NuGet preferences in the NuGet settings page, which you can open by clicking NuGet Settings NuGet Settings in the NuGet window or by choosing Build, Execution, Deployment | NuGet in Rider settings Ctrl+Alt+S.

In the Search section, you can choose:

  • Include prerelease — lets you search and install pre-release versions of packages. This preference is synchronized with the same preference shown on the toolbar of the Packages tab.

  • Include unlisted — lets you search and install versions of packages that are at unlisted on the server (for example, at NuGet website). You may want to use this option to see outdated versions of packages.

Preferences in the Install and Update and in Uninstall sections work exactly the same as in Visual Studio package manager:

Visual Studio package manager options

Manage NuGet caches

NuGet caches all downloaded packages to make them available when there is no internet connection and to prevent multiple downloads of the same package.

With Rider, you can view locations of NuGet caches and clear selected locations in the Folders tab of the NuGet window. Clearing NuGet caches is safe, it does not affect packages installed in your projects.

Edit NuGet configuration files

If necessary, you can also manually edit NuGet configuration files — NuGet.Config, packages.config, and *.nuspec. Most of the coding assistance features including syntax validation and Code completion (IntelliSense) are there for you.

JetBrains Rider: Coding assistance in NuGet configuration files

NuGet quick list

The most frequently used actions are available in the NuGet quick list — Ctrl+P, N or Tools | NuGet | NuGet Quick List:

JetBrains Rider: NuGet quick list
Last modified: 26 May 2024