Kurz: Instalace a použití místního nástroje .NET pomocí rozhraní příkazového řádku .NET

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

V tomto kurzu se naučíte, jak nainstalovat a používat místní nástroj. Používáte nástroj, který vytvoříte v prvním tutoriálu této série.

Požadavky

Vytvoření souboru manifestu

Pokud chcete nainstalovat nástroj pouze pro místní přístup (pro aktuální adresář a podadresáře), musí se přidat do souboru manifestu.

Ze složky dotnet-env přejděte o jednu úroveň výš do složky úložiště :

cd ..

Spuštěním příkazu dotnet new vytvořte soubor manifestu:

dotnet new tool-manifest

Výstup označuje úspěšné vytvoření souboru.

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

Soubor .config/dotnet-tools.json zatím nemá žádné nástroje:

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

Nástroje uvedené v souboru manifestu jsou k dispozici pro aktuální adresář a podadresáře. Aktuální adresář je adresář, který obsahuje adresář .config se souborem manifestu.

Když použijete příkaz rozhraní příkazového řádku, který odkazuje na místní nástroj, sada SDK vyhledá soubor manifestu v aktuálním adresáři a nadřazených adresářích. Pokud najde soubor manifestu, ale soubor neobsahuje odkazovaný nástroj, bude pokračovat ve vyhledávání prostřednictvím nadřazených adresářů. Hledání skončí, když najde odkazovaný nástroj nebo najde soubor manifestu s isRoot nastaveným na true.

Instalace dotnet-env jako místního nástroje (tradiční přístup)

Nainstalujte nástroj z balíčku, který jste vytvořili v prvním kurzu:

dotnet tool install --add-source ./dotnet-env/nupkg dotnet-env

Tento příkaz přidá nástroj do souboru manifestu, který jste vytvořili v předchozím kroku. Výstup příkazu ukazuje, ve kterém souboru manifestu je nově nainstalovaný nástroj:

You can invoke the tool from this directory using the following command:
'dotnet tool run dotnet-env' or 'dotnet dotnet-env'
Tool 'dotnet-env' (version '1.0.0') was successfully installed.
Entry is added to the manifest file /home/name/repository/.config/dotnet-tools.json

Soubor .config/dotnet-tools.json teď má jeden nástroj:

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "dotnet-env": {
      "version": "1.0.0",
      "commands": [
        "dotnet-env"
      ]
    }
  }
}

Použití nainstalovaného místního nástroje

Po instalaci jako místního nástroje ho můžete vyvolat několika způsoby:

  • Spusťte nástroj přímo pomocí dnx:

    dnx dotnet-env --add-source ./nupkg

    Poznámka:

    Při použití dnx s místním manifestem nástroje se automaticky použije verze zadaná v manifestu.

  • Použití dotnet dotnet-env:

    dotnet dotnet-env

  • Použití dotnet tool run

    dotnet tool run dotnet-env

Obnovení místního nástroje nainstalovaného jinými uživateli

Místní nástroj obvykle nainstalujete do kořenového adresáře úložiště. Po vrácení souboru manifestu do úložiště můžou další vývojáři získat nejnovější soubor manifestu. Pokud chcete nainstalovat všechny nástroje uvedené v souboru manifestu, můžou spustit jeden příkaz dotnet tool restore.

  1. Otevřete soubor .config/dotnet-tools.json a nahraďte obsah následujícím kódem JSON:

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

  2. Uložte změny.

    Provedení této změny je stejné jako získání nejnovější verze z úložiště poté, co někdo jiný nainstaloval balíček dotnetsay pro adresář projektu.

  3. Spusťte příkaz dotnet tool restore.

    dotnet tool restore

    Příkaz vytvoří výstup jako v následujícím příkladu:

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

  4. Ověřte, že jsou nástroje dostupné:

    dotnet tool list

    Výstup je seznam balíčků a příkazů, podobně jako v následujícím příkladu:

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

  5. Otestujte nástroje:

    dotnet tool run dotnetsay hello from dotnetsay
dotnet tool run dotnet-env

Aktualizace místního nástroje

Nainstalovaná verze místního nástroje dotnetsay je 2.1.3. Pomocí příkazu dotnet tool update aktualizujte nástroj na nejnovější verzi.

dotnet tool update dotnetsay

Výstup označuje číslo nové verze:

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

Příkaz update najde první soubor manifestu, který obsahuje ID balíčku, a aktualizuje ho. Pokud v žádném souboru manifestu, který je v oboru hledání, neexistuje žádné ID balíčku, sada SDK přidá novou položku do nejbližšího souboru manifestu. Rozsah vyhledávání prochází nadřazené adresáře, dokud není nalezen soubor manifestu s isRoot = true.

Odeberte místní nástroje

Odeberte nainstalované nástroje spuštěním příkazu dotnet tool uninstall:

dotnet tool uninstall dotnet-env

dotnet tool uninstall dotnetsay

Odstraňování problémů

Pokud se při sledování kurzu zobrazí chybová zpráva, přečtěte si téma Řešení potíží s používáním nástrojů .NET.

Viz také

Pro více informací se podívejte na nástroje .NET viz .

  • Last updated on