.NET Conf

.NET Command Line Interface (CLI) zapewnia rozbudowany ekosystem do zarządzania narzędziami deweloperskimi poprzez komendy dotnet tool, umożliwiając programistom instalowanie, zarządzanie i wykorzystywanie narzędzi zarówno na poziomie globalnym, jak i lokalnym w różnych zakresach i kontekstach.

Spis treści [odkryj]

Poniżej kompleksowo omawiamy zagadnienia instalacji narzędzi .NET, skupiając się na różnicach między narzędziami globalnymi i lokalnymi, metodach zarządzania, a także praktycznym ich wykorzystaniu w codziennym developmentcie.

System CLI .NET zwiększa produktywność programistów, oferując jednolite podejście do dystrybucji narzędzi na Windows, Linux i macOS, zapewniając spójne doświadczenie niezależnie od platformy.

Architektura i klasyfikacja narzędzi .NET

W ekosystemie .NET narzędzia dzielą się w zależności od zakresu instalacji, dostępności i sposobu zarządzania:

  • narzędzia globalne,
  • narzędzia instalowane przez tool-path,
  • narzędzia lokalne.

Narzędzia .NET to w istocie aplikacje konsolowe publikowane jako pakiety NuGet. Uruchamia się je w linii komend, znacząco rozszerzając bazowe możliwości CLI .NET oraz wspierając dynamiczny workflow projektowy.

Narzędzia globalne instaluje się w katalogu użytkownika domyślnie dodawanym do zmiennej PATH, co zapewnia dostęp z dowolnej lokalizacji.

Narzędzia instalowane przez tool-path można ulokować w dowolnie wybranym miejscu, co daje elastyczność organizacyjną, jednak wymaga ręcznej konfiguracji ścieżki dostępu.

Narzędzia lokalne powiązane są z określonym katalogiem projektu oraz jego podkatalogami poprzez pliki manifestu – umożliwiają kontrolę i spójność wersji w zespole.

Instalacja i zarządzanie narzędziami globalnymi

Najprostszą metodą udostępnienia narzędzi w całym środowisku developerskim jest instalacja globalna z użyciem komendy:

dotnet tool install --global NAZWA_NARZĘDZIA

Narzędzie trafi do %USERPROFILE%\.dotnet\tools (Windows) lub $HOME/.dotnet/tools (Linux/macOS), a ten katalog zostaje automatycznie dodany do PATH.

Przy instalacji globalnej warto zwrócić uwagę na następujące aspekty:

  • źródło pakietu – możliwość wskazania repozytorium przez --add-source,
  • wersja narzędzia – ustawiana przez --version, pozwala kontrolować zgodność,
  • zgodność architektury – domyślnie automatyczna, lecz można wymusić z --arch.

Zarządzanie narzędziami globalnymi obejmuje między innymi:

  • aktualizowanie – dotnet tool update --global instaluje najnowszą wersję,
  • sprawdzanie listy – dotnet tool list --global pokazuje wszystkie zainstalowane narzędzia,
  • usuwanie – dotnet tool uninstall --global pozwala trwale usunąć wybrane narzędzie.

Instalacja narzędzi lokalnych i zarządzanie manifestem

Model lokalny doskonale sprawdza się, gdy wymagane jest przypisane narzędzi do konkretnego projektu. Rozwiązuje on takie wyzwania, jak:

  • spójność wersji używanych w zespole,
  • izolacja projektu i unikanie konfliktów narzędzi,
  • szybka rekonfiguracja środowiska po pobraniu repozytorium.

Aby utworzyć manifest narzędzi lokalnych uruchom komendę:

dotnet new tool-manifest

Następnie instalacja narzędzi (bez flagi --global) automatycznie wpisuje je do .config/dotnet-tools.json oraz katalogu NuGet.

Hierarchia rozpoznawania manifestu zapewnia, że narzędzia są dostępne tylko na określonych poziomach projektu. Po sklonowaniu repo należy użyć:

dotnet tool restore

Dzięki temu wszystkie wymagane narzędzia zostaną zainstalowane zgodnie z plikiem manifestu.

Zaawansowane scenariusze instalacji i niestandardowe lokalizacje

.NET CLI umożliwia instalację narzędzi w niestandardowych ścieżkach przy użyciu --tool-path. Pozwala to na:

  • organizowanie narzędzi na zasobach sieciowych lub współdzielonych,
  • obsługę wielu wersji jednocześnie (np. przez katalogi o nazwach zawierających numer wersji),
  • testowanie aktualizacji i optymalizowanie bezpieczeństwa poprzez zarządzanie uprawnieniami.

W tych scenariuszach należy ręcznie skonfigurować PATH lub uruchamiać narzędzia poprzez pełną ścieżkę.

Odkrywanie narzędzi i powiązanie z NuGet

Wyszukiwanie narzędzi .NET realizowane jest komendą:

dotnet tool search NAZWA

