Prerequisites

1. Create Artifact Registry
2. Obtain Artifact Registry Address
3. Create Access Token

Local Usage

Client Instructions

Client/Tool	dotnet CLI	nuget.exe
Use Case	.NET Core/.NET 5+ projects	Legacy .NET Framework projects
Cross-platform Support	Native support	Requires Mono
Installation	Installed with .NET SDK, no additional setup	Requires downloading nuget.exe

Credential Management Commands

You can use CNB's access token as login credentials. Configuration commands:

dotnet CLI

Replace <YOUR_TOKEN> with the access token, <SOURCE_NAME> with a custom source name, <REPO_URL> with the Artifact Registry address

dotnet nuget add source <REPO_URL> --name <SOURCE_NAME> --username cnb --password <YOUR_TOKEN> --store-password-in-clear-text
# Example: Add credential cnb-nuget-repo
# dotnet nuget add source https://nuget.cnb.build/cnb/nuget-repo/-/packages/v3/index.json --name cnb-nuget-repo --username cnb --password <YOUR_TOKEN> --store-password-in-clear-text

dotnet nuget list source

Replace <SOURCE_NAME> with a custom source name

dotnet nuget remove source <SOURCE_NAME>
# Example: Remove credential for cnb-nuget-repo source
# dotnet nuget remove source cnb-nuget-repo

Client/Tool
Windows	%AppData%\NuGet\NuGet.Config
Linux/macOS	~/.config/NuGet/NuGet.Config or ~/.nuget/NuGet/NuGet.Config

nuget.exe

Replace <YOUR_TOKEN> with the access token, <SOURCE_NAME> with a custom source name, <REPO_URL> with the Artifact Registry address

nuget sources add -source <REPO_URL> -name <SOURCE_NAME> -username cnb -password <YOUR_TOKEN> -StorePasswordInClearText
# Example: Add credential cnb-nuget-repo
# nuget sources add -source https://nuget.cnb.build/cnb/nuget-repo/-/packages/v3/index.json -name cnb-nuget-repo -username cnb -password <YOUR_TOKEN> -StorePasswordInClearText

Replace <YOUR_TOKEN> with the access token, <REPO_URL> with the Artifact Registry address

nuget setapikey <YOUR_TOKEN> -source <REPO_URL>
# Example: Add API key credential
# nuget setapikey <YOUR_TOKEN> -source https://nuget.cnb.build/cnb/nuget-repo/-/packages/v3/index.json

nuget sources

Replace <SOURCE_NAME> with a custom source name

nuget sources remove -name <SOURCE_NAME>
# Example: Remove credential for cnb-nuget-repo source
# nuget sources remove -name cnb-nuget-repo

Client/Tool
Windows	%AppData%\NuGet\NuGet.Config
Linux/macOS	~/.config/NuGet/NuGet.Config or ~/.nuget/NuGet/NuGet.Config

Artifact Management Commands

Ensure credentials are configured before executing artifact management commands.

dotnet CLI

Replace <PACKAGE_NAME> with the package name, <VERSION> with the version number, <SOURCE_NAME> with a custom source name

dotnet add package <PACKAGE_NAME> --version <VERSION> --source <SOURCE_NAME>
# Example: Pull version 1.0.0 of mynupkg package from the Artifact Registry named cnb-nuget-repo
# dotnet add package test --version 1.0.0 --source cnb-nuget-repo

Replace <CSPROJ_PATH> with the .csproj file path, <PKG_PATH> with the nupkg package output path, <VERSION> with the version number

dotnet pack <CSPROJ_PATH> -p:PackageVersion=<VERSION>  --configuration Release --output <PKG_PATH>
# Example: Build artifact
# dotnet pack mynupkg.csproj --configuration Release --output nupkgs 
# Or build a specific version artifact
# dotnet pack mynupkg.csproj -p:PackageVersion=1.0.0 --configuration Release --output nupkgs

Replace <NUPKG_PATH> with the nupkg package path, <SOURCE_NAME> with a custom source name, <YOUR_TOKEN> with the access token

dotnet nuget push <NUPKG_PATH> --source <SOURCE_NAME> -k <YOUR_TOKEN>
# Example: Push version 1.0.0 of mynupkg package
# dotnet nuget push ./mynupkg.1.0.0.nupkg --source cnb-nuget-repo -k <YOUR_TOKEN>

Replace <PACKAGE_NAME> with the package name, <VERSION> with the version number, <SOURCE_NAME> with a custom source name

dotnet nuget delete <PACKAGE_NAME> <VERSION> --source <SOURCE_NAME>
# Example: Delete version 1.0.0 of mynupkg package from cnb-nuget-repo source
# dotnet nuget delete mynupkg 1.0.0 --source cnb-nuget-repo

Replace <PACKAGE_NAME> with the package name, <SOURCE_NAME> with a custom source name

dotnet package search <PACKAGE_NAME> --source <SOURCE_NAME>
# Example: Query packages containing mynuget from the Artifact Registry named cnb-nuget-repo
# dotnet package search mynuget --source cnb-nuget-repo

dotnet nuget locals http-cache --clear

dotnet nuget locals all --clear

nuget.exe

Replace <PACKAGE_NAME> with the package name, <VERSION> with the version number, <SOURCE_NAME> with a custom source name

nuget install <PACKAGE_NAME> -version <VERSION> -source <SOURCE_NAME>
# Example: Pull version 1.0.0 of mynupkg package from the Artifact Registry named cnb-nuget-repo
# nuget install mynupkg -version 1.0.0 -source cnb-nuget-repo

Replace <CSPROJ_PATH> with the .csproj file path, <PKG_PATH> with the nupkg package output path

