Självstudie: Installera och använda ett lokalt .NET-verktyg med hjälp av .NET CLI

Artikel
04/08/2023

Den här artikeln gäller för: ✔️ .NET Core 3.0 SDK och senare versioner

I den här självstudien lär du dig hur du installerar och använder ett lokalt verktyg. Du använder ett verktyg som du skapar i den första självstudien i den här serien.

Krav

Slutför den första självstudien i den här serien.
Installera .NET Core 2.1-körningen.

I den här självstudien installerar och använder du ett verktyg som är avsett för .NET Core 2.1, så du måste ha den körningen installerad på datorn. Om du vill installera 2.1-körningen går du till nedladdningssidan för .NET Core 2.1 och hittar installationslänken för körning i kolumnen Kör appar – Körning .

Skapa en manifestfil

Om du bara vill installera ett verktyg för lokal åtkomst (för den aktuella katalogen och underkatalogerna) måste det läggas till i en manifestfil.

Från mappen microsoft.botsay navigerar du upp en nivå till lagringsplatsens mapp:

cd ..

Skapa en manifestfil genom att köra det nya dotnet-kommandot :

dotnet new tool-manifest

Utdata anger att filen har skapats.

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

Filen .config/dotnet-tools.json har ännu inga verktyg:

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

Verktygen som anges i en manifestfil är tillgängliga för den aktuella katalogen och underkatalogerna. Den aktuella katalogen är den som innehåller .config-katalogen med manifestfilen.

När du använder ett CLI-kommando som refererar till ett lokalt verktyg söker SDK efter en manifestfil i den aktuella katalogen och överordnade kataloger. Om den hittar en manifestfil, men filen inte innehåller det refererade verktyget, fortsätter sökningen genom överordnade kataloger. Sökningen avslutas när det refererade verktyget hittas eller en manifestfil med isRoot värdet true.

Installera botsay som ett lokalt verktyg

Installera verktyget från paketet som du skapade i den första självstudien:

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

Det här kommandot lägger till verktyget i manifestfilen som du skapade i föregående steg. Kommandoutdata visar vilken manifestfil som det nyligen installerade verktyget finns i:

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

Filen .config/dotnet-tools.json har nu ett verktyg:

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

Använda verktyget

Anropa verktyget genom att dotnet tool run köra kommandot från lagringsplatsens mapp:

dotnet tool run botsay hello from the bot

Återställa ett lokalt verktyg som installerats av andra

Du installerar vanligtvis ett lokalt verktyg i rotkatalogen på lagringsplatsen. När du checkar in manifestfilen på lagringsplatsen kan andra utvecklare hämta den senaste manifestfilen. Om du vill installera alla verktyg som visas i manifestfilen kan de köra ett enda dotnet tool restore kommando.

Öppna filen .config/dotnet-tools.json och ersätt innehållet med följande JSON:

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

Spara ändringarna.

Att göra den här ändringen är detsamma som att hämta den senaste versionen från lagringsplatsen när någon annan har installerat paketet dotnetsay för projektkatalogen.

Kör kommandot dotnet tool restore.

dotnet tool restore

Kommandot genererar utdata som i följande exempel:

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.

Kontrollera att verktygen är tillgängliga:

dotnet tool list

Utdata är en lista över paket och kommandon, ungefär som i följande exempel:

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

Testa verktygen:

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

Uppdatera ett lokalt verktyg

Den installerade versionen av det lokala verktyget dotnetsay är 2.1.3. Använd kommandot dotnet tool update för att uppdatera verktyget till den senaste versionen.

dotnet tool update dotnetsay

Utdata anger det nya versionsnumret:

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

Uppdateringskommandot hittar den första manifestfilen som innehåller paket-ID:t och uppdaterar den. Om det inte finns något sådant paket-ID i en manifestfil som ingår i sökomfånget lägger SDK till en ny post i närmaste manifestfil. Sökomfånget är uppe via överordnade kataloger tills en manifestfil med isRoot = true hittas.

Ta bort lokala verktyg

Ta bort de installerade verktygen genom att köra avinstallationskommandot för dotnet-verktyget :

dotnet tool uninstall microsoft.botsay

dotnet tool uninstall dotnetsay

Felsöka

Om du får ett felmeddelande när du följer självstudien kan du läsa Felsöka problem med .NET-verktygsanvändning.

Se även

Mer information finns i .NET-verktyg

Dela via