.NET-eszközök kezelése

Cikk
08/18/2023

Ez a cikk a ✔️ .NET Core 2.1 SDK és újabb verzióira vonatkozik.

A .NET-eszköz egy speciális NuGet-csomag, amely egy konzolalkalmazást tartalmaz. Az eszközt a következő módokon telepítheti a gépére:

Globális eszközként.

Az eszköz bináris fájljai a PATH környezeti változóhoz hozzáadott alapértelmezett könyvtárban vannak telepítve. Az eszközt a számítógép bármely könyvtárából meghívhatja a hely megadása nélkül. Az eszköz egy verziója a gép összes könyvtárához használható.
Globális eszközként egy egyéni helyen (más néven eszközútvonal-eszközként).

Az eszköz bináris fájljai a megadott helyen vannak telepítve. Az eszközt a telepítési könyvtárból hívhatja meg, ha megadja a parancsnevet a könyvtárnak, vagy hozzáadja a könyvtárat a PATH környezeti változóhoz. Az eszköz egy verziója a gép összes könyvtárához használható.
Helyi eszközként (a .NET Core SDK 3.0-s és újabb verzióira vonatkozik).

Az eszköz bináris fájljai egy alapértelmezett könyvtárban vannak telepítve. Az eszközt meghívhatja a telepítési könyvtárból vagy annak bármely alkönyvtárából. A különböző könyvtárak ugyanannak az eszköznek különböző verzióit használhatják.

A .NET CLI jegyzékfájlokat használ a címtárban helyiként telepített eszközök nyomon követésére. Amikor a jegyzékfájlt egy forráskódtár gyökérkönyvtárába menti, a közreműködő klónozhatja az adattárat, és egyetlen .NET CLI-parancsot hívhat meg a jegyzékfájlokban felsorolt összes eszköz telepítéséhez.

Fontos

A .NET-eszközök teljes megbízhatóságban futnak. Csak akkor telepítsen .NET-eszközt, ha megbízik a szerzőben.

Előfordulhat, hogy a .NET-eszközök nem működnek megfelelően, ha a .NET beépülő modulon keresztül lett telepítve.

Eszköz keresése

Az alábbiakban néhány módszert talál az eszközök megkeresésére:

A dotnet eszköz keresési parancsával keresse meg a NuGet.org közzétett eszközt.
A NuGet-webhely kereséséhez használja a ".NET eszköz" csomagtípus-szűrőt. További információ: Csomagok keresése és kiválasztása.
Tekintse meg a dotnet/aspnetcore GitHub-adattár Eszközök könyvtárában létrehozott ASP.NET Core-csapat által létrehozott eszközök forráskódját.
További információ a diagnosztikai eszközökről a .NET diagnosztikai eszközeinél.

Ellenőrizze a szerzőt és a statisztikákat

A .NET-eszközök hatékonyak lehetnek, mert teljes megbízhatóságban futnak, és globális eszközöket adnak hozzá a PATH környezeti változóhoz. Ne töltsön le eszközöket olyan személyektől, akikben nem bízik.

Ha az eszköz a NuGeten található, az eszköz keresésével ellenőrizheti a szerzőt és a statisztikákat.

Globális eszköz telepítése

Ha globális eszközként szeretne telepíteni egy eszközt, használja a -g--global dotnet eszköz telepítésének lehetőségét, ahogyan az alábbi példában látható:

dotnet tool install -g dotnetsay

A kimenet az eszköz meghívásához használt parancsot és a telepített verziót jeleníti meg az alábbi példához hasonlóan:

You can invoke the tool using the following command: dotnetsay
Tool 'dotnetsay' (version '2.1.4') was successfully installed.

Feljegyzés

Alapértelmezés szerint a telepíteni kívánt .NET bináris fájlok architektúrája a jelenleg futó operációsrendszer-architektúrát jelöli. Egy másik operációsrendszer-architektúra megadásához lásd : dotnet tool install , --arch option.

Az eszköz bináris fájljainak alapértelmezett helye az operációs rendszertől függ:

OS	Elérési út
Linux/macOS	`$HOME/.dotnet/tools`
Windows	`%USERPROFILE%\.dotnet\tools`

Ezt a helyet a rendszer hozzáadja a felhasználó elérési útjához az SDK első futtatásakor. Így a globális eszközök bármely könyvtárból meghívhatók az eszköz helyének megadása nélkül.

Az eszközhozzáférés felhasználóspecifikus, nem pedig globális gép. Globális eszköz csak az eszközt telepítő felhasználó számára érhető el.

Globális eszköz telepítése egyéni helyen

Ha egy eszközt globális eszközként szeretne telepíteni egy egyéni helyen, használja a --tool-path dotnet eszköz telepítésének lehetőségét az alábbi példákban látható módon:

Windows rendszeren:

dotnet tool install dotnetsay --tool-path c:\dotnet-tools

Linux vagy macOS rendszeren:

dotnet tool install dotnetsay --tool-path ~/bin

A .NET SDK nem adja hozzá automatikusan ezt a helyet a PATH környezeti változóhoz. Eszközútvonal-eszköz meghívásához győződjön meg arról, hogy a parancs elérhető az alábbi módszerek egyikével:

Adja hozzá a telepítési könyvtárat a PATH környezeti változóhoz.
A meghíváskor adja meg az eszköz teljes elérési útját.
Hívja meg az eszközt a telepítési könyvtárból.

Helyi eszköz telepítése

A .NET Core 3.0 SDK-ra és újabb verziókra vonatkozik.

Ha csak helyi hozzáférésű eszközt szeretne telepíteni (az aktuális könyvtárra és alkönyvtárakra), akkor hozzá kell adnia az eszközt egy eszközjegyzékfájlhoz. Eszközjegyzékfájl létrehozásához futtassa a dotnet new tool-manifest következő parancsot:

dotnet new tool-manifest

Ez a parancs létrehoz egy dotnet-tools.json nevű jegyzékfájlt a .config könyvtárban. Ha helyi eszközt szeretne hozzáadni a jegyzékfájlhoz, használja a dotnet eszköz telepítési parancsát, és hagyja ki azokat és --tool-path a --global beállításokat, ahogyan az a következő példában látható:

dotnet tool install dotnetsay

A parancs kimenete az alábbi példához hasonlóan 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 dotnetsay
Tool 'dotnetsay' (version '2.1.4') was successfully installed.
Entry is added to the manifest file /home/name/botsay/.config/dotnet-tools.json.

Az alábbi példa egy jegyzékfájlt mutat be, amelyen két helyi eszköz van telepítve:

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

Általában hozzáad egy helyi eszközt az adattár gyökérkönyvtárához. Miután beadta a jegyzékfájlt az adattárba, a kódokat az adattárból kitöltő fejlesztők megkapják a legújabb jegyzékfájlt. A jegyzékfájlban felsorolt összes eszköz telepítéséhez futtassa a dotnet tool restore következő parancsot:

dotnet tool restore

A kimenet a visszaállított eszközöket jelzi:

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

Adott eszközverzió telepítése

Egy előzetes verzió vagy egy eszköz adott verziójának telepítéséhez adja meg a verziószámot a --version beállítással, ahogyan az a következő példában látható:

dotnet tool install dotnetsay --version 2.1.3

Ha az eszköz kiadás előtti verzióját szeretné telepíteni a pontos verziószám megadása nélkül, használja a --version beállítást, és adjon meg egy helyettesítő karaktert az alábbi példában látható módon:

dotnet tool install --global dotnetsay --version "*-rc*"

Eszköz használata

Az eszköz meghívására használt parancs eltérhet a telepített csomag nevétől. Az aktuális felhasználó számára a számítógépen jelenleg telepített összes eszköz megjelenítéséhez használja a dotnet eszközlista parancsot:

dotnet tool list

A kimenet az egyes eszközök verzióját és parancsát jeleníti meg, az alábbi példához hasonlóan:

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

Ahogy az előző példában is látható, a lista helyi eszközöket jelenít meg. A globális eszközök megtekintéséhez használja a --global lehetőséget. Az eszközútvonal-eszközök megtekintéséhez használja a --tool-path lehetőséget.

