Správa nástrojů .NET

Článek
08/18/2023

Tento článek se vztahuje na: ✔️ .NET Core 2.1 SDK a novější verze.

Nástroj .NET je speciální balíček NuGet, který obsahuje konzolovou aplikaci. Nástroj můžete na počítač nainstalovat následujícími způsoby:

Jako globální nástroj.

Binární soubory nástroje se nainstalují do výchozího adresáře, který se přidá do proměnné prostředí PATH. Nástroj můžete vyvolat z libovolného adresáře na počítači bez zadání jeho umístění. Jedna verze nástroje se používá pro všechny adresáře na počítači.
Jako globální nástroj ve vlastním umístění (označovaný také jako nástroj pro cestu k nástrojům).

Binární soubory nástrojů se nainstalují do zadaného umístění. Nástroj můžete vyvolat z instalačního adresáře zadáním názvu příkazu nebo přidáním adresáře do proměnné prostředí PATH. Jedna verze nástroje se používá pro všechny adresáře na počítači.
Jako místní nástroj (platí pro sadu .NET Core SDK 3.0 a novější verze).

Binární soubory nástrojů se instalují do výchozího adresáře. Nástroj můžete vyvolat z instalačního adresáře nebo libovolného jeho podadresáře. Různé adresáře můžou používat různé verze stejného nástroje.

Rozhraní příkazového řádku .NET používá soubory manifestu ke sledování nástrojů, které jsou nainstalované jako místní do adresáře. Když je soubor manifestu uložený v kořenovém adresáři úložiště zdrojového kódu, může přispěvatel naklonovat úložiště a vyvolat jeden příkaz rozhraní příkazového řádku .NET, který nainstaluje všechny nástroje uvedené v souborech manifestu.

Důležité

Nástroje .NET běží v plném vztahu důvěryhodnosti. Nenainstalujte nástroj .NET, pokud autorovi nedůvěřujete.

Nástroje .NET nemusí správně fungovat, pokud byl .NET nainstalován prostřednictvím nástroje Snap.

Vyhledání nástroje

Tady je několik způsobů, jak najít nástroje:

Pomocí příkazu hledání nástrojů dotnet vyhledejte nástroj, který je publikovaný do NuGet.org.
Pomocí filtru typu balíčku .NET vyhledejte web NuGet . Další informace naleznete v tématu Hledání a výběr balíčků.
Podívejte se na zdrojový kód nástrojů, které tým ASP.NET Core vytvořený v adresáři Nástroje úložiště dotnet/aspnetcore GitHub.
Seznamte se s diagnostickými nástroji v diagnostických nástrojích .NET.

Kontrola autora a statistiky

Nástroje .NET můžou být výkonné, protože běží v plném vztahu důvěryhodnosti a globální nástroje se přidají do proměnné prostředí PATH. Nestahujte nástroje od lidí, kterým nedůvěřujete.

Pokud je nástroj hostovaný na NuGetu, můžete zkontrolovat autora a statistiky vyhledáním nástroje.

Instalace globálního nástroje

Pokud chcete nástroj nainstalovat jako globální nástroj, použijte -g--global možnost instalace nástroje dotnet, jak je znázorněno v následujícím příkladu:

dotnet tool install -g dotnetsay

Výstup ukazuje příkaz použitý k vyvolání nástroje a nainstalované verze, podobně jako v následujícím příkladu:

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

Poznámka:

Ve výchozím nastavení architektura binárních souborů .NET, které se mají nainstalovat, představuje aktuálně spuštěnou architekturu operačního systému. Pokud chcete zadat jinou architekturu operačního systému, přečtěte si téma instalace nástroje dotnet, možnost --arch.

Výchozí umístění binárních souborů nástroje závisí na operačním systému:

Operační systém	Cesta
Linux/macOS	`$HOME/.dotnet/tools`
Windows	`%USERPROFILE%\.dotnet\tools`

Toto umístění se přidá do cesty uživatele při prvním spuštění sady SDK. Globální nástroje je tedy možné vyvolat z libovolného adresáře bez zadání umístění nástroje.

Přístup k nástrojům je specifický pro uživatele, nikoli globální počítač. Globální nástroj je k dispozici pouze uživateli, který nástroj nainstaloval.

Instalace globálního nástroje do vlastního umístění

Pokud chcete nástroj nainstalovat jako globální nástroj do vlastního umístění, použijte --tool-path možnost instalace nástroje dotnet, jak je znázorněno v následujících příkladech:

Ve Windows:

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

V Linuxu nebo macOS:

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

Sada .NET SDK nepřidá toto umístění automaticky do proměnné prostředí PATH. Chcete-li vyvolat nástroj pro cestu k nástrojům, je nutné zajistit, aby byl příkaz k dispozici pomocí jedné z následujících metod:

Přidejte instalační adresář do proměnné prostředí PATH.
Při vyvolání zadejte úplnou cestu k nástroji.
Vyvolání nástroje z instalačního adresáře

Instalace místního nástroje

Platí pro sadu .NET Core 3.0 SDK a novější.

Pokud chcete nainstalovat nástroj pouze pro místní přístup (pro aktuální adresář a podadresáře), musíte nástroj přidat do souboru manifestu nástroje. Pokud chcete vytvořit soubor manifestu dotnet new tool-manifest nástroje, spusťte příkaz:

dotnet new tool-manifest

Tento příkaz vytvoří soubor manifestu s názvem dotnet-tools.json v adresáři .config . Pokud chcete do souboru manifestu přidat místní nástroj, použijte příkaz instalace nástroje dotnet a vypište--global a --tool-path možnosti, jak je znázorněno v následujícím příkladu:

