NuGroom

Getting Started

Prerequisites

• .NET 10.0 or later
• Azure DevOps Personal Access Token with Code (Read) permissions
• For automatic updates: Azure DevOps PAT with Code (Read & Write) and Pull Request Threads (Read & Write) permissions
• Internet connection (for package resolution)
• For private feeds: Additional PAT tokens with package read permissions

---

Basic Usage (NuGet.org only)

NuGroom --organization "https://dev.azure.com/yourorg" --token "your-pat-token"

Using a Configuration File (Recommended)

NuGroom --config settings.json

See Configuration for the full config file format.

---

Quick Examples

Private Feed with PAT Authentication (CLI)

NuGroom -o "https://dev.azure.com/yourorg" -t "your-token" \
  --feed https://pkgs.dev.azure.com/yourorg/_packaging/MyFeed/nuget/v3/index.json \
  --feed-auth "https://pkgs.dev.azure.com/yourorg/_packaging/MyFeed/nuget/v3/index.json|VssSessionToken|your-feed-pat"

Export Results as JSON (default)

NuGroom --config settings.json --export-packages report.json

Export Results as CSV

NuGroom --config settings.json --export-packages packages.csv --export-format csv

Export Warnings and Recommendations Separately

NuGroom --config settings.json --export-warnings warnings.json --export-recommendations recommendations.json

Export Warnings as CSV

NuGroom --config settings.json --export-warnings warnings.csv --export-format csv

Export SBOM (SPDX 3.0.0)

NuGroom --config settings.json --export-sbom sbom.spdx.json

Dry-Run Update Preview

NuGroom --config settings.json --dry-run --update-scope Patch

Apply Package Updates (Creates Branches and PRs)

NuGroom --config settings.json --update-references --update-scope Minor

Update and Tag Commits

NuGroom --config settings.json --update-references --tag-commits

Skip Repositories with Existing NuGroom PRs

NuGroom --config settings.json --update-references --no-incremental-prs

Update Only Internal Packages

NuGroom --config settings.json --update-references --source-packages-only

Increment Project Patch Version on Update

NuGroom --config settings.json --update-references --increment-project-version

Increment All Project Versions (Major) on Update

NuGroom --config settings.json --update-references --increment-project-version-all Major

Update with Separate Source and Target Branches

NuGroom --config settings.json --update-references \
  --source-branch "release/*" --target-branch "develop/*"

Enable Debug Logging

NuGroom --config settings.json --debug

Sync a Package to the Latest Version

NuGroom --config settings.json --sync Newtonsoft.Json

Sync a Package to a Specific Version

NuGroom --config settings.json --sync Newtonsoft.Json 13.0.1

Sync a Package (Dry-Run Preview)

NuGroom --config settings.json --sync Newtonsoft.Json 13.0.1 --dry-run

Migrate to Central Package Management (Dry-Run Preview)

NuGroom --config settings.json --migrate-to-cpm --dry-run

Migrate to Central Package Management (Creates Branches and PRs)

NuGroom --config settings.json --migrate-to-cpm --update-references

Migrate to CPM with Per-Project Props Files

NuGroom --config settings.json --migrate-to-cpm --per-project --dry-run

Scan for Vulnerabilities Only

NuGroom --config settings.json --list-vulnerabilities

Scan Local Files for Vulnerabilities Only

NuGroom --paths ./src --list-vulnerabilities

Scan for Vulnerabilities and Export Report

NuGroom --config settings.json --list-vulnerabilities --export-vulnerabilities vuln-report.json

Exclude Test Projects

NuGroom --config settings.json --exclude-project ".*\.Test[s]?\.csproj$"

Include Legacy packages.config Projects

NuGroom --config settings.json --include-packages-config

Exclude Repositories by Name Pattern

NuGroom --config settings.json --exclude-repo "Legacy-.*" --exclude-repo "Archive\..*"

Multiple Private Feeds with Authentication

NuGroom -o "https://dev.azure.com/yourorg" -t "your-token" \
  --feed https://pkgs.dev.azure.com/org1/_packaging/Feed1/nuget/v3/index.json \
  --feed https://pkgs.dev.azure.com/org2/_packaging/Feed2/nuget/v3/index.json \
  --feed-auth "https://pkgs.dev.azure.com/org1/_packaging/Feed1/nuget/v3/index.json||pat1" \
  --feed-auth "https://pkgs.dev.azure.com/org2/_packaging/Feed2/nuget/v3/index.json||pat2"

---

Next: CLI Reference · Configuration · Features

This site is open source. Improve this page.