共用方式為

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，請搭配使用 update 子命令和 --check-only 選項。

先前版本中可用的其他選項仍可與各自的子命令搭配使用。 如需每項子命令的個別說明，可透過 -h 或 --help 選項取得：dotnet new <subcommand> --help 會列出子命令的所有支援選項。

此外，dotnet new 現可使用 TAB 鍵自動完成。 這項功能支援完成已安裝範本的名稱，以及所選範本提供的選項。 若要為 .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}

    根據範本所支援的語言篩選範本。 接受的語言會依範本而有所差異。 並非所有範本都適用。

    注意

    某些殼層會將 # 解譯為特殊字元。 在這些情況下，請用引號括住語言參數值。 例如： 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

  • 列出與 we 子字串相符且支援 F# 語言的所有範本。

    dotnet new list we --language "F#"

  • 列出所有項目範本。

    dotnet new list --type item

  • 列出所有 C# 範本，並在輸出中顯示作者和類型。

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

另請參閱