dotnet tool install dotnetsay

Výstup příkazu ukazuje, ve kterém souboru manifestu je nově nainstalovaný nástroj, podobně jako v následujícím příkladu:

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.

Následující příklad ukazuje soubor manifestu se dvěma nainstalovanými místními nástroji:

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

Do kořenového adresáře úložiště obvykle přidáte místní nástroj. Jakmile soubor manifestu vrátíte se změnami do úložiště, vývojáři, kteří si kód z úložiště prohlédnou, získají nejnovější soubor manifestu. Pokud chcete nainstalovat všechny nástroje uvedené v souboru manifestu dotnet tool restore , spustí příkaz:

dotnet tool restore

Výstup označuje obnovené nástroje:

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.

Instalace konkrétní verze nástroje

Pokud chcete nainstalovat předběžnou verzi nebo konkrétní verzi nástroje, zadejte číslo verze pomocí --version možnosti, jak je znázorněno v následujícím příkladu:

dotnet tool install dotnetsay --version 2.1.3

Pokud chcete nainstalovat předběžnou verzi nástroje bez zadání přesného čísla verze, použijte --version možnost a zadejte zástupný znak, jak je znázorněno v následujícím příkladu:

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

Použití nástroje

Příkaz, který použijete k vyvolání nástroje, se může lišit od názvu instalačního balíčku. Pokud chcete zobrazit všechny nástroje aktuálně nainstalované na počítači pro aktuálního uživatele, použijte příkaz dotnet tool list :

dotnet tool list

Výstup ukazuje verzi a příkaz jednotlivých nástrojů, podobně jako v následujícím příkladu:

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

Jak je znázorněno v předchozím příkladu, zobrazí se v seznamu místní nástroje. Pokud chcete zobrazit globální nástroje, použijte tuto --global možnost. Pokud chcete zobrazit nástroje pro cestu k nástrojům, použijte tuto --tool-path možnost.

Pokud chcete zobrazit seznam konkrétního nástroje, použijte příkaz dotnet tool list <PACKAGE_ID> :

dotnet tool list dotnetsay

Výstup zobrazí jenom tento nástroj, pokud je nainstalovaný, podobně jako v následujícím příkladu:

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

Vyvolání globálního nástroje

V případě globálních nástrojů použijte samotný příkaz nástroje. Například pokud je dotnetsay příkaz nebo dotnet-doc, který slouží k vyvolání globálního nástroje:

dotnetsay
dotnet-doc

Pokud příkaz začíná předponou dotnet-, alternativním způsobem vyvolání nástroje je použít dotnet příkaz a vynechat předponu příkazu nástroje. Pokud je dotnet-docpříkaz například , vyvolá nástroj následující příkaz:

dotnet doc

V následujícím scénáři ale nemůžete použít dotnet příkaz k vyvolání globálního nástroje:

Globální nástroj a místní nástroj mají stejný příkaz s předponou dotnet-.
Chcete vyvolat globální nástroj z adresáře, který je v oboru místního nástroje.

V tomto scénáři dotnet doc a dotnet dotnet-doc vyvolání místního nástroje. Pokud chcete vyvolat globální nástroj, použijte samotný příkaz:

dotnet-doc

Vyvolání nástroje pro cestu k nástrojům

Pokud chcete vyvolat globální nástroj, který je nainstalovaný pomocí tool-path této možnosti, ujistěte se, že je příkaz k dispozici, jak je vysvětleno výše v tomto článku.

Vyvolání místního nástroje

Pokud chcete vyvolat místní nástroj, musíte použít dotnet příkaz z instalačního adresáře. Můžete použít dlouhý formulář (dotnet tool run <COMMAND_NAME>) nebo krátký formulář (dotnet <COMMAND_NAME>), jak je znázorněno v následujících příkladech:

dotnet tool run dotnetsay
dotnet dotnetsay

Pokud je příkaz předponou dotnet-, můžete při vyvolání nástroje zahrnout nebo vynechat předponu. Pokud je dotnet-docpříkaz například , vyvolá místní nástroj některý z následujících příkladů:

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

Aktualizace nástroje

Aktualizace nástroje zahrnuje odinstalaci a přeinstalaci pomocí nejnovější stabilní verze. Pokud chcete nástroj aktualizovat, použijte příkaz dotnet tool update se stejnou možností, jakou jste použili k instalaci nástroje:

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

V případě místního nástroje sada SDK hledá v aktuálním adresáři a nadřazených adresářích první soubor manifestu obsahující ID balíčku. Pokud v žádném souboru manifestu neexistuje žádné ID balíčku, sada SDK přidá novou položku do nejbližšího souboru manifestu.

Odinstalace nástroje

Odinstalujte nástroj pomocí příkazu dotnet tool uninstall se stejnou možností, jakou jste použili k instalaci nástroje:

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

V případě místního nástroje sada SDK hledá v aktuálním adresáři a nadřazených adresářích první soubor manifestu obsahující ID balíčku.

Získání nápovědy a řešení potíží

Pokud se nástroj nepodaří nainstalovat nebo spustit, přečtěte si téma Řešení potíží s používáním nástrojů .NET. Seznam dostupných dotnet tool příkazů a parametrů můžete získat pomocí parametru --help :

dotnet tool --help

Pokud chcete získat pokyny k používání nástrojů, zadejte jeden z následujících příkazů nebo se podívejte na web nástroje:

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