Tutoriel : Installer et utiliser un outil global .NET à l’aide de l’interface CLI .NET

Cet article s’applique au ✔️ Kit de développement logiciel (SDK) .NET Core 2.1 et versions ultérieures

Ce tutoriel vous apprend à installer et à utiliser un outil global. Vous utilisez un outil que vous créez dans le premier tutoriel de cette série.

Prerequisites

• Suivez le premier tutoriel de cette série.
• Sdk .NET 10.0.100 ou version ultérieure (pour dnx) - facultatif mais recommandé.

Exécuter l’outil sans installation (recommandé)

À compter de .NET 10.0.100, vous pouvez exécuter des outils .NET sans installation permanente à l’aide dnxde :

1. Exécutez l’outil directement à l’aide de dnx (syntaxe simplifiée) :

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

   Le --add-source paramètre indique à l’interface CLI .NET d’utiliser le répertoire ./nupkg comme flux source supplémentaire pour les packages NuGet lorsque l’outil n’est pas disponible sur NuGet.org.

Utiliser l’outil comme outil global (installation traditionnelle)

Si vous préférez une installation permanente pour une utilisation fréquente :

1. Installez l’outil à partir du package en exécutant la commande dotnet tool install dans le dossier du projet microsoft.botsay :

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

   Le --global paramètre indique à l’interface CLI .NET d’installer les fichiers binaires d’outils dans un emplacement par défaut qui est automatiquement ajouté à la variable d’environnement PATH.

   Le --add-source paramètre indique à l’interface CLI .NET d’utiliser temporairement le répertoire ./nupkg comme flux source supplémentaire pour les packages NuGet. Vous avez donné à votre package un nom unique pour vous assurer qu’il se trouve uniquement dans le répertoire ./nupkg , et non sur le site Nuget.org.

   La sortie affiche la commande utilisée pour appeler l’outil et la version installée :

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

   Note

   Par défaut, l’architecture des fichiers binaires .NET à installer représente l’architecture du système d’exploitation en cours d’exécution. Pour spécifier une architecture de système d’exploitation différente, consultez dotnet tool install, --arch option.

2. Appelez l’outil :

   botsay hello from the bot
   

   Note

   Si cette commande échoue, vous devrez peut-être ouvrir un nouveau terminal pour actualiser le chemin d’accès.

3. Supprimez l’outil en exécutant la commande dotnet tool uninstall :

   dotnet tool uninstall -g microsoft.botsay
   

Utiliser l’outil comme outil global installé dans un emplacement personnalisé

1. Installez l’outil à partir du package.

   Sur Windows :

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

   Sur Linux ou macOS :

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

   Le --tool-path paramètre indique à l’interface CLI .NET d’installer les fichiers binaires d’outils à l’emplacement spécifié. Si le répertoire n’existe pas, il est créé. Ce répertoire n’est pas automatiquement ajouté à la variable d’environnement PATH.

   La sortie affiche la commande utilisée pour appeler l’outil et la version installée :

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

2. Appelez l’outil :

   Sur Windows :

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

   Sur Linux ou macOS :

   ~/bin/botsay hello from the bot
   

3. Supprimez l’outil en exécutant la commande dotnet tool uninstall :

   Sur Windows :

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

   Sur Linux ou macOS :

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

Troubleshoot

Si vous recevez un message d’erreur en suivant le tutoriel, consultez Résoudre les problèmes d’utilisation de l’outil .NET.

Étapes suivantes

Dans ce tutoriel, vous avez installé et utilisé un outil comme outil global. Pour plus d’informations sur l’installation et l’utilisation des outils globaux, consultez Gestion des outils globaux. Pour installer et utiliser le même outil qu’un outil local, passez au didacticiel suivant.

Installer et utiliser des outils locaux