dotnet list package

本文 适用于: ✔️ .NET Core 3.1 SDK 及更高版本

名字

dotnet list package - 列出项目或解决方案的包引用。

概要

dotnet list [<PROJECT>|<SOLUTION>] package [--config <SOURCE>]
    [--deprecated]
    [-f|--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

描述

dotnet list package 命令提供了一个方便的选项,用于列出特定项目或解决方案的所有 NuGet 包引用。 首先需要生成项目才能让此命令处理所需的资产。 以下示例显示了 SentimentAnalysis 项目的 dotnet list package 命令的输出:

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.

请求 列引用项目文件中指定的包版本,可以是范围。 解析 列列出了项目当前正在使用的版本,并且始终是单个值。 显示其名称旁边的 (A) 的包表示从项目设置推断的隐式包引用(Sdk 类型或 <TargetFramework><TargetFrameworks> 属性)。

使用“--outdated”选项可了解项目中正在使用的包是否有较新版本。 默认情况下,--outdated 列出最新的稳定包,除非解析的版本也是预发行版本。 若要在列出较新版本时包括预发行版,还指定 --include-prerelease 选项。 若要将包更新到最新版本,请使用 dotnet add 包

以下示例显示了与上一示例相同的项目的 dotnet list package --outdated --include-prerelease 命令的输出:

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

如果需要了解项目是否具有可传递依赖项,请使用 --include-transitive 选项。 将包添加到又依赖于另一个包的项目时,会发生可传递依赖项。 以下示例显示了运行 HelloPlugin 项目的 dotnet list package --include-transitive 命令的输出,该命令显示顶级包及其依赖的包:

Project 'HelloPlugin' has the following package references
   [netcoreapp3.0]:
   Transitive Package      Resolved
   > PluginBase            1.0.0

参数

PROJECT | SOLUTION

要作的项目或解决方案文件。 如果未指定,该命令将在当前目录中搜索一个目录。 如果找到多个解决方案或项目,则会引发错误。

选项

  • --config <SOURCE>

    搜索较新的包时要使用的 NuGet 源。 需要 --outdated 选项。

  • --deprecated

    显示已弃用的包。

  • -f|--framework <FRAMEWORK>

    仅显示适用于指定 目标框架的包。 若要指定多个框架,请多次重复该选项。 例如:--framework net6.0 --framework netstandard2.0。 从 .NET 9 SDK 开始,选项(-f)的简短形式可用。

  • -?|-h|--help

    输出有关如何使用命令的说明。

  • --highest-minor

    在搜索较新的包时,仅考虑具有匹配的主版本号的包。 需要 --outdated--deprecated 选项。

  • --highest-patch

    在搜索较新的包时,仅考虑具有匹配的主版本号和次要版本号的包。 需要 --outdated--deprecated 选项。

  • --include-prerelease

    在搜索较新的包时,请考虑具有预发行版版本的包。 需要 --outdated--deprecated 选项。

  • --include-transitive

    列出可传递包,以及顶级包。 指定此选项时,可以获取顶级包所依赖的包列表。

  • --interactive

    允许命令停止并等待用户输入或作。 例如,若要完成身份验证。 自 .NET Core 3.0 SDK 起可用。

  • --outdated

    列出提供较新版本的包。

  • -s|--source <SOURCE>

    搜索较新的包时要使用的 NuGet 源。 需要 --outdated--deprecated 选项。

  • -v|--verbosity <LEVEL>

    设置命令的详细级别。 允许的值为 q[uiet]m[inimal]n[ormal]d[etailed]diag[nostic]。 默认值为 minimal。 有关详细信息,请参阅 LoggerVerbosity

  • --vulnerable

    列出具有已知漏洞的包。 不能与 --deprecated--outdated 选项结合使用。 使用配置文件中的 <AuditSources> 属性指定从 VulnerabilityInfo 资源获取的漏洞数据源。 如果未指定 <AuditSources>,则使用指定的 <PackageSources> 加载漏洞数据。 有关详细信息,请参阅 审核源如何扫描 NuGet 包中的安全漏洞

  • --format <console|json>

    设置报表输出格式。 允许的值 consolejson。 默认为 console。 从 .NET SDK 7.0.200 开始可用。

  • --output-version <VERSION>

    设置报表输出版本。 允许的值 1。 默认为 1。 需要 --format json 选项。 当新的 JSON 版本可用时,该命令将默认生成新格式。 使用此选项可以指定命令应生成早期格式。 从 .NET SDK 7.0.200 开始可用。

例子

  • 列出特定项目的包引用:

    dotnet list SentimentAnalysis.csproj package
    
  • 列出具有较新版本的包引用,包括预发行版:

    dotnet list package --outdated --include-prerelease
    
  • 列出特定目标框架的包引用:

    dotnet list package --framework netcoreapp3.0
    
  • 以计算机可读 json 输出格式列出包引用:

    dotnet list package --format json
    
  • 以计算机可读 json 输出格式列出特定目标框架的包引用:

    dotnet list package --framework netcoreapp3.0 --format json
    
  • 将包引用的计算机可读 json 输出(包括可传递依赖项和漏洞详细信息)保存到文件中:

    dotnet list package --include-transitive --vulnerable --format json >> dependencyReport.json
    
  • 使用输出版本 1 以计算机可读 json 输出格式列出包引用:

    dotnet list package --format json --output-version 1