NuGet

https://learn.microsoft.com/en-us/nuget/
Admin
NuGet is the package manager for .NET that enables developers to create, share, and consume useful...
Tokens:547,531
Snippets:3,618
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install-Package examples

Source: https://learn.microsoft.com/en-us/nuget/reference/ps-reference/ps-ref-install-package

Multiple examples showing how to install packages with different options: latest version, specific version, ignoring dependencies, using a packages.config URL, a .nupkg file, and an online package URL.

```powershell
# Installs the latest version of Elmah from the current source into the default project
Install-Package Elmah

# Installs Glimpse 1.0.0 into the MvcApplication1 project
Install-Package Glimpse -Version 1.0.0 -Project MvcApplication1

# Installs Ninject.Mvc3 but not its dependencies from c:\temp\packages
Install-Package Ninject.Mvc3 -IgnoreDependencies -Source c:\temp\packages

# Installs the package listed on the online packages.config into the current project
# Note: the URL must end with "packages.config"
Install-Package https://raw.githubusercontent.com/linked-data-dotnet/json-ld.net/master/.nuget/packages.config

# Installs jquery 1.10.2 package, using the .nupkg file under local path of c:\temp\packages
Install-Package c:\temp\packages\jQuery.1.10.2.nupkg

# Installs the specific online package
# Note: the URL must end with ".nupkg"
Install-Package https://globalcdn.nuget.org/packages/microsoft.aspnet.mvc.5.2.3.nupkg
```

--------------------------------

### Get-Package Examples

Source: https://learn.microsoft.com/en-us/nuget/reference/ps-reference/ps-ref-get-package

A set of examples demonstrating common uses of Get-Package, including listing installed packages, filtering, and checking for updates. Each example is a separate command.

```powershell
# Lists the packages installed in the current solution
Get-Package
```

```powershell
# Lists the packages installed in a project
Get-Package -ProjectName MyProject
```

```powershell
# Lists packages available in the current package source
Get-Package -ListAvailable
```

```powershell
# Lists 30 packages at a time from the current source, and prompts to continue if more are available
Get-Package -ListAvailable -PageSize 30
```

```powershell
# Lists packages with the Ninject keyword in the current source, up to 50
Get-Package -ListAvailable -Filter Ninject
```

```powershell
# List all versions of packages matching the filter "jquery"
Get-Package -ListAvailable -Filter jquery -AllVersions
```

```powershell
# Lists packages installed in the solution that have available updates
Get-Package -Updates
```

```powershell
# Lists packages installed in a specific project that have available updates
Get-Package -Updates -ProjectName MyProject
```

--------------------------------

### Install Newtonsoft.Json version 12.0.1

Source: https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-nuget-cli

Example command to install version 12.0.1 of the Newtonsoft.Json package.

```bash
nuget install Newtonsoft.Json -Version 12.0.1
```

--------------------------------

### Install-Package with -ProjectName

Source: https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell

Installs a package into a non-default project. The example installs Elmah.MVC into the UtilitiesLib project.

```powershell
Install-Package Elmah.MVC -ProjectName UtilitiesLib
```

--------------------------------

### init command examples

Source: https://learn.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-init

Two example invocations: one copying from a local folder to another local folder, and one using UNC paths with the -Expand option to add all files from each package.

```bash
nuget init c:\foo c:\bar
```

```bash
nuget init \\foo\packages \\bar\packages -Expand
```

--------------------------------

### GitHub Actions workflow to install .NET 10 Preview

Source: https://learn.microsoft.com/en-us/nuget/concepts/nuget-mcp-server

Create this workflow file at .github/workflows/copilot-setup-steps.yml to install .NET 10 Preview 6 or higher so the dnx command is available. The job must be named copilot-setup-steps or it will not be picked up by Copilot.

```yaml
name: "Copilot Setup Steps"

# Automatically run the setup steps when they are changed to allow for easy validation, and
# allow manual testing through the repository's "Actions" tab
on:
  workflow_dispatch:
  push:
    paths:
      - .github/workflows/copilot-setup-steps.yml
  pull_request:
    paths:
      - .github/workflows/copilot-setup-steps.yml

jobs:
  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
  copilot-setup-steps:
    runs-on: ubuntu-latest

    # Set the permissions to the lowest permissions possible needed for your steps.
    # Copilot will be given its own token for its operations.
    permissions:
      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
      contents: read

    # You can define any steps you want, and they will run before the agent starts.
    # If you do not check out your code, Copilot will do this for you.
    steps:
      - name: Install .NET 10.x
        uses: actions/setup-dotnet@v5
        with:
          dotnet-version: |
            10.x
          dotnet-quality: preview

      - name: dotnet --info
        run: dotnet --info
```

--------------------------------

### Install Newtonsoft.Json package

Source: https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-dotnet-cli

Example of installing the `Newtonsoft.Json` package using the `dotnet package add` command.

```bash
dotnet package add Newtonsoft.Json
```

--------------------------------

### Examples of nuget config -Set

Source: https://learn.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-config

Examples demonstrating how to set, clear, and use environment variables in NuGet configuration values.

```bash
nuget config -Set repositoryPath=c:\packages -configfile c:\my.config
```

```bash
nuget config -Set repositoryPath=
```

```bash
nuget config -Set repositoryPath=%PACKAGE_REPO% -configfile %ProgramData%\NuGet\NuGetDefaults.Config
```

```bash
nuget config -Set HTTP_PROXY=http://127.0.0.1 -set HTTP_PROXY.USER=domain\user
```

--------------------------------

### INuGetProjectService.GetInstalledPackagesAsync

Source: https://learn.microsoft.com/en-us/nuget/visual-studio-extensibility/nuget-api-in-visual-studio

Gets the list of packages installed in a project. This method is part of the INuGetProjectService interface and is used to retrieve installed packages for a given project.

```APIDOC
## INuGetProjectService.GetInstalledPackagesAsync

### Description
Gets the list of packages installed in a project.

### Method
GetInstalledPackagesAsync

### Signature
Task<InstalledPackagesResult> GetInstalledPackagesAsync(Guid projectId, CancellationToken cancellationToken)

### Parameters
- **projectId** (Guid) - Required - Project ID (GUID).
- **cancellationToken** (CancellationToken) - Required - Cancellation token.

### Returns
Task<InstalledPackagesResult> - The list of packages in the project.
```

--------------------------------

### Examples: nuget add foo.nupkg -Source c:\bar\ and nuget add foo.nupkg -Source \\bar\packages\

Source: https://learn.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-add

Two example commands for adding a package to a local folder and a UNC path. The first adds foo.nupkg to c:\bar\, and the second adds it to \\bar\packages\. Both use the -Source option to specify the destination.

```bash
nuget add foo.nupkg -Source c:\bar\
```

```bash
nuget add foo.nupkg -Source \\bar\packages\
```

--------------------------------

### Get-Project Examples

Source: https://learn.microsoft.com/en-us/nuget/reference/ps-reference/ps-ref-get-project

Examples of using Get-Project to display information for the default project, a named project, and all projects in the solution.

```powershell
# Displays information for the default project
Get-Project

# Displays information for a project in the solution
Get-Project MyProjectName

    # Displays information for all projects in the solution
Get-Project -All
```

--------------------------------

### Install a package with Install-Package

Source: https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell

Run this command in the Package Manager Console to install a specific package by its ID, for example 'Elmah.MVC'. Requires a solution open and saved in Visual Studio.

```powershell
Install-Package Elmah.MVC
```

--------------------------------

### Example folder structure for multiple frameworks

Source: https://learn.microsoft.com/en-us/nuget/create-packages/supporting-multiple-target-frameworks

Illustrates a folder structure with four framework-specific versions of an assembly.

```text
\lib
    \net46
        \MyAssembly.dll
    \net461
        \MyAssembly.dll
    \uap
        \MyAssembly.dll
    \netcore
        \MyAssembly.dll
```

--------------------------------

### Dependencies section example

Source: https://learn.microsoft.com/en-us/nuget/archive/project-json

Example of a dependencies section in project.json with two package dependencies. The version constraint "5.0.0" implies >= 5.0.0, so NuGet may install a higher version if available.

