Get-Help în PowerShell

Get-Help [-Name] <String> [-Examples | -Detailed | -Full | -Online | -Parameter <String[]>]
Update-Help [-Module <String[]>] [-UICulture <CultureInfo[]>] [-Force]

Ce face Get-Help

Get-Help este primul cmdlet pe care merită să-l știi: îi dai numele unei comenzi (Get-Help Get-ChildItem) sau al unui articol conceptual (Get-Help about_Comparison_Operators) și îți arată descrierea, sintaxa și, dacă cer, exemplele. Variantele scurte sunt help Get-ChildItem (afișează pagină cu pagină) și Get-ChildItem -?, care merge doar pentru cmdlet-uri.

PowerShell nu vine cu fișierele complete de ajutor. Fără ele, Get-Help afișează doar un ajutor generat automat (sintaxa). Le descarci o dată cu Update-Help (apărut în Windows PowerShell 3.0). Din PowerShell 6.1, Update-Help instalează implicit pentru utilizatorul curent (-Scope CurrentUser), deci nu mai cere drepturi de administrator; fără -Force rulează cel mult o dată la 24 de ore. Ajutorul este publicat în engleză (en-US), așa că pe un sistem în română folosește Update-Help -UICulture en-US.

Când nu vrei tot articolul, alege o parte: -Examples arată doar numele, rezumatul și exemplele, -Parameter Recurse descrie un singur parametru, iar -Online deschide pagina de pe learn.microsoft.com în browser (merge și fără fișiere de ajutor instalate). Numele articolelor about_* se scriu în engleză, indiferent de limba sistemului.

Parametri

Parametru	Descriere
-Name	Comanda, aliasul sau articolul about_* căutat. Parametru pozițional: Get-Help Get-Process. Acceptă wildcard (Get-Help about_*).
-Examples	Afișează doar numele, rezumatul și exemplele comenzii.
-Detailed	Adaugă descrierile parametrilor și exemplele.
-Full	Articolul complet: parametri cu atribute, exemple, tipuri de intrare și ieșire, note.
-Parameter	Descrie doar parametrii ceruți; -Parameter * îi descrie pe toți.
-Online	Deschide versiunea online a articolului în browserul implicit.
-ShowWindow	Afișează ajutorul într-o fereastră separată, cu căutare. Doar pe Windows (readus în PowerShell 7.0).
Update-Help -Module	Actualizează ajutorul doar pentru modulele indicate (acceptă wildcard).
Update-Help -UICulture	Limba fișierelor de ajutor descărcate, de exemplu en-US.
Update-Help -Force	Ignoră limita de o rulare pe zi și verificarea versiunii.

Ce returnează

Un obiect de ajutor (MamlCommandHelpInfo când există fișier de ajutor) sau text pentru articolele about_*. Update-Help nu returnează nimic; cu -Verbose afișează ce a actualizat.

Exemple

Exemplul 1: Descarci ajutorul și citești rezumatul unui cmdlet

Update-Help nu afișează nimic dacă reușește. După el, proprietatea Synopsis conține rezumatul din documentație.

Update-Help -UICulture en-US
(Get-Help Get-Date).Synopsis

Ieșire în terminal

Gets the current date and time.

Exemplul 2: Documentația online, în browser

Comanda deschide pagina lui Get-ChildItem de pe learn.microsoft.com în browserul implicit și nu scrie nimic în terminal. Pentru exemple direct în consolă, folosește Get-Help Get-ChildItem -Examples.

Get-Help Get-ChildItem -Online

Greșeli frecvente

• Să tragi concluzia că un cmdlet nu are exemple când Get-Help arată doar sintaxa: de cele mai multe ori nu ai rulat Update-Help. Rulează-l sau folosește -Online.
• Pe un Windows în română, Update-Help fără -UICulture en-US poate eșua cu un mesaj că limba nu este suportată, pentru că ajutorul se publică în engleză.
• Să scrii numele articolelor conceptuale în română sau fără prefix: corect este Get-Help about_If, nu Get-Help if.
• Să folosești -ShowWindow pe macOS sau Linux: parametrul există doar pe Windows.

Comenzi înrudite

• Get-Command: Găsește comenzile disponibile (cmdlet-uri, funcții, aliasuri, programe); Get-Alias arată ce comandă se ascunde în spatele unui alias.
• Get-Member: Arată tipul obiectelor dintr-un pipeline și ce proprietăți și metode au, ca să știi ce poți selecta, filtra sau apela.
• $PROFILE: Variabila $PROFILE conține calea scriptului care rulează la fiecare pornire a PowerShell, unde îți pui aliasurile și funcțiile.