Lernprogramm: Installieren und Verwenden eines globalen .NET-Tools mithilfe der .NET CLI

Dieser Artikel gilt für: ✔️ .NET 8 SDK und höhere Versionen

In diesem Lernprogramm erfahren Sie, wie Sie ein globales Tool installieren und verwenden. Das verwendete Tool ist das Tool, das Sie im ersten Lernprogramm dieser Reihe erstellen.

Voraussetzungen

Ab .NET 10.0.100 können Sie .NET-Tools ohne dauerhafte Installation ausführen:dnx

  1. Führen Sie das Tool direkt mit dnx (vereinfachte Syntax) aus:

    dnx dotnet-env --add-source ./nupkg
    

    Der Parameter --add-source weist die .NET CLI an, das Verzeichnis ./nupkg als zusätzlichen Quellfeed für NuGet-Pakete zu verwenden, wenn das Tool für NuGet.org nicht verfügbar ist.

Verwenden des Tools als globales Tool (herkömmliche Installation)

Wenn Sie die dauerhafte Installation für häufig verwendete Zwecke bevorzugen:

  1. Installieren Sie das Tool aus dem Paket, indem Sie den Befehl "dotnet-tool install " im Projektordner "dotnet-env " ausführen:

    dotnet tool install --global --add-source ./nupkg dotnet-env
    

    Der Parameter --global weist die .NET CLI an, die Binärdateien des Tools an einem Standardspeicherort zu installieren, der der Umgebungsvariablen PATH automatisch hinzugefügt wird.

    Der --add-source Parameter weist die .NET CLI an, das Verzeichnis ./nupkg vorübergehend als zusätzlichen Quellfeed für NuGet-Pakete zu verwenden. Sie haben Ihrem Paket einen eindeutigen Namen gegeben, um sicherzustellen, dass es nur im Verzeichnis ./nupkg gefunden wird, nicht auf NuGet.org.

    Die Ausgabe zeigt den Befehl an, der zum Aufrufen des Tools und der installierten Version verwendet wird:

    You can invoke the tool using the following command: dotnet-env
    Tool 'dotnet-env' (version '1.0.0') was successfully installed.
    

    Hinweis

    Standardmäßig stellt die Architektur der zu installierenden .NET-Binärdateien die derzeit ausgeführte Betriebssystemarchitektur dar. Informationen zum Angeben einer anderen Betriebssystemarchitektur finden Sie unter dotnet tool install, --arch option.

  2. Aufrufen des Tools:

    dotnet-env
    

    Hinweis

    Wenn der Befehl fehlschlägt, öffnen Sie ein neues Terminal, um die PATH Umgebungsvariable zu aktualisieren.

  3. Entfernen Sie das Tool, indem Sie den Deinstallationsbefehl des dotnet-Tools ausführen:

    dotnet tool uninstall -g dotnet-env
    

Verwenden Sie das Werkzeug als ein globales Werkzeug, das an einem benutzerdefinierten Installationsort installiert ist

  1. Installieren Sie das Tool aus dem Paket.

    Unter Windows:

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

    Unter Linux oder macOS:

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

    Der --tool-path Parameter weist die .NET CLI an, die Binärdateien des Tools an dem angegebenen Speicherort zu installieren. Wenn das Verzeichnis nicht vorhanden ist, wird es erstellt. Das Verzeichnis wird der Umgebungsvariablen nicht automatisch hinzugefügt PATH .

    Die Ausgabe zeigt den Befehl an, der zum Aufrufen des Tools und der installierten Version verwendet wird:

    You can invoke the tool using the following command: dotnet-env
    Tool 'dotnet-env' (version '1.0.0') was successfully installed.
    
  2. Aufrufen des Tools:

    Unter Windows:

    c:\dotnet-tools\dotnet-env
    

    Unter Linux oder macOS:

    ~/bin/dotnet-env
    
  3. Entfernen Sie das Tool, indem Sie den Deinstallationsbefehl des dotnet-Tools ausführen:

    Unter Windows:

    dotnet tool uninstall --tool-path c:\dotnet-tools dotnet-env
    

    Unter Linux oder macOS:

    dotnet tool uninstall --tool-path ~/bin dotnet-env
    

Troubleshoot

Wenn beim Folgen des Lernprogramms eine Fehlermeldung angezeigt wird, lesen Sie die Problembehandlung bei der Verwendung von .NET-Tools.

Nächste Schritte

In diesem Lernprogramm haben Sie ein Tool als globales Tool installiert und verwendet. Weitere Informationen zum Installieren und Verwenden globaler Tools finden Sie unter Verwalten globaler Tools. Um dasselbe Tool wie ein lokales Tool zu installieren und zu verwenden, wechseln Sie zum nächsten Lernprogramm.