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

Artigo
07/28/2023

Este artigo se aplica ao: ✔️ 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.

Usar a ferramenta como uma ferramenta global

Instale a ferramenta do pacote executando o comando dotnet tool install na pasta do projeto microsoft.botsay:
```
dotnet tool install --global --add-source ./nupkg microsoft.botsay
```
O parâmetro --global 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 parâmetro --add-source 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.
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.
Remova a ferramenta executando o comando dotnet tool uninstall:
```
dotnet tool uninstall -g microsoft.botsay
```

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

Instale a ferramenta por meio do pacote.

No Windows:
```
dotnet tool install --tool-path c:\dotnet-tools --add-source ./nupkg microsoft.botsay
```
No Linux ou no macOS:
```
dotnet tool install --tool-path ~/bin --add-source ./nupkg microsoft.botsay
```
O parâmetro --tool-path informa à CLI do .NET para 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.
```

Invoque a ferramenta:

No Windows:

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

No Linux ou no macOS:

~/bin/botsay hello from the bot

Remova a ferramenta executando o comando dotnet tool uninstall:

No Windows:

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

No Linux ou no macOS:

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

Solucionar problemas

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, confira Como gerenciar ferramentas globais. Para instalar e usar a mesma ferramenta como uma ferramenta local, avance para o próximo tutorial.

Instalar e usar ferramentas locais