Samouczek: instalowanie i używanie narzędzia lokalnego platformy .NET przy użyciu interfejsu wiersza polecenia platformy .NET

Artykuł
05/10/2023

Ten artykuł dotyczy: ✔️ zestaw .NET Core 3.0 SDK i nowsze wersje

W tym samouczku przedstawiono sposób instalowania i używania narzędzia lokalnego. Użyjesz narzędzia utworzonego w pierwszym samouczku tej serii.

Wymagania wstępne

Ukończ pierwszy samouczek tej serii.
Zainstaluj środowisko uruchomieniowe platformy .NET Core 2.1.

Na potrzeby tego samouczka zainstalujesz i użyjesz narzędzia przeznaczonego dla platformy .NET Core 2.1, więc musisz mieć to środowisko uruchomieniowe zainstalowane na maszynie. Aby zainstalować środowisko uruchomieniowe 2.1, przejdź do strony pobierania platformy .NET Core 2.1 i znajdź link instalacji środowiska uruchomieniowego w kolumnie Uruchamianie aplikacji — środowisko uruchomieniowe .

Tworzenie pliku manifestu

Aby zainstalować narzędzie tylko do uzyskiwania dostępu lokalnego (dla bieżącego katalogu i podkatalogów), należy go dodać do pliku manifestu.

W folderze microsoft.botsay przejdź do folderu repozytorium na jednym poziomie:

cd ..

Utwórz plik manifestu, uruchamiając polecenie dotnet new :

dotnet new tool-manifest

Dane wyjściowe wskazują pomyślne utworzenie pliku.

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

Plik .config/dotnet-tools.json nie ma jeszcze w nim żadnych narzędzi:

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

Narzędzia wymienione w pliku manifestu są dostępne dla bieżącego katalogu i podkatalogów. Bieżący katalog to ten, który zawiera katalog .config z plikiem manifestu.

Gdy używasz polecenia interfejsu wiersza polecenia odwołującego się do narzędzia lokalnego, zestaw SDK wyszukuje plik manifestu w bieżącym katalogu i katalogach nadrzędnych. Jeśli znajdzie plik manifestu, ale plik nie zawiera narzędzia, do których odwołuje się odwołanie, kontynuuje wyszukiwanie za pośrednictwem katalogów nadrzędnych. Wyszukiwanie kończy się po znalezieniu przywoływnego narzędzia lub znalezieniu pliku manifestu z ustawioną wartością isRoottrue.

Instalowanie botsay jako narzędzia lokalnego

Zainstaluj narzędzie z pakietu utworzonego w pierwszym samouczku:

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

To polecenie dodaje narzędzie do pliku manifestu utworzonego w poprzednim kroku. Dane wyjściowe polecenia pokazują, w którym pliku manifestu znajduje się nowo zainstalowane narzędzie:

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

Plik .config/dotnet-tools.json ma teraz jedno narzędzie:

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

Korzystanie z narzędzia

Wywołaj narzędzie, uruchamiając dotnet tool run polecenie z folderu repozytorium :

dotnet tool run botsay hello from the bot

Przywracanie narzędzia lokalnego zainstalowanego przez inne osoby

Zazwyczaj narzędzie lokalne jest instalowane w katalogu głównym repozytorium. Po zaewidencjonowania pliku manifestu w repozytorium inni deweloperzy mogą pobrać najnowszy plik manifestu. Aby zainstalować wszystkie narzędzia wymienione w pliku manifestu, można uruchomić jedno dotnet tool restore polecenie.

Otwórz plik.config/dotnet-tools.json i zastąp zawartość następującym kodem JSON:

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

Zapisz zmiany.

Wprowadzenie tej zmiany jest takie samo jak pobieranie najnowszej wersji z repozytorium po zainstalowaniu pakietu dotnetsay dla katalogu projektu przez inną osobę.

Uruchom polecenie dotnet tool restore.

dotnet tool restore

Polecenie generuje dane wyjściowe, takie jak w poniższym przykładzie:

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.

Sprawdź, czy narzędzia są dostępne:

dotnet tool list

Dane wyjściowe to lista pakietów i poleceń, podobnie jak w poniższym przykładzie:

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

Przetestuj narzędzia:

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

Aktualizowanie narzędzia lokalnego

Zainstalowana wersja narzędzia dotnetsay lokalnego to 2.1.3. Użyj polecenia dotnet tool update , aby zaktualizować narzędzie do najnowszej wersji.

dotnet tool update dotnetsay

Dane wyjściowe wskazują nowy numer wersji:

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

Polecenie update znajduje pierwszy plik manifestu zawierający identyfikator pakietu i aktualizuje go. Jeśli nie ma takiego identyfikatora pakietu w żadnym pliku manifestu, który znajduje się w zakresie wyszukiwania, zestaw SDK dodaje nowy wpis do najbliższego pliku manifestu. Zakres wyszukiwania jest w górę przez katalogi nadrzędne do momentu znalezienia pliku manifestu.isRoot = true

Usuwanie narzędzi lokalnych

Usuń zainstalowane narzędzia, uruchamiając polecenie odinstalowywania narzędzia dotnet :

dotnet tool uninstall microsoft.botsay

dotnet tool uninstall dotnetsay

Rozwiązywanie problemów

Jeśli podczas wykonywania samouczka zostanie wyświetlony komunikat o błędzie, zobacz Rozwiązywanie problemów z użyciem narzędzi platformy .NET.

Zobacz też

Aby uzyskać więcej informacji, zobacz .NET tools (Narzędzia platformy .NET)