Lernprogramm: Installieren und Verwenden eines lokalen .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 lokales Tool installieren und verwenden. Sie verwenden ein Tool, das Sie im ersten Lernprogramm dieser Reihe erstellen.

Voraussetzungen

So erstellen Sie eine Manifestdatei

Um ein Tool nur für den lokalen Zugriff (für das aktuelle Verzeichnis und unterverzeichnisse) zu installieren, muss es einer Manifestdatei hinzugefügt werden.

Navigieren Sie aus dem Ordner "dotnet-env" eine Ebene nach oben zum Repository-Ordner.

cd ..

Erstellen Sie eine Manifestdatei, indem Sie den neuen Befehl dotnet ausführen:

dotnet new tool-manifest

Die Ausgabe gibt die erfolgreiche Erstellung der Datei an.

The template "Dotnet local tool manifest file" was created successfully.

Die Datei.config/dotnet-tools.json enthält noch keine Tools:

{
  "version": 1,
  "isRoot": true,
  "tools": {}
}

Die in einer Manifestdatei aufgeführten Tools sind für das aktuelle Verzeichnis und die Unterverzeichnisse verfügbar. Das aktuelle Verzeichnis ist das Verzeichnis, das das .config Verzeichnis mit der Manifestdatei enthält.

Wenn Sie einen CLI-Befehl verwenden, der auf ein lokales Tool verweist, sucht das SDK nach einer Manifestdatei im aktuellen Verzeichnis und übergeordneten Verzeichnissen. Wenn sie eine Manifestdatei findet, aber die Datei nicht das referenzierte Tool enthält, wird die Suche durch übergeordnete Verzeichnisse fortgesetzt. Die Suche endet, wenn das referenzierte Tool oder eine Manifestdatei gefunden wird, bei der isRoot auf true festgelegt ist.

Installieren von dotnet-env als lokales Tool (herkömmlicher Ansatz)

Installieren Sie das Tool aus dem Paket, das Sie im ersten Lernprogramm erstellt haben:

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

Mit diesem Befehl wird das Tool der Manifestdatei hinzugefügt, die Sie im vorherigen Schritt erstellt haben. Die Befehlsausgabe zeigt an, in welcher Manifestdatei sich das neu installierte Tool befindet:

You can invoke the tool from this directory using the following command:
'dotnet tool run dotnet-env' or 'dotnet dotnet-env'
Tool 'dotnet-env' (version '1.0.0') was successfully installed.
Entry is added to the manifest file /home/name/repository/.config/dotnet-tools.json

Die Datei.config/dotnet-tools.json verfügt jetzt über ein Tool:

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "dotnet-env": {
      "version": "1.0.0",
      "commands": [
        "dotnet-env"
      ]
    }
  }
}

Verwenden des installierten lokalen Tools

Nach der Installation als lokales Tool können Sie es auf mehrere Arten aufrufen:

  • Führen Sie das Tool direkt mit dnx:

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

    Hinweis

    Wenn dnx mit einem lokalen Toolmanifest verwendet wird, wird automatisch die im Manifest angegebene Version verwendet.

  • Verwendung von dotnet dotnet-env:

    dotnet dotnet-env

  • Verwenden von dotnet tool run

    dotnet tool run dotnet-env

Wiederherstellen eines lokalen Tools, das von anderen Benutzern installiert wurde

In der Regel installieren Sie ein lokales Tool im Stammverzeichnis des Repositorys. Nachdem Sie die Manifestdatei im Repository eingecheckt haben, können andere Entwickler die neueste Manifestdatei abrufen. Um alle in der Manifestdatei aufgeführten Tools zu installieren, können sie einen einzelnen dotnet tool restore Befehl ausführen.

  1. Öffnen Sie die Datei.config/dotnet-tools.json , und ersetzen Sie den Inhalt durch den folgenden JSON-Code:

    {
  "version": 1,
  "isRoot": true,
  "tools": {
    "dotnet-env": {
      "version": "1.0.0",
      "commands": [
        "dotnet-env"
      ]
    },
    "dotnetsay": {
      "version": "2.1.3",
      "commands": [
        "dotnetsay"
      ]
    }
  }
}

  2. Speichern Sie Ihre Änderungen.

    Diese Änderung vorzunehmen ist identisch mit dem Abrufen der neuesten Version aus dem Repository, nachdem jemand anderes das Paket dotnetsay für das Projektverzeichnis installiert hat.

  3. Führen Sie den Befehl dotnet tool restore aus.

    dotnet tool restore

    Der Befehl erzeugt eine Ausgabe wie im folgenden Beispiel:

    Tool 'dotnet-env' (version '1.0.0') was restored. Available commands: dotnet-env
Tool 'dotnetsay' (version '2.1.3') was restored. Available commands: dotnetsay
Restore was successful.

  4. Überprüfen Sie, ob die Tools verfügbar sind:

    dotnet tool list

    Die Ausgabe ist eine Liste von Paketen und Befehlen, ähnlich dem folgenden Beispiel:

    Package Id         Version      Commands       Manifest
--------------------------------------------------------------------------------------------
dotnet-env         1.0.0        dotnet-env     /home/name/repository/.config/dotnet-tools.json
dotnetsay          2.1.3        dotnetsay      /home/name/repository/.config/dotnet-tools.json

  5. Testen Sie die Tools:

    dotnet tool run dotnetsay hello from dotnetsay
dotnet tool run dotnet-env

Aktualisieren eines lokalen Tools

Die installierte Version des lokalen Tools dotnetsay ist 2.1.3. Verwenden Sie den Befehl zum Aktualisieren des Dotnet-Tools , um das Tool auf die neueste Version zu aktualisieren.

dotnet tool update dotnetsay

Die Ausgabe gibt die neue Versionsnummer an:

Tool 'dotnetsay' was successfully updated from version '2.1.3' to version '3.0.3'
(manifest file /home/name/repository/.config/dotnet-tools.json).

Der Updatebefehl findet die erste Manifestdatei, die die Paket-ID enthält, und aktualisiert sie. Wenn keine solche Paket-ID in einer Manifestdatei vorhanden ist, die sich im Suchbereich befindet, fügt das SDK der nächstgelegenen Manifestdatei einen neuen Eintrag hinzu. Der Suchbereich erstreckt sich durch übergeordnete Verzeichnisse, bis eine Manifestdatei mit isRoot = true gefunden wird.

Entfernen lokaler Tools

Entfernen Sie die installierten Tools, indem Sie den Befehl zum Deinstallieren des dotnet-Tools ausführen:

dotnet tool uninstall dotnet-env

dotnet tool uninstall dotnetsay

Troubleshoot

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

Siehe auch

Weitere Informationen finden Sie unter .NET-Tools.

  • Last updated on