dotnet new list

  • 项目

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

名称

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]

说明

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 选项已变更为 list、search、install 和 uninstall 子命令。
  • --update-apply 选项变更为 update 子命令。
  • 若要使用 --update-check，请使用包含 --check-only 选项的 update 子命令。

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

此外，tab 自动补全现可供 dotnet new 使用。 它支持安装模板名称的自动补全，以及所选模板所提供选项的自动补全。 若要激活 .NET SDK 的 tab 自动补全，请参阅启用 tab 自动补全。

旧语法的示例：

  • 列出单页应用程序 (SPA) 模板：

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

自变量

  • 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

    打印 list 命令帮助。 自 .NET SDK 7.0.100 之后可用。

  • --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>

    基于模板类型筛选模板。 预定义的值为 project、item 和 solution。

  • -v|--verbosity <LEVEL>

    设置命令的详细级别。 允许的值为 q[uiet]、m[inimal]、n[ormal] 和 diag[nostic]。 自 .NET SDK 7.0.100 之后可用。

示例

  • 列出所有模板

    dotnet new list

  • 列出单页应用程序 (SPA) 模板：

    dotnet new list spa

  • 列出与“we”子字符串匹配的所有模板。

    dotnet new list we

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

    dotnet new list we --language "F#"

  • 列出所有项模板。

    dotnet new list --type item

  • 列出所有 C# 模板，从而在输出中显示作者和类型。

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

另请参阅