Zelfstudie: Een lokaal .NET-hulpprogramma installeren en gebruiken met behulp van de .NET CLI

Artikel
04/08/2023

Dit artikel is van toepassing op: ✔️ .NET Core 3.0 SDK en latere versies

In deze zelfstudie leert u hoe u een lokaal hulpprogramma installeert en gebruikt. U gebruikt een hulpprogramma dat u in de eerste zelfstudie van deze reeks hebt gemaakt.

Vereisten

Voltooi de eerste zelfstudie van deze reeks.
Installeer de .NET Core 2.1-runtime.

Voor deze zelfstudie installeert en gebruikt u een hulpprogramma dat is gericht op .NET Core 2.1, dus u moet die runtime op uw computer hebben geïnstalleerd. Als u runtime 2.1 wilt installeren, gaat u naar de downloadpagina van .NET Core 2.1 en zoekt u de runtime-installatiekoppeling in de kolom Apps uitvoeren - Runtime .

Een manifestbestand maken

Als u alleen een hulpprogramma voor lokale toegang wilt installeren (voor de huidige map en submappen), moet het worden toegevoegd aan een manifestbestand.

Navigeer vanuit de map microsoft.botsay één niveau omhoog naar de opslagplaatsmap :

cd ..

Maak een manifestbestand door de opdracht dotnet new uit te voeren:

dotnet new tool-manifest

De uitvoer geeft aan dat het bestand is gemaakt.

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

Het .configbestand /dotnet-tools.json bevat nog geen hulpprogramma's:

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

De hulpprogramma's die in een manifestbestand worden vermeld, zijn beschikbaar voor de huidige map en submappen. De huidige map is de map die de .config map met het manifestbestand bevat.

Wanneer u een CLI-opdracht gebruikt die verwijst naar een lokaal hulpprogramma, zoekt de SDK naar een manifestbestand in de huidige map en bovenliggende mappen. Als er een manifestbestand wordt gevonden, maar het bestand het hulpprogramma waarnaar wordt verwezen niet bevat, wordt de zoekopdracht voortgezet via bovenliggende mappen. De zoekopdracht eindigt wanneer het hulpprogramma waarnaar wordt verwezen, wordt gevonden of er wordt een manifestbestand gevonden dat isRoot is ingesteld op true.

Botsay installeren als een lokaal hulpprogramma

Installeer het hulpprogramma vanuit het pakket dat u in de eerste zelfstudie hebt gemaakt:

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

Met deze opdracht wordt het hulpprogramma toegevoegd aan het manifestbestand dat u in de vorige stap hebt gemaakt. In de uitvoer van de opdracht ziet u in welk manifestbestand het zojuist geïnstalleerde hulpprogramma zich bevindt:

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

Het .configbestand /dotnet-tools.json heeft nu één hulpprogramma:

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "microsoft.botsay": {
      "version": "1.0.0",
      "commands": [
        "botsay"
      ]
    }
  }
}

Het hulpprogramma gebruiken

Roep het hulpprogramma aan door de dotnet tool run opdracht uit te voeren vanuit de opslagplaatsmap :

dotnet tool run botsay hello from the bot

Een lokaal hulpprogramma herstellen dat door anderen is geïnstalleerd

Normaal gesproken installeert u een lokaal hulpprogramma in de hoofdmap van de opslagplaats. Nadat u het manifestbestand bij de opslagplaats hebt ingecheckt, kunnen andere ontwikkelaars het meest recente manifestbestand ophalen. Als u alle hulpprogramma's in het manifestbestand wilt installeren, kunnen ze één dotnet tool restore opdracht uitvoeren.

Open de .configbestand /dotnet-tools.json en vervang de inhoud door de volgende JSON:

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "microsoft.botsay": {
      "version": "1.0.0",
      "commands": [
        "botsay"
      ]
    },
    "dotnetsay": {
      "version": "2.1.3",
      "commands": [
        "dotnetsay"
      ]
    }
  }
}

Sla uw wijzigingen op.

Het aanbrengen van deze wijziging is hetzelfde als het ophalen van de meest recente versie uit de opslagplaats nadat iemand anders het pakket dotnetsay voor de projectmap heeft geïnstalleerd.

Voer de opdracht dotnet tool restore uit.

dotnet tool restore

De opdracht produceert uitvoer zoals in het volgende voorbeeld:

Tool 'microsoft.botsay' (version '1.0.0') was restored. Available commands: botsay
Tool 'dotnetsay' (version '2.1.3') was restored. Available commands: dotnetsay
Restore was successful.

Controleer of de hulpprogramma's beschikbaar zijn:

dotnet tool list

De uitvoer is een lijst met pakketten en opdrachten, vergelijkbaar met het volgende voorbeeld:

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

Test de hulpprogramma's:

dotnet tool run dotnetsay hello from dotnetsay
dotnet tool run botsay hello from botsay

Een lokaal hulpprogramma bijwerken

De geïnstalleerde versie van het lokale hulpprogramma dotnetsay is 2.1.3. Gebruik de opdracht dotnet tool update om het hulpprogramma bij te werken naar de nieuwste versie.

dotnet tool update dotnetsay

De uitvoer geeft het nieuwe versienummer aan:

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

Met de opdracht bijwerken wordt het eerste manifestbestand met de pakket-id gevonden en bijgewerkt. Als er geen dergelijke pakket-id aanwezig is in een manifestbestand dat binnen het bereik van de zoekopdracht valt, voegt de SDK een nieuwe vermelding toe aan het dichtstbijzijnde manifestbestand. Het zoekbereik is up via bovenliggende mappen totdat een manifestbestand met isRoot = true is gevonden.

Lokale hulpprogramma's verwijderen

Verwijder de geïnstalleerde hulpprogramma's door de opdracht dotnet tool uninstall uit te voeren:

dotnet tool uninstall microsoft.botsay

dotnet tool uninstall dotnetsay

Problemen oplossen

Als u een foutbericht krijgt tijdens het volgen van de zelfstudie, raadpleegt u Problemen met het gebruik van .NET-hulpprogramma's oplossen.

Zie ook

Zie .NET-hulpprogramma's voor meer informatie