Delen via

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

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. Je gebruikt een tool die je hebt gemaakt in de eerste tutorial van deze serie.

Voorwaarden

  • Voltooi de eerste tutorial van deze reeks.

  • Installeer de .NET Core 2.1-runtime.

  • .NET 10.0.100 SDK of hoger (voor dnx) - optioneel, maar aanbevolen.

    Voor deze zelfstudie installeert en gebruikt u een hulpprogramma dat is gericht op .NET Core 2.1, dus moet die runtime op uw computer zijn geïnstalleerd. Als u de 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 in de map microsoft.botsay één niveau omhoog naar de opslagplaats map:

cd ..

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

dotnet new tool-manifest

De uitvoer geeft aan dat het bestand succesvol is aangemaakt.

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

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

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

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

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 met isRoot ingesteld op true.

Botsay installeren als een lokaal hulpprogramma (traditionele benadering)

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 bestand .config/dotnet-tools.json heeft nu één hulpprogramma:

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

Het geïnstalleerde lokale hulpprogramma gebruiken

Zodra deze is geïnstalleerd als een lokaal hulpprogramma, kunt u het op meerdere manieren aanroepen:

  • Voer het hulpprogramma rechtstreeks uit met behulp van dnx:

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

    Opmerking

    Wanneer u dnx gebruikt met een lokaal hulpprogrammamanifest, wordt automatisch de versie gebruikt die is opgegeven in het manifest.

  • Met behulp van dotnet botsay:

    dotnet botsay hello from the bot

  • dotnet tool run gebruiken

    dotnet tool run botsay hello from the bot

Een lokaal hulpprogramma herstellen dat door anderen is geïnstalleerd

Doorgaans installeert u een lokaal hulpprogramma in de hoofdmap van de opslagplaats. Nadat u het manifestbestand naar 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.

  1. Open het bestand .config/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"
      ]
    }
  }
}

  2. 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.

  3. 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.

  4. 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

  5. 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 dotnet-hulpprogramma-update opdracht 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 updateopdracht wordt het eerste manifestbestand gevonden dat de pakket-id bevat en wordt het 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 omhoog via bovenliggende mappen totdat er 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

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'svoor meer informatie.

  • Last updated on