Install NuGet Packages in Visual Studio, VS Code, and Rider

• Oct 02, 2024
• 6 minutes to read

Visual Studio for Windows

Select DevExpress Local NuGet Feed as a NuGet Package Source

Follow the steps below to use the local NuGet feed (created and configured by the Unified Component Installer) as a package source in Visual Studio for Windows:

1. Open the Visual Studio NuGet Package Manager for a solution or project. In the Solution Explorer, right-click the solution or project and select Manage NuGet Packages… in the context menu:

   

2. Select the ‘All’ or ‘DevExpress Local’ NuGet feed as a package source:

   

3. Browse DevExpress packages and install. Enable the ‘Include prerelease’ option to include DevExpress packages with hotfix, EAP/CTP, and Beta releases.

   

Select DevExpress Online NuGet Feed as a NuGet Package Source

Follow the steps below to register/activate the online NuGet feed as a package source to install DevExpress packages:

1. Invoke the Visual Studio Options dialog (Tools → Options).
2. Locate NuGet Package Manager → Package Sources.

3. Click ‘+’ to add the online DevExpress feed to the package source:

   • If you use an authorization key, use https://nuget.devexpress.com/api/v3/index.json as the package source:

     

   • If you use a NuGet Feed URL, specify it as the package source:

     

4. In the Solution Explorer, right-click the solution or project and select Manage NuGet Packages… in the context menu.

   

   If you registered the DevExpress NuGet feed with an authorization key, the login form is displayed when you invoke the NuGet Package Manager window for the first time. Enter your credentials as follows:

   • User name: DevExpress
   • Password: your authorization key

   

   To remove saved credentials, go to Control Panel → User Accounts → Credential Manager → Windows Credentials and delete the following records:

   

5. Select the ‘All’ or ‘DevExpress’ NuGet feed as a package source.

   

6. Browse DevExpress packages for installation. Enable the ‘Include prerelease’ option to display packages with hotfix, EAP/CTP, and Beta releases.

7. Click Install to install the package.

   

Package Manager Console

You can also use the Package Manager Console (Tools → NuGet Package Manager → Package Manager Console) to find, install, or update DevExpress NuGet packages. Use the Package source drop-down list to specify the DevExpress NuGet feed as a package source.

The following example shows different console inputs that allow you to manage NuGet packages:

CLI

# View all packages whose names contain the keyword "web"
PM> Find-Package web

# Add the DevExpress.Web package and its dependencies to the current project
PM> Install-Package DevExpress.Web

# Remove the DevExpress.Web package and all its dependencies unused by other packages
PM> Uninstall-Package DevExpress.Web -RemoveDependencies 

# Update all packages in the solution
PM> Update-Package

# Update the DevExpress.Web package
PM> Update-Package DevExpress.Web

Refer to the Microsoft documentation for additional information: Package Manager Console.

JetBrains Rider (macOS, Windows, Linux)

The following steps explain how to register the DevExpress NuGet feed on macOS, and open and configure the DevExpress-powered project/example in the JetBrains Rider IDE (these steps will be similar for JetBrains Rider IDE for other operating systems):

1. Register the DevExpress NuGet feed. Use your personal DevExpress NuGet authorization key. Use the command below to add DevExpress as a NuGet package source:

   CLI

   dotnet nuget add source https://nuget.devexpress.com/api/v3/index.json -n DXFeed -u DevExpress -p {your-feed-authorization-key} --store-password-in-clear-text
   

   Note

   Non-Windows operating systems do not support password encryption. To store credentials as plain text on these systems, add the --store-password-in-clear-text option to the command.

   Storing passwords in clear text is strongly discouraged. For more information on managing credentials securely, refer to the following Microsoft topic: Consuming packages from authenticated feeds - Security best practices for managing credentials.

2. Open the DevExpress-powered project.

   

3. Clone the project from GitHub (for example, Spreadsheet for ASP.NET Core - How to use AJAX requests to update document content):

   

4. JetBrains Rider automatically resolves DevExpress NuGet packages in the project. You can add DevExpress NuGet packages (if needed). The following screenshot shows how to add the DevExpress.Drawing.Skia NuGet package to the ASP.NET Core project:

   

5. Specify the target framework:

   

Please read the following help topic for additional information on how to register your personal NuGet feed: Consume NuGet packages in JetBrains Rider IDE.

Note

Currently, the rich design-time functionality for DevExpress UI components (designers, project wizards, templates, etc.) that comes with the DevExpress Unified Component Installer is only available in the Visual Studio IDE for Windows. In other IDEs, standard design-time support for UI platforms may not be available (for example, support for the WinForms designer may be absent or limited). To create projects with DevExpress libraries in other IDEs, you can use DevExpress CLI templates/extensions:

• .NET MAUI
• ASP.NET Core (Blazor, BI Dashboard, Reporting, VS Code Report Designer Extension)
• XAF (Cross-Platform .NET App UI & Web API)

Visual Studio Code (VS Code)

The following steps explain how to register the DevExpress NuGet feed and add DevExpress NuGet packages to your project in VS Code:

1. Register the DevExpress NuGet feed. Use your personal DevExpress NuGet authorization key. Use the command below to add DevExpress as a NuGet package source:

   CLI

   dotnet nuget add source https://nuget.devexpress.com/api/v3/index.json -n DXFeed -u DevExpress -p {your-feed-authorization-key}
   

   Non-Windows operating systems do not support password encryption. To store credentials as plain text on these systems, add the --store-password-in-clear-text option to the command.

   Note

   Storing passwords in clear text is strongly discouraged. For more information on managing credentials securely, refer to the following Microsoft topic: Consuming packages from authenticated feeds - Security best practices for managing credentials.

2. Add DevExpress NuGet packages to your project. You can use the VS Code NuGet Package Manager extension or use the dotnet CLI to add/install packages:

   

   CLI

   # Add DevExpress packages to your project (dotnet CLI)
   dotnet add package DevExpress.AspNetCore.Dashboard -v 24.1.4
   

Read the following help topic for information on how to use C# Dev Kit to add/install NuGet packages in VS Code: NuGet in Visual Studio Code.

Note

Currently, the rich design-time functionality for DevExpress UI components (designers, project wizards, templates, etc.) that comes with the DevExpress Unified Component Installer is only available in the Visual Studio IDE for Windows. In other IDEs, standard design-time support for UI platforms may not be available (for example, support for the WinForms designer may be absent or limited). To create projects with DevExpress libraries in other IDEs, you can use DevExpress CLI templates/extensions:

• .NET MAUI
• ASP.NET Core (Blazor, BI Dashboard, Reporting, VS Code Report Designer Extension)
• XAF (Cross-Platform .NET App UI & Web API)