dotnet new list

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

名称

dotnet new --list - 列出要使用 dotnet new 运行的可用模板。

摘要

dotnet new [<TEMPLATE_NAME>] -l|--list [--author <AUTHOR>] [-lang|--language {"C#"|"F#"|VB}]
    [--tag <TAG>] [--type <TYPE>] [--columns <COLUMNS>] [--columns-all]

说明

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

注意

从 .NET SDK 7.0.100 预览版 2 开始,语法 dotnet new 已更改:

  • --list、、--search--install选项--uninstalluninstall子命令变为listsearchinstall和子命令。
  • --update-apply 选项成为 update 子命令。
  • 若要使用 --update-check,请使用 update 子命令和 --check 选项。

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

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

新语法的示例:

  • 显示子命令的 list 帮助

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

    dotnet new list we --language "F#"
    

自变量

  • TEMPLATE_NAME

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

    注意

    从 .NET SDK 6.0.100 开始,可以将 <TEMPLATE_NAME> 参数放在 --list 选项后面。 例如,dotnet new --list webdotnet new web --list 的结果相同。 不允许使用多个参数。

选项

  • --author <AUTHOR>

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

  • --columns <COLUMNS>

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

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

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

  • --columns-all

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

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

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

    注意

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

  • --tag <TAG>

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

  • --type <TYPE>

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

示例

  • 列出所有模板

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

    • 自 .NET SDK 6.0.100 起
    dotnet new --list spa
    
    • .NET SDK 6.0.100 之前
    dotnet new spa --list
    
  • 列出与“we”子字符串匹配的所有模板。

    • 自 .NET SDK 6.0.100 起
    dotnet new --list we
    
    • .NET SDK 6.0.100 之前
    dotnet new we --list
    
  • 列出与支持 F# 语言的“we”子字符串匹配的所有模板。

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

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

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

另请参阅