Get-Help

Wyświetla pomoc i opis składni dla cmdletu lub tematu.

Get-Help to twój wbudowany podręcznik w PowerShellu. Wyświetla opis, składnię, parametry i przykłady dla dowolnego cmdletu (np. Get-Process) albo dla tematu pomocy (np. about_Functions). Zamiast googlować, co właściwie robi dana komenda i jakie ma parametry, pytasz powłokę bezpośrednio. Działa zarówno w klasycznym Windows PowerShell 5.1, jak i w PowerShell 7+ (Core).

Składnia i najważniejsze opcje

Podstawowo: Get-Help [-Examples] [-Detailed] [-Full] [-Online]

  • -Examples — pokazuje tylko sekcję z przykładami użycia. Najszybszy sposób, żeby zobaczyć komendę w akcji.
  • -Detailed — opis plus szczegóły parametrów i przykłady. Złoty środek między skrótem a tasiemcem.
  • -Full — kompletna pomoc: wszystkie parametry, typy wejścia/wyjścia, uwagi. Dla momentów, gdy chcesz wiedzieć absolutnie wszystko.
  • -Online — otwiera oficjalną dokumentację online w przeglądarce zamiast wyświetlać tekst w konsoli.
  • -Parameter — wyświetla opis tylko jednego, konkretnego parametru. Akceptuje też * jako wzorzec.
  • -ShowWindow — otwiera pomoc w osobnym, przeszukiwalnym oknie GUI (tylko Windows PowerShell 5.1).
  • -Category — zawęża wyniki do kategorii, np. Cmdlet, Function, Alias.

Przykłady użycia

  • Get-Help Get-Process — podstawowy opis i składnia cmdletu do listowania procesów.
  • Get-Help Get-ChildItem -Examples — wyświetla same gotowe przykłady, jak używać odpowiednika ls/dir.
  • Get-Help Stop-Service -Full — pełna dokumentacja: wszystkie parametry, typy danych i uwagi.
  • Get-Help Invoke-WebRequest -Online — otwiera aktualną dokumentację w przeglądarce.
  • Get-Help about_Operators — wyświetla temat koncepcyjny (artykuły about_* opisują składnię języka, nie cmdlety).

Częste błędy i pułapki

Najczęstsza niespodzianka: po świeżej instalacji pomoc bywa szczątkowa, bo pełne pliki nie są dołączone domyślnie. Jeśli widzisz tylko skróconą wersję z linkiem, uruchom raz Update-Help (jako administrator), żeby pobrać komplet. W PowerShell 7+ część pomocy i tak ładuje się online.

Druga pułapka: -ShowWindow działa w Windows PowerShell 5.1, ale w PowerShell 7 na innych systemach został usunięty albo bywa niedostępny — nie licz na to okno wszędzie. Pamiętaj też, że help i man to aliasy, ale help dodatkowo stronicuje wynik (zatrzymuje się ekran po ekranie), podczas gdy goły Get-Help wypluwa wszystko naraz.

I jedno klasyczne potknięcie: Get-Help git nic sensownego nie pokaże, bo Get-Help opisuje komendy PowerShella, a nie zewnętrzne programy. Do tych ostatnich używaj ich własnego --help.

Powiązane komendy: Update-Help, Save-Help, Get-Command, Get-Member, help, man.