Tutorial: Instalación y uso de una herramienta global de .NET mediante la CLI de .NET

Este artículo se aplica a: ✔️ SDK de .NET Core 2.1 y versiones posteriores

En este tutorial se enseña cómo instalar y usar una herramienta global. Usará una herramienta que ha creado en el primer tutorial de esta serie.

Requisitos previos

Uso de la herramienta como una herramienta global

  1. Instale la herramienta desde el paquete; para ello, ejecute el comando dotnet tool install en la carpeta del proyecto microsoft.botsay:

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

    El parámetro --global indica a la CLI de .NET que instale los archivos binarios de la herramienta en una ubicación predeterminada que se agrega de forma automática a la variable de entorno PATH.

    El parámetro --add-source indica a la CLI de .NET que use temporalmente el directorio ./nupkg como una fuente de origen adicional para los paquetes NuGet. Ha asignado un nombre único al paquete para asegurarse de que solo se encontrará en el directorio ./nupkg, no en el sitio de Nuget.org.

    En la salida se muestra el comando que se ha usado para llamar a la herramienta y la versión instalada:

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

    Nota

    De manera predeterminada, la arquitectura de los binarios .NET que se van a instalar representa la arquitectura del sistema operativo que se está ejecutando en ese momento. Para especificar una arquitectura de SO diferente, consulte dotnet tool install, --arch option.

  2. Invoque la herramienta:

    botsay hello from the bot
    

    Nota:

    Si se produce un error en este comando, es posible que tenga que abrir un nuevo terminal para actualizar el valor de PATH.

  3. Ejecute el comando dotnet tool uninstall para quitar la herramienta:

    dotnet tool uninstall -g microsoft.botsay
    

Uso de la herramienta como una herramienta global instalada en una ubicación personalizada

  1. Instale la herramienta desde el paquete.

    En Windows:

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

    En Linux o macOS:

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

    El parámetro --tool-path indica a la CLI de .NET que instale los archivos binarios de la herramienta en la ubicación especificada. Si el directorio no existe, se crea. Este directorio no se agrega automáticamente a la variable de entorno PATH.

    En la salida se muestra el comando que se ha usado para llamar a la herramienta y la versión instalada:

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

    En Windows:

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

    En Linux o macOS:

    ~/bin/botsay hello from the bot
    
  3. Ejecute el comando dotnet tool uninstall para quitar la herramienta:

    En Windows:

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

    En Linux o macOS:

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

Solucionar problemas

Si recibe un mensaje de error al seguir el tutorial, vea Solución de problemas de uso de herramientas de .NET Core.

Pasos siguientes

En este tutorial, ha instalado y usado una herramienta como una herramienta global. Para obtener más información sobre cómo instalar y usar herramientas globales, consulte el documento sobre administración de herramientas globales. Para instalar y usar la misma herramienta como una herramienta local, vaya al siguiente tutorial.