NuGet packages in the Package Registry

nuget source Add -Name <source_name> -Source "https://gitlab.example.com/api/v4/projects/<your_project_id>/packages/nuget/index.json" -UserName <gitlab_username or deploy_token_username> -Password <gitlab_personal_access_token or deploy_token>
<source_name> is the desired source name.
For example:
nuget source Add -Name "GitLab" -Source "https://gitlab.example.com/api/v4/projects/10/packages/nuget/index.json" -UserName carol -Password 12345678asdf
Group-level endpoint
To install a NuGet package from a group, use a group-level endpoint.
To use the group-level NuGet endpoint, add the Package Registry as a source with nuget:
nuget source Add -Name <source_name> -Source "https://gitlab.example.com/api/v4/groups/<your_group_id>/-/packages/nuget/index.json" -UserName <gitlab_username or deploy_token_username> -Password <gitlab_personal_access_token or deploy_token>
<source_name> is the desired source name.
For example:
nuget source Add -Name "GitLab" -Source "https://gitlab.example.com/api/v4/groups/23/-/packages/nuget/index.json" -UserName carol -Password 12345678asdf
Add a source with Visual Studio
Project-level endpoint
A project-level endpoint is required to publish NuGet packages to the Package Registry.
A project-level endpoint is also required to install NuGet packages from a project.
To use the project-level NuGet endpoint, add the Package Registry as a source with Visual Studio:

Open Visual Studio.
In Windows, select Tools > Options. On macOS, select Visual Studio > Preferences.
In the NuGet section, select Sources to view a list of all your NuGet sources.
Select Add.

Complete the following fields:

Name: Name for the source.

Source: https://gitlab.example.com/api/v4/projects/<your_project_id>/packages/nuget/index.json,
where <your_project_id> is your project ID, and gitlab.example.com is
your domain name.
Select Save.

When you access the package, you must enter your Username and Password:

Username: Your GitLab username or deploy token username.

Password: Your personal access token or deploy token.
The source is displayed in your list.
If you get a warning, ensure that the Source, Username, and
Password are correct.
Group-level endpoint
To install a package from a group, use a group-level endpoint.
To use the group-level NuGet endpoint, add the Package Registry as a source with Visual Studio:

Open Visual Studio.
In Windows, select Tools > Options. On macOS, select Visual Studio > Preferences.
In the NuGet section, select Sources to view a list of all your NuGet sources.
Select Add.

Complete the following fields:

Name: Name for the source.

Source: https://gitlab.example.com/api/v4/groups/<your_group_id>/-/packages/nuget/index.json,
where <your_group_id> is your group ID, and gitlab.example.com is
your domain name.
Select Save.

When you access the package, you must enter your Username and Password.

Username: Your GitLab username or deploy token username.

Password: Your personal access token or deploy token.
The source is displayed in your list.
If you get a warning, ensure that the Source, Username, and
Password are correct.
Add a source with the .NET CLI
Project-level endpoint
A project-level endpoint is required to publish NuGet packages to the Package Registry.
A project-level endpoint is also required to install NuGet packages from a project.




    
To use the project-level
NuGet endpoint, add the Package Registry as a source with nuget:
dotnet nuget add source "https://gitlab.example.com/api/v4/projects/<your_project_id>/packages/nuget/index.json" --name <source_name> --username <gitlab_username or deploy_token_username> --password <gitlab_personal_access_token or deploy_token>
<source_name> is the desired source name.

--store-password-in-clear-text might be necessary depending on your operating system.
For example:
dotnet nuget add source "https://gitlab.example.com/api/v4/projects/10/packages/nuget/index.json" --name gitlab --username carol --password 12345678asdf
Group-level endpoint
To install a NuGet package from a group, use a group-level endpoint.
To use the group-level
NuGet endpoint, add the Package Registry as a source with nuget:
dotnet nuget add source "https://gitlab.example.com/api/v4/groups/<your_group_id>/-/packages/nuget/index.json" --name <source_name> --username <gitlab_username or deploy_token_username> --password <gitlab_personal_access_token or deploy_token>
<source_name> is the desired source name.