nuget pack <CSPROJ_PATH> -Version <VERSION>  -Properties Configuration=Release 
# Example: Build artifact
# nuget pack mynupkg.csproj -Properties Configuration=Release
# Or build a specific version artifact
# nuget pack mynupkg.csproj -Version 1.0.0 -Properties Configuration=Release

Replace <NUPKG_PATH> with the nupkg package path, <SOURCE_NAME> with a custom source name

nuget push <NUPKG_PATH> -source <SOURCE_NAME>
# Example: Push version 1.0.0 of mynupkg package to the Artifact Registry named cnb-nuget-repo
# nuget push ./mynupkg.1.0.0.nupkg -source cnb-nuget-repo

Replace <PACKAGE_NAME> with the package name, <VERSION> with the version number, <SOURCE_NAME> with a custom source name

nuget delete <PACKAGE_NAME> <VERSION> -source <SOURCE_NAME>
# Example: Delete version 1.0.0 of mynupkg package from the Artifact Registry named cnb-nuget-repo
# nuget delete mynupkg 1.0.0 -source cnb-nuget-repo

Replace <PACKAGE_NAME> with the package name, <SOURCE_NAME> with a custom source name

nuget search <PACKAGE_NAME> -source <SOURCE_NAME>
# Example: Query packages containing mynuget from the Artifact Registry named cnb-nuget-repo
# nuget search mynuget -source cnb-nuget-repo

nuget locals http-cache -clear

nuget locals all -clear

Usage in Cloud Native Build

Build nupkg packages in the pipeline and push them to the Artifact Registry.

Replace <REPO_URL> with the Artifact Registry address, <SOURCE_NAME> with a custom source name, <CSPROJ_PATH> with the .csproj file path, <PKG_PATH> with the nupkg package output path, <NUPKG_NAME> with the nupkg package name

.cnb.yml

main:
  push:
    - docker:
        image: mcr.microsoft.com/dotnet/sdk:9.0
      stages:
        - name: Configure nuget repository address, username, and password
          script: dotnet nuget add source <REPO_URL> --name <SOURCE_NAME> --username ${CNB_TOKEN_USER_NAME} --password ${CNB_TOKEN} --store-password-in-clear-text
        - name: Package nuget artifact 
          script: dotnet pack <CSPROJ_PATH> --configuration Release --output <PKG_PATH>  
        - name: Push nuget artifact to CNB
          script: dotnet nuget push <PKG_PATH>/<NUPKG_NAME> --source <SOURCE_NAME> -k ${CNB_TOKEN}

• Example:

.cnb.yml

main: 
  push: 
    - docker: 
        image: mcr.microsoft.com/dotnet/sdk:9.0 
      stages: 
        - name: Configure nuget repository address, username, and password
          script: dotnet nuget add source https://nuget.cnb.build/cnb/nuget-repo/-/packages/v3/index.json --name cnb-nuget-repo --username ${CNB_TOKEN_USER_NAME} --password ${CNB_TOKEN} --store-password-in-clear-text
        - name: Build nuget artifact
          script: dotnet pack mynupkg.csproj --configuration Release --output nupkgs 
        - name: Push nuget artifact to CNB 
          script: dotnet nuget push nupkgs/*.nupkg --source cnb-nuget-repo -k ${CNB_TOKEN}

Usage in Workspaces

1. Configure dotnet development environment in .cnb.yml

.cnb.yml

$: 
  vscode:
    - docker:
        image: mcr.microsoft.com/dotnet/sdk:9.0

2. Configure nuget repository address, username, and password

Replace <REPO_URL> with the Artifact Registry address, <SOURCE_NAME> with a custom source name

dotnet nuget add source <REPO_URL> --name <SOURCE_NAME> --username cnb --password <YOUR_TOKEN> --store-password-in-clear-text
dotnet pack xxx.csproj --configuration Release --output nupkgs
dotnet nuget push "nupkgs/*.nupkg" --source <SOURCE_NAME> -k ${CNB_TOKEN}

• Example: Build nuget artifact and push it to CNB

dotnet nuget add source https://nuget.cnb.build/cnb/nuget-repo/-/packages/v3/index.json --name cnb-nuget-repo --username cnb --password <YOUR_TOKEN> --store-password-in-clear-text
dotnet pack mynupkg.csproj --configuration Release --output nupkgs
dotnet nuget push "nupkgs/*.nupkg" --source cnb-nuget-repo -k ${CNB_TOKEN}

FAQ

Q1: Encountered 401 Forbidden error

Possible cause: Insufficient permissions for the credential.

Solution: Reconfigure the access token with the required permissions. Token acquisition: Personal Settings -> Access Tokens -> Add Access Token(Open in new window) -> Select the appropriate permissions for the Artifact Registry.

Q2: Encountered 403 Forbidden error

Possible cause: Incorrect credential configuration.

Solution: Configure the correct access token for the Artifact Registry. Token acquisition: Personal Settings -> Access Tokens -> Add Access Token(Open in new window) -> Select the appropriate permissions for the Artifact Registry.

Q3: Encountered 409 Forbidden error

Possible cause: Package already exists and overwriting is not allowed.

Solution: To overwrite the package, go to the corresponding Artifact Registry -> Artifact Registry Settings -> Policy Management -> Select "Allow Overwriting Existing Versions".

Q4: How to support HTTP

Possible cause: Client only supports HTTPS by default.

Solution:

Client/Tool	HTTP support
dotnet CLI	Specify --allow-insecure-connections when adding the repository credential
nuget.exe	Specify -AllowInsecureConnections when adding the repository credential

More Usage

For more NuGet usage, please refer to the NuGet official documentation.

Previous pageohpm Artifact Registry

Next pageComposer Artifact Registry