Referência da CLI do NuGet

  • Artigo

A CLI (Interface de Linha de Comando) do NuGet, nuget.exe, fornece toda a extensão da funcionalidade NuGet para instalar, criar, publicar e gerenciar pacotes sem fazer alterações nos arquivos de projeto.

Para usar qualquer comando, abra uma janela de comando ou shell bash e, em seguida, execute nuget, seguido pelo comando e pelas opções apropriadas, como nuget help pack (para exibir a ajuda no comando pack).

Esta documentação reflete a versão mais recente da CLI do NuGet. Para obter detalhes exatos para qualquer versão específica que você está usando, execute nuget help para o comando desejado.

Para saber como usar comandos básicos com a CLI do nuget.exe, confira Instalar e usar pacotes usando a CLI do nuget.exe.

Instalando o nuget.exe

Sempre instale a versão mais recente da ferramenta que seja compatível com a configuração.

  • Você pode baixar a versão mais recente recomendada em https://dist.nuget.org/win-x86-commandline/latest/nuget.exe.
  • Caso já tenha a ferramenta de CLI do nuget.exe instalada, você poderá atualizar para a versão mais recente com o comando nuget update -self.
  • Para fins de compatibilidade com sistemas mais antigos de integração contínua, uma URL anterior, https://nuget.org/nuget.exe atualmente fornece a versão 2.8.6 preterida na ferramenta da CLI.

  1. Visite nuget.org/downloads e faça o download da versão 3.3 ou posterior do NuGet.

    • Versão 5.0 e posterior requer o .NET Framework versão 4.7.2 ou posterior.
    • A versão 4.1.0 e posterior é necessária para publicar pacotes no nuget.org.
    • A versão 2.8.6 não é compatível com o Mono.

  2. Cada download baixa diretamente o arquivo nuget.exe. Programe o browser para salvar o arquivo na pasta de sua escolha. O arquivo de download não é um instalador, então nada ocorrerá se você executá-lo diretamente no browser.

  3. Para usar a ferramenta de CLI de qualquer local, adicione o local da pasta para o arquivo nuget.exe à sua variável de ambiente PATH.

Dica

Para disponibilizar a CLI do NuGet no Console do Gerenciador de Pacotes no Visual Studio, consulte Usar a CLI do nuget.exe no console.

Disponibilidade

Consulte a disponibilidade de recursos para obter detalhes exatos.

  • Todos os comandos estão disponíveis no Windows.
  • Todos os comandos funcionam com nuget.exe em execução no Mono, exceto onde indicado para pack, restore e update.
  • Os comandos pack, restore, delete, locals e push também estão disponíveis no Mac e Linux por meio da CLI do dotnet.

Comandos e aplicabilidade

Comandos disponíveis e aplicabilidade para criação de pacotes, consumo de pacotes e/ou publicação de um pacote em um host:

Comandos Comuns Funções aplicáveis Versão do NuGet Descrição
pack Criação 2.7+ Cria um pacote NuGet a partir de um .nuspec ou um arquivo de projeto. Ao executar no Mono, não há suporte para a criação de um pacote a partir de um arquivo de projeto.
push Publicando Tudo Publica um pacote para uma origem de pacote.
config Tudo Tudo Obtém ou define valores de configuração do NuGet.
help or ? Tudo Tudo Exibe as informações de ajuda ou ajuda para um comando.
locals Consumo 3.3.+ Lista os locais das pastas global-packages, http-cache e temp e limpa o conteúdo dessas pastas.
restaurar Consumo 2.7+ Restaura todos os pacotes referenciados pelo formato de gerenciamento de pacotes em uso. Ao executar no Mono, não há suporte para a restauração de pacotes usando o formato PackageReference.
setapikey Publicação, Consumo Tudo Salva uma chave de API para uma determinada origem de pacote quando essa origem de pacote requer uma chave para acesso.
spec Criação Tudo Gera um arquivo .nuspec, usando tokens se gerar o arquivo de um projeto do Visual Studio.
Comandos secundários Funções aplicáveis Versão do NuGet Descrição
add Publicando 3.3.+ Adiciona um pacote a uma origem de pacote não HTTP usando layout hierárquico. Para fontes HTTP, use push.
excluir Publicando Tudo Remove ou retira um pacote da lista de uma origem de pacote.
init Criação 3.3.+ Adiciona pacotes de uma pasta a uma origem de pacote usando layout hierárquico.
instalar Consumo Tudo Instala um pacote no projeto atual, mas não modifica projetos ou arquivos de referência.
lista Consumo, talvez Publicação Tudo Exibe pacotes de uma determinada origem.
mirror Publicando Preterido em 3.2+ Espelha um pacote e suas dependências de um repositório de origem para um repositório de destino.
search Consumo 5.8+ Pesquisa uma determinada origem usando a cadeia de caracteres de consulta fornecida.
sources Consumo, Publicação Tudo Gerencia fontes de pacotes em arquivos de configuração.
update Consumo Tudo Atualiza os pacotes de um projeto para as últimas versões disponíveis. Não há suporte ao executar no Mono.

Comandos diferentes fazem uso de várias Variáveis de ambiente.

Comandos da CLI do NuGet por funções aplicáveis:

Função Comandos
Consumo config, help, install, list, locals, restore, search, setapikey, sources, update
Criação config, help, init, pack, spec
Publicando add, config, delete, help, list, push, setapikey, sources

Desenvolvedores preocupados apenas com o consumo de pacotes, por exemplo, só precisam entender esse subconjunto de comandos do NuGet.

Observação

Os nomes das opções de comando não diferenciam maiúsculas de minúsculas. As opções preteridas não são incluídas nesta referência, como NoPrompt (substituído por NonInteractive) e Verbose (substituído por Verbosity).

Localização

O progresso, as mensagens de aviso e erro do NuGet.exe são traduzidos para as mesmas localidades que o Visual Studio. NuGet.exe é fornecido como um exe único e, devido a considerações de tamanho, apenas as mensagens mais comumente exibidas são traduzidas em todos os idiomas.