Egy adott eszköz listázásához használja a dotnet eszközlistát <PACKAGE_ID> parancsot:

dotnet tool list dotnetsay

A kimenet csak akkor sorolja fel az eszközt, ha telepítve van, az alábbi példához hasonlóan:

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

Globális eszköz meghívása

Globális eszközök esetén használja az eszközparancsot önmagában. Ha például a parancs a dotnetsaydotnet-dockövetkező, akkor a globális eszköz meghívásához használja a következőt:

dotnetsay
dotnet-doc

Ha a parancs az előtaggal dotnet-kezdődik, az eszköz meghívásának másik módja a parancs használata dotnet és az eszközparancs előtagjának kihagyása. Ha például a parancs az dotnet-doc, a következő parancs hívja meg az eszközt:

dotnet doc

A következő forgatókönyvben azonban nem használhatja a dotnet parancsot globális eszköz meghívására:

A globális és a helyi eszközök parancselőtagja dotnet-ugyanaz.
A globális eszközt egy olyan könyvtárból szeretné meghívni, amely a helyi eszköz hatókörébe tartozik.

Ebben a forgatókönyvben dotnet docdotnet dotnet-doc hívja meg a helyi eszközt. A globális eszköz meghívásához használja a következő parancsot:

dotnet-doc

Eszközútvonal-eszköz meghívása

Ha egy olyan globális eszközt szeretne meghívni, amely a tool-path beállítással van telepítve, győződjön meg arról, hogy a parancs elérhető a cikkben korábban ismertetett módon.

Helyi eszköz meghívása

Helyi eszköz meghívásához a dotnet telepítési könyvtárban található parancsot kell használnia. A hosszú (dotnet tool run <COMMAND_NAME>) vagy a rövid (dotnet <COMMAND_NAME>) űrlapot az alábbi példákban látható módon használhatja:

dotnet tool run dotnetsay
dotnet dotnetsay

Ha a parancs előtaggal dotnet-van elnevezve, az eszköz meghívásakor belefoglalhatja vagy kihagyhatja az előtagot. Ha például a parancs az dotnet-doc, az alábbi példák bármelyike meghívja a helyi eszközt:

dotnet tool run dotnet-doc
dotnet dotnet-doc
dotnet doc

Eszköz frissítése

Az eszköz frissítéséhez el kell távolítani és újra kell telepíteni a legújabb stabil verzióval. Eszköz frissítéséhez használja a dotnet eszközfrissítési parancsot az eszköz telepítéséhez használt beállítással:

dotnet tool update --global <packagename>
dotnet tool update --tool-path <packagename>
dotnet tool update <packagename>

Helyi eszköz esetén az SDK az aktuális könyvtárban és szülőkönyvtárakban keresi meg a csomagazonosítót tartalmazó első jegyzékfájlt. Ha egy jegyzékfájlban nincs ilyen csomagazonosító, az SDK új bejegyzést ad hozzá a legközelebbi jegyzékfájlhoz.

Eszköz eltávolítása

Távolítsa el az eszközt a dotnet tool uninstall paranccsal, ugyanazzal a beállítással, amelyet az eszköz telepítéséhez használt:

dotnet tool uninstall --global <packagename>
dotnet tool uninstall --tool-path <packagename>
dotnet tool uninstall <packagename>

Helyi eszköz esetén az SDK az aktuális könyvtárban és szülőkönyvtárakban keresi meg a csomagazonosítót tartalmazó első jegyzékfájlt.

Segítség és hibaelhárítás

Ha egy eszköz telepítése vagy futtatása sikertelen, olvassa el a .NET-eszközök használati problémáinak hibaelhárítását. A paraméterrel --help lekérheti az elérhető dotnet tool parancsok és paraméterek listáját:

dotnet tool --help

Az eszköz használati utasításainak lekéréséhez írja be az alábbi parancsok egyikét, vagy tekintse meg az eszköz webhelyét:

<command> --help
dotnet <command> --help