--store-password-in-clear-text might be necessary depending on your operating system.
For example:
dotnet nuget add source "https://gitlab.example.com/api/v4/groups/23/-/packages/nuget/index.json" --name gitlab --username carol --password 12345678asdf
Add a source with a configuration file
Project-level endpoint
A project-level endpoint is required to:

Publish NuGet packages to the Package Registry.
Install NuGet packages from a project.
To use the project-level Package Registry as a source for .NET:

In the root of your project, create a file named nuget.config.

Add this content:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <packageSources>
     <clear />
     <add key="gitlab" value="https://gitlab.example.com/api/v4/projects/<your_project_id>/packages/nuget/index.json" />
 </packageSources>
 <packageSourceCredentials>
     <gitlab>
         <add key="Username" value="%GITLAB_PACKAGE_REGISTRY_USERNAME%" />
         <add key="ClearTextPassword" value="%GITLAB_PACKAGE_REGISTRY_PASSWORD%" />
     </gitlab>
 </packageSourceCredentials>
</configuration>
Configure the necessary environment variables:

export GITLAB_PACKAGE_REGISTRY_USERNAME=<gitlab_username or deploy_token_username>
export GITLAB_PACKAGE_REGISTRY_PASSWORD=<gitlab_personal_access_token or deploy_token>
Group-level endpoint
To install a package from a group, use a group-level endpoint.
To use the group-level Package Registry as a source for .NET:

In the root of your project, create a file named nuget.config.

Add this content:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <packageSources>
     <clear />
     <add key="gitlab" value="https://gitlab.example.com/api/v4/groups/<your_group_id>/-/packages/nuget/index.json" />
 </packageSources>
 <packageSourceCredentials>
     <gitlab>
         <add key="Username" value="%GITLAB_PACKAGE_REGISTRY_USERNAME%" />
         <add key="ClearTextPassword" value="%GITLAB_PACKAGE_REGISTRY_PASSWORD%" />
     </gitlab>
 </packageSourceCredentials>
</configuration>
Configure the necessary environment variables:

export GITLAB_PACKAGE_REGISTRY_USERNAME=<gitlab_username or deploy_token_username>
export GITLAB_PACKAGE_REGISTRY_PASSWORD=<gitlab_personal_access_token or deploy_token>
Publish a NuGet package
Prerequisite:

Set up the source with a project-level endpoint.
When publishing packages:

The Package Registry on GitLab.com can store up to 5 GB of content.
This limit is configurable for self-managed GitLab instances.
If you publish the same package with the same version multiple times, each
consecutive upload is saved as a separate file. When installing a package,
GitLab serves the most recent file.
When publishing packages to GitLab, they aren’t displayed in the packages user
interface of your project immediately. It can take up to 10 minutes to process
a package.
Publish a package with the NuGet CLI
Prerequisites:

A NuGet package created with NuGet CLI.
Set a project-level endpoint.
Publish a package by running this command:
nuget push <package_file> -Source <source_name>
<package_file> is your package filename, ending in .nupkg.

<source_name> is the source name used during setup.
Publish a package with the .NET CLI
Prerequisites:

A NuGet package created with .NET CLI.
Set a project-level endpoint.
Publish a package by running this command:
dotnet nuget push <package_file> --source <source_name>
<package_file> is your package filename, ending in .nupkg.

<source_name> is the source name used during setup.
For example:
dotnet nuget push MyPackage.1.0.0.nupkg --source gitlab
Publish a NuGet package by using CI/CD
Introduced in GitLab 13.3.
If you’re using NuGet with GitLab CI/CD, a CI job token can be used instead of a
personal access token or deploy token. The token inherits the permissions of the
user that generates the pipeline.
This example shows how to create a new package each time the main branch is
updated:

Add a deploy job to your .gitlab-ci.yml file:

image: mcr.microsoft.com/dotnet/core/sdk:3.1
stages:
  - deploy
deploy:
  stage: deploy
  script:
    - dotnet pack -c Release
    - dotnet nuget add source "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/nuget/index.json" --name gitlab --username gitlab-ci-token --password $CI_JOB_TOKEN --store-password-in-clear-text
    - dotnet nuget push "bin/Release/*.nupkg" --source gitlab
  only:
    - main
  environment: production
Commit the changes and push it to your GitLab repository to trigger a new CI/CD build.
Publishing a package with the same name or version
When you publish a package with the same name or version as an existing package,
the existing package is overwritten.
Install packages
If multiple packages have the same name and version, when you install
a package, the most recently-published package is retrieved.
To install a NuGet package from the Package Registry, you must first
add a project-level or group-level endpoint.
Install a package with the NuGet CLI
By default, nuget checks the official source at nuget.org first. If you have
a NuGet package in the Package Registry with the same name as a package at
nuget.org, you must specify the source name to install the correct package.
Install the latest version of a package by running this command:
nuget install <package_id> -OutputDirectory <output_directory> \
  -Version <package_version> \
  -Source <source_name>
<package_id> is the package ID.

<output_directory> is the output directory, where the package is installed.

<package_version> The package version. Optional.

<source_name> The source name. Optional.
Install a package with the .NET CLI
If you have a package in the Package Registry with the same name as a package at
a different source, verify the order in which dotnet checks sources during
install. This is defined in the nuget.config file.
Install the latest version of a package by running this command:
dotnet add package <package_id> \
       -v <package_version>
<package_id> is the package ID.

<package_version> is the package version. Optional.
Symbol packages
Introduced in GitLab 14.1.
If you push a .nupkg, symbol package files in the .snupkg format are uploaded automatically. You
can also push them manually:
nuget push My.Package.snupkg -Source <source_name>
Consuming symbol packages is not yet guaranteed using clients such as Visual Studio or
dotnet-symbol. The .snupkg files are available for download through the UI or the
API.
Follow the NuGet symbol package issue
for further updates.
Supported CLI commands
The GitLab NuGet repository supports the following commands for the NuGet CLI (nuget) and the .NET
CLI (dotnet):

nuget push: Upload a package to the registry.

dotnet nuget push: Upload a package to the registry.

nuget install: Install a package from the registry.

dotnet add: Install a package from the registry.
Example project
For an example, see the Guided Exploration project
Utterly Automated Software and Artifact Versioning with GitVersion.
This project:

Generates NuGet packages by the msbuild method.
Generates NuGet packages by the nuget.exe method.
Uses GitLab releases and release-cli in connection with NuGet packaging.
Uses a tool called GitVersion
to automatically determine and increment versions for the NuGet package in complex repositories.
You can copy this example project to your own group or instance for testing. See the project page
for more details on what other GitLab CI patterns are demonstrated.
Troubleshooting
Clear NuGet cache
To improve performance, NuGet caches files related to a package. If you encounter issues, clear the
cache with this command:
nuget locals all -clear
Error publishing or Invalid Package: Failed metadata extraction error messages when trying to publish NuGet packages in a Docker-based GitLab installation
Webhook requests to local network addresses are blocked to prevent exploitation of internal web services. If you get Error publishing or Invalid Package messages when you try to publish NuGet packages, change your network settings to allow webhook and integration requests to the local network.

 Help & feedback
Docs
Edit this page
to fix an error or add an improvement in a merge request.

Create an issue
to suggest an improvement to this page.

Product
Create an issue
if there's something you don't like about this feature.

Propose functionality
by submitting a feature request.

Join First Look
to help shape new features.
Feature availability and product trials
View pricing
to see all GitLab tiers and features, or to upgrade.

Try GitLab for free
with access to all features for 30 days.

Get Help

If you didn't find what you were looking for,
search the docs.

If you want help with something specific and could use community support,
post on the GitLab forum.

For problems setting up or using this feature (depending on your GitLab
subscription).

Request support