Tutorial: Instalar e usar uma ferramenta global do .NET usando a CLI do .NET

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

Este tutorial ensina como instalar e usar uma ferramenta global. Você usa uma ferramenta criada no primeiro tutorial desta série.

Pré-requisitos

• Conclua o primeiro tutorial desta série.
• SDK do .NET 10.0.100 ou posterior (para dnx) – opcional, mas recomendado.

Executar a ferramenta sem instalação (recomendado)

A partir do .NET 10.0.100, você pode executar ferramentas do .NET sem instalação permanente usando dnx:

1. Execute a ferramenta diretamente usando a dnx (sintaxe simplificada):

   dnx microsoft.botsay --add-source ./nupkg microsoft.botsay hello from the bot
   

   O --add-source parâmetro informa à CLI do .NET para usar o diretório ./nupkg como um feed de origem adicional para pacotes NuGet quando a ferramenta não estiver disponível no NuGet.org.

Usar a ferramenta como uma ferramenta global (instalação tradicional)

Se você preferir a instalação permanente para uso frequente:

1. Instale a ferramenta do pacote executando o comando de instalação da ferramenta dotnet na pasta do projeto microsoft.botsay :

   dotnet tool install --global --add-source ./nupkg microsoft.botsay
   

   O --global parâmetro informa à CLI do .NET para instalar os binários da ferramenta em um local padrão que é adicionado automaticamente à variável de ambiente PATH.

   O --add-source parâmetro informa à CLI do .NET para usar temporariamente o diretório ./nupkg como um feed de origem adicional para pacotes NuGet. Você deu ao seu pacote um nome exclusivo para garantir que ele só será encontrado no diretório ./nupkg , não no site Nuget.org.

   A saída mostra o comando usado para chamar a ferramenta e a versão instalada:

   You can invoke the tool using the following command: botsay
   Tool 'microsoft.botsay' (version '1.0.0') was successfully installed.
   

   Observação

   Por padrão, a arquitetura dos binários do .NET a serem instalados representa a arquitetura do SO sendo executado no momento. Para especificar uma arquitetura de SO diferente, consulte instalação da ferramenta dotnet, opção --arch.

2. Invoque a ferramenta:

   botsay hello from the bot
   

   Observação

   Se esse comando falhar, talvez seja necessário abrir um novo terminal para atualizar o PATH.

3. Remova a ferramenta executando o comando de desinstalação da ferramenta dotnet :

   dotnet tool uninstall -g microsoft.botsay
   

Usar a ferramenta como uma ferramenta global instalada em um local personalizado

1. Instale a ferramenta do pacote.

   No Windows:

   dotnet tool install --tool-path c:\dotnet-tools --add-source ./nupkg microsoft.botsay
   

   No Linux ou macOS:

   dotnet tool install --tool-path ~/bin --add-source ./nupkg microsoft.botsay
   

   O parâmetro --tool-path instrui a CLI do .NET a instalar os binários da ferramenta no local especificado. Se o diretório não existir, ele será criado. Esse diretório não é adicionado automaticamente à variável de ambiente PATH.

   A saída mostra o comando usado para chamar a ferramenta e a versão instalada:

   You can invoke the tool using the following command: botsay
   Tool 'microsoft.botsay' (version '1.0.0') was successfully installed.
   

2. Invoque a ferramenta:

   No Windows:

   c:\dotnet-tools\botsay hello from the bot
   

   No Linux ou macOS:

   ~/bin/botsay hello from the bot
   

3. Remova a ferramenta executando o comando de desinstalação da ferramenta dotnet :

   No Windows:

   dotnet tool uninstall --tool-path c:\dotnet-tools microsoft.botsay
   

   No Linux ou macOS:

   dotnet tool uninstall --tool-path ~/bin microsoft.botsay
   

Troubleshoot

Se você receber uma mensagem de erro ao seguir o tutorial, confira Solucionar problemas de uso da ferramenta .NET.

Próximas etapas

Neste tutorial, você instalou e usou uma ferramenta como uma ferramenta global. Para obter mais informações sobre como instalar e usar ferramentas globais, consulte Gerenciando ferramentas globais. Para instalar e usar a mesma ferramenta que uma ferramenta local, avance para o próximo tutorial.