Dostępne są dodatkowe opcje:

  • uzyskanie szczegółowych informacji (--detail – opis, statystyki, historia),
  • przeglądanie wersji wstępnych (--prerelease),
  • ustawianie niestandardowego repo przez --add-source.

Dystrybucja, wersjonowanie i bezpieczeństwo bazują na ekosystemie NuGet, gwarantując spójność procesu i pełną kontrolę nad wersją narzędzia zgodnie z semantyką NuGet.

Modele uruchamiania narzędzi

Sposób wywołania narzędzi zależy od ich modelu instalacji:

  • narzędzia globalne – po prostu wpisujesz nazwę narzędzia w terminalu,
  • narzędzia lokalne – wymagają obecności manifestu; uruchamiasz przez dotnet tool run NAZWA lub bezpośrednio jeśli narzędzie ma prefiks dotnet-,
  • narzędzia przez tool-path – uruchamiasz przez pełną ścieżkę do katalogu instalacji lub konfigurację PATH.

W przypadku konfliktów priorytet uzyskują narzędzia lokalne, co pozwala korzystać z różnych wersji bez kolizji w ramach projektów oraz zachować kontrolę środowiska.

Manifesty narzędzi i hierarchia rozpoznawania

Plik manifestu dotnet-tools.json przechowuje metadane narzędzi, wymogi wersji oraz mapowanie komend. Pozwala to na:

  • hierarchiczne dziedziczenie narzędzi na poziomach organizacji, rozwiązania i projektu,
  • nadpisywanie narzędzi na niższych poziomach katalogowych,
  • wysoką wydajność dzięki cache’owaniu zawartości przez CLI .NET.

Pliki manifestów podlegają walidacji składni i obecności wymaganych pól, a błędy są jasno raportowane, co znacznie upraszcza rozwiązywanie problemów konfiguracyjnych.

Bezpieczeństwo i modele zaufania przy instalacji

Kwestie bezpieczeństwa są kluczowe przy zarządzaniu narzędziami. Do głównych praktyk należą:

  • weryfikacja integralności i podpisów pakietów NuGet,
  • izolacja środowiska w modelu lokalnym lub narzędzi tool-path,
  • zarządzanie uprawnieniami do katalogów narzędzi,
  • ograniczanie źródeł instalacji tylko do zaufanych repozytoriów.

Przy narzędziach globalnych zaleca się szczególną ostrożność, ponieważ działają na uprawnieniach użytkownika i mają dostęp do całego PATH.

Zaleca się wdrażanie zasady najmniejszych uprawnień – narzędzia instalować wyłącznie tam, gdzie są niezbędne.

Integracja narzędzi .NET z workflow i systemami budowania

Narzędzia .NET doskonale integrują się z procesem developerskim:

  • wersjonowanie narzędzi razem z kodem źródłowym – zapewnia powtarzalność buildów i środowisk,
  • integracja z MSBuild i CI/CD dzięki automatycznemu wykonaniu dotnet tool restore przed buildem,
  • współpraca z kontenerami developerskimi – narzędzia globalne mogą być wstępnie instalowane w image’u, narzędzia lokalne przywracane z manifestu,
  • automatyzacja onboardingu i dokumentacji środowiska – manifest narzędzi umożliwia tworzenie przewodników instalacyjnych oraz walidację konfiguracji.

Optymalizacja wydajności i cache’owanie

Na wydajność pracy z narzędziami wpływają następujące czynniki:

  • cache’owanie lokalizacji i meta-informacji przez CLI .NET,
  • lokalne repozytorium paczek NuGet,
  • przemyślana organizacja katalogów dla manifestów,
  • minimalizacja głębokości katalogów dla manifestów lokalnych.

Narzędzia globalne uruchamiają się niemal natychmiast, natomiast narzędzia lokalne wymagają rozpoznania manifestu i struktury ścieżek, co przy częstych operacjach może mieć istotny wpływ na wydajność.

Diagnozowanie i utrzymanie narzędzi

Typowe procedury utrzymania i rozwiązywania problemów obejmują:

  • weryfikację instalacji poleceniem dotnet tool list,
  • diagnostykę konfiguracji PATH i dostępu do katalogów,
  • sprawdzanie poprawności i spójności plików manifestu,
  • rozwiązywanie konfliktów wersji między modelami instalacji,
  • cykliczny audyt i aktualizację narzędzi.

CLI .NET generuje czytelne logi i komunikaty błędów, co znacząco ułatwia identyfikowanie oraz usuwanie usterek.

Kierunki rozwoju ekosystemu

Postęp ekosystemu narzędzi .NET opiera się na:

  • współpracy społeczności oraz wsparciu Microsoft,
  • adaptacji do środowisk kontenerowych, chmurowych i DevOps,
  • coraz większym nacisku na bezpieczeństwo łańcucha dostaw,
  • standaryzacji procesów publikacji, wersjonowania i dokumentacji narzędzi społecznościowych.

Pojawiają się też innowacje w zakresie optymalizacji rozmiaru paczek, wsparcia dla pracy offline oraz integracji z narzędziami do orkiestracji kontenerów.