dotnet new list

Artigo
03/20/2023

Este artigo se aplica a: ✔️ SDK do .NET Core 3.1 e versões posteriores

Nome

dotnet new list – Lista os modelos disponíveis a serem executados usando dotnet new.

Sinopse

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]

Descrição

O comando dotnet new list lista os modelos disponíveis para uso com dotnet new. Se <TEMPLATE_NAME> for especificado, listará modelos que contêm o nome especificado. Essa opção lista apenas modelos padrão e instalados. Para localizar modelos no NuGet que você possa instalar localmente, use o comando search.

A partir do SDK do .NET 7.0.100, o comando list pode não mostrar todos os modelos instalados no computador. Ele leva em conta o resultado das restrições de modelo, e os modelos que não podem ser usados não serão mostrados. Para forçar a exibição de todos os modelos, use a opção --ignore-constraints.

Observação

A partir do SDK do .NET 7, a sintaxe dotnet new foi alterada:

As opções --list, --search, --install e --uninstall se tornaram os subcomandos list, search, install e uninstall.
A opção --update-apply se tornou o subcomando update.
Para usar --update-check, use o subcomando update com a opção --check-only.

Outras opções que estavam disponíveis antes ainda estão disponíveis para serem usadas com os respectivos subcomandos. A ajuda separada para cada subcomando está disponível por meio da ou opção -h ou --help: dotnet new <subcommand> --help lista todas as opções com suporte para o subcomando.

Além disso, o preenchimento com Tab agora está disponível para dotnet new. Ele oferece suporte ao preenchimento de nomes de modelo instalados e às opções fornecidas por um modelo selecionado. Para ativar o preenchimento com Tab no SDK do .NET, confira Habilitar o preenchimento com Tab.

Exemplos da sintaxe antiga:

Listar todos os modelos de SPA (aplicativo de página única):
- desde o SDK do .NET 6.0.100
```
dotnet new --list spa
```
- antes do SDK do .NET 6.0.100
```
dotnet new spa --list
```

Argumentos

TEMPLATE_NAME

Se o argumento for especificado, somente os modelos que contêm <TEMPLATE_NAME> no nome do modelo ou no nome curto serão mostrados.

Opções

--author <AUTHOR>

Filtra modelos com base no autor do modelo. É permitida correspondência parcial. Disponível desde o SDK do .NET 5.0.300.
--columns <COLUMNS>

Lista separada por vírgula de colunas a serem exibidas na saída. As colunas com suporte são:
- language – Uma lista separada por vírgula de linguagens compatíveis com o modelo.
- tags – A lista de marcas de modelo.
- author – O autor do modelo.
- type – O tipo de modelo: projeto ou item.
O nome do modelo e o nome curto são sempre mostrados. A lista padrão de colunas é nome do modelo, nome curto, linguagem e marcas. Essa lista equivale a especificar --columns=language,tags. Disponível desde o SDK do .NET 5.0.300.
--columns-all

Exibe todas as colunas na saída. Disponível desde o SDK do .NET 5.0.300.
-d|--diagnostics

Habilita a saída de diagnóstico. Disponível desde o SDK .NET 7.0.100.
-h|--help

Imprime a ajuda para o comando de lista. Disponível desde o SDK .NET 7.0.100.
--ignore-constraints

Desabilita a verificação se o modelo atende às restrições a serem executadas. Disponível desde o SDK .NET 7.0.100.
-lang|--language {C#|F#|VB}

Filtra modelos com base na linguagem compatível com o modelo. A linguagem aceita depende do modelo. Não é válida para alguns modelos.

Observação

Alguns shells interpretam # como um caractere especial. Nesses casos, coloque o valor do parâmetro de idioma entre aspas. Por exemplo, dotnet new --list --language "F#".
-o|--output <OUTPUT_DIRECTORY>

Local para colocar a saída gerada. O padrão é o diretório atual. Para o comando de lista, talvez seja necessário especificar o diretório de saída a fim de avaliar corretamente as restrições do modelo. Disponível desde o SDK .NET 7.0.100.
--project <PROJECT_PATH>

O projeto ao qual o modelo é adicionado. Para o comando de lista, talvez seja necessário especificar o projeto ao qual o modelo está sendo adicionado a fim de avaliar corretamente as restrições do modelo. Disponível desde o SDK .NET 7.0.100.
--tag <TAG>

Filtra modelos com base nas marcas do modelo. Para ser selecionado, um modelo precisa ter pelo menos uma marca que corresponda exatamente aos critérios. Disponível desde o SDK do .NET 5.0.300.
--type <TYPE>

Filtra modelos com base no tipo do modelo. Os valores predefinidos são project, item e solution.
-v|--verbosity <LEVEL>

Define o nível de detalhes do comando. Os valores permitidos são q[uiet], m[inimal], n[ormal] e diag[nostic]. Disponível desde o SDK .NET 7.0.100.

Exemplos

Listar todos os modelos
```
dotnet new list
```
Listar todos os modelos de SPA (aplicativo de página única):
```
dotnet new list spa
```
Liste todos os modelos que correspondem à substring we.
```
dotnet new list we
```
Listar todos os modelos que correspondem à substring we que dão suporte à linguagem F#.
```
dotnet new list we --language "F#"
```
Listar todos os modelos de item.
```
dotnet new list --type item
```
Listar todos os modelos C#, mostrando o autor e o tipo na saída.
```
dotnet new list --language "C#" --columns "author,type"
```