dotnet list package¶

This article applies to: ✔️ .NET Core 3.1 SDK and later versions

NAME¶

dotnet-list-package - Lists the package references for a project or solution.

SYNOPSIS¶

dotnet list [<PROJECT>|<SOLUTION>] package [--config <SOURCE>]


    [--deprecated]


    [--framework <FRAMEWORK>] [--highest-minor] [--highest-patch]


    [--include-prerelease] [--include-transitive] [--interactive]


    [--outdated] [--source <SOURCE>] [-v|--verbosity <LEVEL>]


    [--vulnerable]


    [--format <console|json>]


    [--output-version <VERSION>]
dotnet list package -h|--help
    

DESCRIPTION¶

The dotnet list package command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process. The following example shows the output of the dotnet list package command for the SentimentAnalysis (https://github.com/dotnet/samples/tree/main/machine-learning/tutorials/SentimentAnalysis) project:

Project 'SentimentAnalysis' has the following package references


   [netcoreapp2.1]:


   Top-level Package               Requested   Resolved


   > Microsoft.ML                  1.4.0       1.4.0


   > Microsoft.NETCore.App   (A)   [2.1.0, )   2.1.0
(A) : Auto-referenced package.
    

The Requested column refers to the package version specified in the project file and can be a range. The Resolved column lists the version that the project is currently using and is always a single value. The packages displaying an (A) right next to their names represent implicit package references that are inferred from your project settings (Sdk type, or <TargetFramework> or <TargetFrameworks> property).

Use the --outdated option to find out if there are newer versions available of the packages you’re using in your projects. By default, --outdated lists the latest stable packages unless the resolved version is also a prerelease version. To include prerelease versions when listing newer versions, also specify the --include-prerelease option. To update a package to the latest version, use dotnet add package.

The following example shows the output of the dotnet list package --outdated --include-prerelease command for the same project as the previous example:

The following sources were used:


   https://api.nuget.org/v3/index.json


   C:\Program Files (x86)\Microsoft SDKs\NuGetPackages\
Project `SentimentAnalysis` has the following updates to its packages


   [netcoreapp2.1]:


   Top-level Package      Requested   Resolved   Latest


   > Microsoft.ML         1.4.0       1.4.0      1.5.0-preview
    

If you need to find out whether your project has transitive dependencies, use the --include-transitive option. Transitive dependencies occur when you add a package to your project that in turn relies on another package. The following example shows the output from running the dotnet list package --include-transitive command for the HelloPlugin (https://github.com/dotnet/samples/tree/main/core/extensions/AppWithPlugin/HelloPlugin) project, which displays top-level packages and the packages they depend on:

Project 'HelloPlugin' has the following package references


   [netcoreapp3.0]:


   Transitive Package      Resolved


   > PluginBase            1.0.0
    

ARGUMENTS¶

PROJECT | SOLUTION

The project or solution file to operate on. If not specified, the command searches the current directory for one. If more than one solution or project is found, an error is thrown.

OPTIONS¶

•

--config <SOURCE>

•

--deprecated

•

--framework <FRAMEWORK>

•

-?|-h|--help

•

--highest-minor

•

--highest-patch

•

--include-prerelease

•

--include-transitive

•

--interactive

•

--outdated

•

-s|--source <SOURCE>

•

-v|--verbosity <LEVEL>

•

--vulnerable

•

--format <console|json>

•

--output-version <VERSION>

EXAMPLES¶

•

List package references of a specific project:

•

List package references that have newer versions available, including prerelease versions:

•

List package references for a specific target framework:

•

List package references in machine readable json output format:

•

List package references for a specific target framework in machine readable json output format:

•

Save machine readable json output of package references, including transitive dependency and vulnerability details into a file:

•

List package references in machine readable json output format with output version 1: