dotnet new list

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

Name

dotnet new list - 列出正在使用 dotnet new的可用模板。

概要

dotnet new list [<TEMPLATE_NAME>] [--author <AUTHOR>] [-lang|--language {"C#"|"F#"|VB}]
    [--tag <TAG>] [--type <TYPE>] [--columns <COLUMNS>] [--columns-all]
    [-o|--output <output>] [--project <project>] [--ignore-constraints]
    [-d|--diagnostics] [--verbosity <LEVEL>] [-h|--help]

Description

dotnet new list 命令列出了要使用的 dotnet new可用模板。 <如果指定了TEMPLATE_NAME>,则列出包含指定名称的模板。 此选项仅列出默认模板和已安装的模板。 若要在 NuGet 中查找可在本地安装的模板,请使用 search 该命令。

从 .NET SDK 7.0.100 开始,该 list 命令可能不会显示计算机上安装的所有模板。 它考虑了模板约束的结果,并且不能使用的模板不会显示。 若要强制显示所有模板,请使用 --ignore-constraints 该选项。

注释

从 .NET 7 SDK 开始,dotnet new 语法已更改:

  • --list--search--install--uninstall 选项成为 listsearchinstalluninstall 子命令。
  • --update-apply 选项成为 update 子命令。
  • 若要使用 --update-check,请使用 update 子命令和 --check-only 选项。

以前可用的其他选项仍可用于各自的子命令。 可通过 -h--help 选项获取每个子命令的单独帮助:dotnet new <subcommand> --help 列出了子命令的所有支持选项。

此外,选项卡完成现在可用于 dotnet new。 它支持完成已安装的模板名称和所选模板提供的选项。 若要激活 .NET SDK 的选项卡完成,请参阅 启用选项卡完成

旧语法的示例:

  • 列出所有单页应用程序(SPA)模板:

    • 自 .NET SDK 6.0.100 起
    dotnet new --list spa
    
    • 在 .NET SDK 6.0.100 之前
    dotnet new spa --list
    

Arguments

  • TEMPLATE_NAME

    如果指定了参数,则只会显示模板 <TEMPLATE_NAME> 名称或短名称中包含的模板。

选项

  • --author <AUTHOR>

    基于模板作者筛选模板。 支持部分匹配。 自 .NET SDK 5.0.300 起可用。

  • --columns <COLUMNS>

    要在输出中显示的列的逗号分隔列表。 支持的列包括:

    • language - 模板支持的语言的逗号分隔列表。
    • tags - 模板标记列表。
    • author - 模板作者。
    • type - 模板类型:项目或项。

    始终显示模板名称和短名称。 列的默认列表是模板名称、短名称、语言和标记。 此列表等效于指定 --columns=language,tags。 自 .NET SDK 5.0.300 起可用。

  • --columns-all

    显示输出中的所有列。 自 .NET SDK 5.0.300 起可用。

  • -d|--diagnostics

    启用诊断输出。 自 .NET SDK 7.0.100 起可用。

  • -?|-h|--help

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

  • --ignore-constraints

    禁用检查模板是否满足要运行的约束。 自 .NET SDK 7.0.100 起可用。

  • -lang|--language {C#|F#|VB}

    根据模板支持的语言筛选模板。 接受的语言因模板而异。 对于某些模板无效。

    注释

    某些 shell 将 # 解释为特殊字符。 在这些情况下,请将语言参数值括在引号中。 例如,dotnet new --list --language "F#"

  • -o|--output <OUTPUT_DIRECTORY>

    用于放置生成的输出的位置。 默认为当前目录。 对于 list 命令,可能需要指定输出目录来正确评估模板的约束。 自 .NET SDK 7.0.100 起可用。

  • --project <PROJECT_PATH>

    模板添加到的项目。 对于 list 命令,可能需要指定模板要添加到的项目,以便正确评估模板的约束。 自 .NET SDK 7.0.100 起可用。

  • --tag <TAG>

    基于模板标记筛选模板。 若要选择,模板必须至少有一个与条件完全匹配的标记。 自 .NET SDK 5.0.300 起可用。

  • --type <TYPE>

    基于模板类型筛选模板。 预定义的值是 projectitemsolution

  • -v|--verbosity <LEVEL>

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

例子

  • 列出所有模板

    dotnet new list
    
  • 列出所有单页应用程序(SPA)模板:

    dotnet new list spa
    
  • 列出与 字符串匹配的所有模板。

    dotnet new list we
    
  • 列出与支持 F# 语言的子 字符串匹配的所有模板。

    dotnet new list we --language "F#"
    
  • 列出所有项模板。

    dotnet new list --type item
    
  • 列出所有 C# 模板,其中显示作者和输出中的类型。

    dotnet new list --language "C#" --columns "author,type"
    

另请参阅