```json
"dependencies": {
    "Microsoft.NETCore": "5.0.0",
    "System.Runtime.Serialization.Primitives": "4.0.10"
}
```

--------------------------------

### Example of a .pp source file with $rootnamespace$ token

Source: https://learn.microsoft.com/en-us/nuget/create-packages/source-and-config-file-transformations

This example shows a C# source file named ContosoData.cs.pp that uses the $rootnamespace$ token. During installation, NuGet replaces the token with the target project's root namespace, such as Fabrikam.

```csharp
namespace $rootnamespace$.Models
{
    public struct CategoryInfo
    {
        public string categoryid;
        public string description;
        public string htmlUrl;
        public string rssUrl;
        public string title;
    }
}
```

--------------------------------

### Examples of nuget sources operations

Source: https://learn.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-sources

These examples demonstrate adding, disabling, enabling, and updating package sources. Note the use of -StorePasswordInClearText and -ProtocolVersion options.

```bash
nuget sources Add -Name "MyServer" -Source \\myserver\packages
```

```bash
nuget sources Disable -Name "MyServer"
```

```bash
nuget sources Enable -Name "nuget.org"
```

```bash
nuget sources add -name foo.bar -source C:\NuGet\local -username foo -password bar -StorePasswordInClearText -configfile %AppData%\NuGet\my.config
```

```bash
nuget sources add -name MyAzureDevOpsSource -source "https://pkgs.dev.azure.com/yourorgname/yourprojectname/_packaging/yourfeedname/nuget/v3/index.json" -username ignored -password <Personal Access Token>
```

```bash
nuget sources Update -Name "nuget.org" -ProtocolVersion 3
```

--------------------------------

### Install Newtonsoft.Json version 13.0.1

Source: https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-dotnet-cli

Example of adding version 13.0.1 of the `Newtonsoft.Json` package using the `--version` switch.

```bash
dotnet package add Newtonsoft.Json --version 13.0.1
```

--------------------------------

### Examples of nuget locals commands

Source: https://learn.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-locals

Provides two example commands: listing all local folders and clearing the http-cache folder.

```bash
nuget locals all -list
nuget locals http-cache -clear
```

--------------------------------

### init command usage syntax

Source: https://learn.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-init

Shows the general syntax for the init command: nuget init <source> <destination> [options]. The source is the folder containing packages, and the destination is a local folder or UNC pathname.

```bash
nuget init <source> <destination> [options]
```

--------------------------------

### Sync-Package

Source: https://learn.microsoft.com/en-us/nuget/reference/powershell-reference

Get the version of installed package from specified project and syncs the version to the rest of projects in the solution. Available in NuGet 3.0+.

```APIDOC
## Sync-Package

### Description
Get the version of installed package from specified project and syncs the version to the rest of projects in the solution.

### Method
PowerShell Cmdlet

### Endpoint
Sync-Package

### Parameters
None documented in the source.

### Request Example
Get-Help Sync-Package -full

### Response
#### Success Response
None documented in the source.

#### Response Example
None documented in the source.
```

--------------------------------

### Package file structure example

Source: https://learn.microsoft.com/en-us/nuget/reference/errors-and-warnings/nu5131

Shows the expected file layout for a package with lib and ref folders. This example lists the assemblies that should be present in the lib folder.

```text
lib\net472\MyLib.dll
lib\net472\MyHelpers.dll
lib\net472\MyUtilities.dll
```

--------------------------------

### Example .nuspec with minClientVersion attribute

Source: https://learn.microsoft.com/en-us/nuget/reference/nuspec

Shows a .nuspec file with the minClientVersion attribute set to '100.0.0.1'. This attribute specifies the minimum NuGet client version required to install the package. The example includes a metadata section and a files section with a single content file.

```xml
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
    <metadata minClientVersion="100.0.0.1">
        <id>dasdas</id>
        <version>2.0.0</version>
        <title />
        <authors>dsadas</authors>
        <owners />
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
        <description>My package description.</description>
    </metadata>
    <files>
        <file src="content\one.txt" target="content\one.txt" />
    </files>
</package>
```
Tokens:
Raw