docs/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md

title, intro, product, redirect_from, versions, shortTitle

title	intro	product	redirect_from	versions	shortTitle
Working with the NuGet registry	You can configure the `dotnet` command-line interface (CLI) to publish NuGet packages to {% data variables.product.prodname_registry %} and to use packages stored on {% data variables.product.prodname_registry %} as dependencies in a .NET project.	{% data reusables.gated-features.packages %}	/articles/configuring-nuget-for-use-with-github-package-registry /github/managing-packages-with-github-package-registry/configuring-nuget-for-use-with-github-package-registry /github/managing-packages-with-github-packages/configuring-nuget-for-use-with-github-packages /github/managing-packages-with-github-packages/configuring-dotnet-cli-for-use-with-github-packages /packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages /packages/guides/configuring-dotnet-cli-for-use-with-github-packages	fpt ghes ghae * * *	NuGet registry

{% data reusables.package_registry.packages-ghes-release-stage %} {% data reusables.package_registry.packages-ghae-release-stage %}

{% data reusables.package_registry.admins-can-configure-package-types %}

Authenticating to {% data variables.product.prodname_registry %}

{% data reusables.package_registry.authenticate-packages %}

Authenticating with GITHUB_TOKEN in {% data variables.product.prodname_actions %}

Use the following command to authenticate to {% data variables.product.prodname_registry %} in a {% data variables.product.prodname_actions %} workflow using the GITHUB_TOKEN instead of hardcoding a token in a nuget.config file in the repository:

dotnet nuget add source --username USERNAME --password {%raw%}${{ secrets.GITHUB_TOKEN }}{% endraw %} --store-password-in-clear-text --name github "https://{% ifversion fpt %}nuget.pkg.github.com{% else %}nuget.HOSTNAME{% endif %}/OWNER/index.json"

{% data reusables.package_registry.authenticate-packages-github-token %}

Authenticating with a personal access token

{% data reusables.package_registry.required-scopes %}

To authenticate to {% data variables.product.prodname_registry %} with the dotnet command-line interface (CLI), create a nuget.config file in your project directory specifying {% data variables.product.prodname_registry %} as a source under packageSources for the dotnet CLI client.

You must replace:

• USERNAME with the name of your user account on {% data variables.product.prodname_dotcom %}.
• TOKEN with your personal access token.
• OWNER with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes or ghae %}
• HOSTNAME with the host name for {% data variables.product.product_location %}.{% endif %}

{% ifversion ghes %}If your instance has subdomain isolation enabled: {% endif %}

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear />
        <add key="github" value="https://{% ifversion fpt %}nuget.pkg.github.com{% else %}nuget.HOSTNAME{% endif %}/OWNER/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="USERNAME" />
            <add key="ClearTextPassword" value="TOKEN" />
        </github>
    </packageSourceCredentials>
</configuration>

{% ifversion ghes %} If your instance has subdomain isolation disabled:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear />
        <add key="github" value="https://HOSTNAME/_registry/nuget/OWNER/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="USERNAME" />
            <add key="ClearTextPassword" value="TOKEN" />
        </github>
    </packageSourceCredentials>
</configuration>

{% endif %}

Publishing a package

You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a nuget.config file{% ifversion fpt or ghes > 2.22 or ghae %}, or by using the --api-key command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT){% endif %}.

{% ifversion fpt or ghes > 2.22 or ghae %}

Publishing a package using a GitHub PAT as your API key

If you don't already have a PAT to use for your {% data variables.product.prodname_dotcom %} account, see "Creating a personal access token."

1. Create a new project.

dotnet new console --name OctocatApp

2. Package the project.

dotnet pack --configuration Release

3. Publish the package using your PAT as the API key.

dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg"  --api-key <em>YOUR_GITHUB_PAT</em> --source "github"

{% data reusables.package_registry.viewing-packages %}

{% endif %}

Publishing a package using a nuget.config file

When publishing, you need to use the same value for OWNER in your csproj file that you use in your nuget.config authentication file. Specify or increment the version number in your .csproj file, then use the dotnet pack command to create a .nuspec file for that version. For more information on creating your package, see "Create and publish a package" in the Microsoft documentation.

{% data reusables.package_registry.authenticate-step %} 2. Create a new project.

dotnet new console --name OctocatApp

3. Add your project's specific information to your project's file, which ends in .csproj. You must replace:
   • OWNER with the name of the user or organization account that owns the repository containing your project.
   • REPOSITORY with the name of the repository containing the package you want to publish.
   • 1.0.0 with the version number of the package.{% ifversion ghes or ghae %}
   • HOSTNAME with the host name for {% data variables.product.product_location %}.{% endif %}

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>OctocatApp</PackageId>
    <Version>1.0.0</Version>
    <Authors>Octocat</Authors>
    <Company>GitHub</Company>
    <PackageDescription>This package adds an Octocat!</PackageDescription>
    <RepositoryUrl>https://{% ifversion fpt %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY</RepositoryUrl>
  </PropertyGroup>

</Project>

4. Package the project.

dotnet pack --configuration Release

5. Publish the package using the key you specified in the nuget.config file.

dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --source "github"

{% data reusables.package_registry.viewing-packages %}

Publishing multiple packages to the same repository

To publish multiple packages to the same repository, you can include the same {% data variables.product.prodname_dotcom %} repository URL in the RepositoryURL fields in all .csproj project files. {% data variables.product.prodname_dotcom %} matches the repository based on that field.

For example, the OctodogApp and OctocatApp projects will publish to the same repository:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>OctodogApp</PackageId>
    <Version>1.0.0</Version>
    <Authors>Octodog</Authors>
    <Company>GitHub</Company>
    <PackageDescription>This package adds an Octodog!</PackageDescription>
    <RepositoryUrl>https://{% ifversion fpt %}github.com{% else %}HOSTNAME{% endif %}/octo-org/octo-cats-and-dogs</RepositoryUrl>
  </PropertyGroup>

</Project>

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>OctocatApp</PackageId>
    <Version>1.0.0</Version>
    <Authors>Octocat</Authors>
    <Company>GitHub</Company>
    <PackageDescription>This package adds an Octocat!</PackageDescription>
    <RepositoryUrl>https://{% ifversion fpt %}github.com{% else %}HOSTNAME{% endif %}/octo-org/octo-cats-and-dogs</RepositoryUrl>
  </PropertyGroup>

</Project>

Installing a package

Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from nuget.org. Add your package dependencies to your .csproj file, specifying the package name and version. For more information on using a .csproj file in your project, see "Working with NuGet packages" in the Microsoft documentation.

{% data reusables.package_registry.authenticate-step %}

2. To use a package, add ItemGroup and configure the PackageReference field in the .csproj project file, replacing the OctokittenApp package with your package dependency and 1.0.0 with the version you want to use:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.0</TargetFramework>
    <PackageId>OctocatApp</PackageId>
    <Version>1.0.0</Version>
    <Authors>Octocat</Authors>
    <Company>GitHub</Company>
    <PackageDescription>This package adds an Octocat!</PackageDescription>
    <RepositoryUrl>https://{% ifversion fpt %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY</RepositoryUrl>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="OctokittenApp" Version="12.0.2" />
  </ItemGroup>

</Project>

3. Install the packages with the restore command.

dotnet restore

Troubleshooting

Your NuGet package may fail to push if the RepositoryUrl in .csproj is not set to the expected repository .

Further reading

• "{% ifversion fpt or ghes > 3.0 %}Deleting and restoring a package{% elsif ghes < 3.1 or ghae %}Deleting a package{% endif %}"