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

Tento článek se týká: ✔️ .NET Core 3.0 SDK a novějších verzí

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

Požadavky

  • Dokončete první kurz této série.

  • Nainstalujte modul runtime .NET Core 2.1.

    Pro účely tohoto kurzu nainstalujete a použijete nástroj, který cílí na .NET Core 2.1, takže musíte mít na svém počítači nainstalovaný modul runtime. Pokud chcete nainstalovat modul runtime 2.1, přejděte na stránku pro stažení .NET Core 2.1 a vyhledejte odkaz na instalaci modulu runtime ve sloupci Spustit aplikace – runtime .

Vytvoření souboru manifestu

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

Ze složky microsoft.botsay přejděte o jednu úroveň výš do složky úložiště :

cd ..

Vytvořte soubor manifestu spuštěním příkazu dotnet new :

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 neobsahuje žá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 ten, 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 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 nastaveným isRoot na truehodnotu .

Instalace robota jako místního nástroje

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

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

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 se nově nainstalovaný nástroj nachází:

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

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

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

Použití nástroje

Vyvolejte nástroj spuštěním dotnet tool run příkazu ze složky úložiště :

dotnet tool run botsay hello from the bot

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

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

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

    {
      "version": 1,
      "isRoot": true,
      "tools": {
        "microsoft.botsay": {
          "version": "1.0.0",
          "commands": [
            "botsay"
          ]
        },
        "dotnetsay": {
          "version": "2.1.3",
          "commands": [
            "dotnetsay"
          ]
        }
      }
    }
    
  2. Uložte provedené změny.

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

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

    dotnet tool restore
    

    Příkaz vytvoří výstup podobný následujícímu příkladu:

    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.
    
  4. Ověřte, že jsou dostupné nástroje:

    dotnet tool list
    

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

    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
    
  5. Otestujte nástroje:

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

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 '2.1.7'
(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é TAKOVÉ ID balíčku, přidá sada SDK novou položku do nejbližšího souboru manifestu. Rozsah hledání probíhá prostřednictvím nadřazených adresářů, dokud se nenajde soubor manifestu s isRoot = true .

Odebrání místních nástrojů

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

dotnet tool uninstall microsoft.botsay
dotnet tool uninstall dotnetsay

Řešení potíží

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

Viz také

Další informace najdete v tématu Nástroje .NET.