Oktatóanyag: .NET helyi eszköz telepítése és használata a .NET parancssori felülettel

Cikk
01/29/2025

Ez a cikk a következőre vonatkozik: ✔️ .NET Core 3.0 SDK és újabb verziók

Ez az oktatóanyag bemutatja, hogyan telepíthet és használhat helyi eszközöket. A sorozat első oktatóanyagában létrehozott eszközt.

Előfeltételek

Fejezze be a sorozat első oktatóanyagát.
Telepítse a .NET Core 2.1 futtatókörnyezetet.

Ebben az oktatóanyagban egy olyan eszközt telepít és használ, amely a .NET Core 2.1-et célozza meg, ezért telepítenie kell a futtatókörnyezetet a gépére. A 2.1-s futtatókörnyezet telepítéséhez nyissa meg a .NET Core 2.1 letöltési oldalát, és keresse meg a futtatókörnyezetre mutató hivatkozást a Futtatókörnyezet oszlopban.

Jegyzékfájl létrehozása

Ha csak helyi hozzáférésű eszközt szeretne telepíteni (az aktuális könyvtárhoz és alkönyvtárakhoz), azt hozzá kell adni egy jegyzékfájlhoz.

A microsoft.botsay mappából navigáljon egy szinttel feljebb a adattár mappájához:

cd ..

Hozzon létre egy jegyzékfájlt a dotnet új parancs futtatásával:

dotnet new tool-manifest

A kimenet a fájl sikeres létrehozását jelzi.

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

A .config/dotnet-tools.json fájlban még nincsenek eszközök:

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

A jegyzékfájlban felsorolt eszközök az aktuális könyvtár és alkönyvtárak számára érhetők el. Az aktuális könyvtár tartalmazza a jegyzékfájllal rendelkező .config könyvtárat.

Ha olyan CLI-parancsot használ, amely helyi eszközre hivatkozik, az SDK manifest fájlt keres az aktuális könyvtárban és a szülőkönyvtárakban. Ha jegyzékfájlt talál, de a fájl nem tartalmazza a hivatkozott eszközt, a szülőkönyvtárakon keresztül folytatja a keresést. A keresés akkor fejeződik be, amikor megkeresi a hivatkozott eszközt, vagy talál egy jegyzékfájlt, amely isRoottrueértékre van állítva.

Botsay telepítése helyi eszközként

Telepítse az eszközt az első oktatóanyagban létrehozott csomagból:

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

Ez a parancs hozzáadja az eszközt az előző lépésben létrehozott jegyzékfájlhoz. A parancs kimenete azt mutatja, hogy az újonnan telepített eszköz melyik jegyzékfájlban található:

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

A .config/dotnet-tools.json fájl most már rendelkezik egy eszközzel:

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

Az eszköz használata

Az eszköz meghívásához futtassa a dotnet tool run parancsot a adattár mappájából:

dotnet tool run botsay hello from the bot

Mások által telepített helyi eszköz visszaállítása

Általában egy helyi eszközt telepít az adattár gyökérkönyvtárába. Miután beadta a jegyzékfájlt az adattárba, a többi fejlesztő lekérheti a legújabb jegyzékfájlt. A jegyzékfájlban felsorolt összes eszköz telepítéséhez egyetlen dotnet tool restore parancsot futtathatnak.

Nyissa meg a .config/dotnet-tools.json fájlt, és cserélje le a tartalmat a következő JSON-ra:

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

Mentse a módosításokat.

Ez a módosítás ugyanaz, mint a legújabb verzió beszerzése az adattárból, miután valaki más telepítette a csomag dotnetsay a projektkönyvtárhoz.

Futtassa a dotnet tool restore parancsot.

dotnet tool restore

A parancs az alábbi példához hasonló kimenetet hoz létre:

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.

Ellenőrizze, hogy elérhetők-e az eszközök:

dotnet tool list

A kimenet a csomagok és parancsok listája, az alábbi példához hasonlóan:

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

Tesztelje az eszközöket:

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

Helyi eszköz frissítése

A helyi eszköz dotnetsay telepített verziója a 2.1.3. A dotnet eszközfrissítési paranccsal frissítse az eszközt a legújabb verzióra.

dotnet tool update dotnetsay

A kimenet az új verziószámot jelzi:

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

A frissítési parancs megkeresi a csomagazonosítót tartalmazó első jegyzékfájlt, és frissíti azt. Ha a keresés hatókörébe tartozó jegyzékfájlban nincs ilyen csomagazonosító, az SDK új bejegyzést ad hozzá a legközelebbi jegyzékfájlhoz. A keresési hatókör a szülőkönyvtárakban felfelé terjed ki, amíg meg nem talál egy manifest fájlt, amely tartalmazza a isRoot = true-et.

Helyi eszközök eltávolítása

Távolítsa el a telepített eszközöket a dotnet eszköz eltávolítási parancs futtatásával:

dotnet tool uninstall microsoft.botsay

dotnet tool uninstall dotnetsay

Hibaelhárítás

Ha hibaüzenet jelenik meg az oktatóanyag követése során, olvassa el .NET-eszközök használati problémáinak elhárításacímű témakört.

Lásd még:

További információ: .NET-eszközök.

Megosztás a következőn keresztül: