Er zijn geen cmdlets die zowel nieuwkomers als experts meer vertrouwd zijn dan het PowerShell Help Command, Get-Help. Dankzij het geïntegreerde en bij te werken help-systeem van PowerShell is het PowerShell Get-Help-commando de manier om te ontdekken wat commando’s doen, hun parameters en zelfs (hopelijk) veel nuttige voorbeelden van hoe het commando te gebruiken.
Elke cmdlet en functie waarmee je te maken krijgt, zou verondersteld worden geleverd met bijbehorende helptekst die het PowerShell Get-Help-cmdlet kan lezen. Ik zeg “verondersteld te” omdat helaas sommige auteurs geen helptekst toevoegen.
Helpteksten die zijn gekoppeld aan commando’s kunnen worden gevonden door Get-Help uit te voeren. Dit commando leest zowel commentaar-gebaseerde als XML-gebaseerde help die is gemaakt door de auteur van het cmdlet of de functie.
De meest gebruikelijke toepassing van het Get-Help-cmdlet is om het te gebruiken om helpteksten voor een specifiek commando te vinden. Bijvoorbeeld, stel dat je een nieuw commando genaamd Get-Content hebt ontdekt met behulp van het Get-Command-cmdlet en meer informatie erover wilt weten. Je zou de Name-parameter op Get-Help gebruiken. Dit zou een basis set informatie over dat commando opleveren, zoals je hieronder kunt zien.
Je zult merken dat hoewel er veel informatie wordt teruggegeven, het slechts een samenvatting is van dingen die je kunt doen. En je zou nooit weten dat Get-Help ook andere soorten helpinhoud kan retourneren, zoals voorbeelden.
Parameterinformatie vinden
Je kunt verder in de helpinhoud duiken op een paar verschillende manieren. Een van die manieren is het vinden van informatie over een enkele parameter van een opdracht. Misschien zie ik in het voorbeeld dat ik hier gebruik een verwijzing naar een Raw-parameter en weet ik niet helemaal zeker wat die parameter doet. Ik kan de Parameter-parameter op Get-Help gebruiken met de Name-parameter om alleen informatie terug te krijgen over die specifieke opdrachtparameter.
PowerShell Get-Help en Voorbeelden
Een van de beste dingen van het PowerShell-helpsysteem is dat het native ondersteuning heeft voor voorbeelden. Voorbeelden zijn een uitstekende manier om, met context, te zien hoe je een bepaalde opdracht moet gebruiken. Als de auteur van de opdracht voorbeelden heeft toegevoegd aan de helpinhoud, kun je die voorbeelden zien door de Voorbeelden-parameter te gebruiken. Wanneer je deze parameter gebruikt, zal Get-Help een of meer voorbeelden retourneren van hoe die opdracht in verschillende omstandigheden wordt gebruikt.
Gedetailleerde Help ophalen
Samenvattingen, parameterinformatie en voorbeelden zijn niet de enige informatie die wordt teruggegeven door het PowerShell Get-Help-commando. Soms moet je alle beschikbare informatie voor een cmdlet zien. In dat geval heb je altijd de Gedetailleerd en Volledig-parameters beschikbaar. Elk van deze parameters toont een toenemende hoeveelheid informatie.
De parameter Detailed voegt parameterbeschrijvingen en voorbeelden toe aan de primaire helptekst. In essentie combineren ze het gebruik van de Voorbeelden-parameter en tonen ze informatie voor alle parameters alsof je de Parameter-parameter op alle commandoparameters zou hebben gebruikt.
Als de Detailed-parameter niet genoeg is, kun je altijd de nucleaire aanpak kiezen en alle helptekst retourneren met de Volledig-parameter. Deze parameter filtert helemaal geen informatie. De Volledig-parameter leest alle helptekst die is gedefinieerd voor een bepaald commando.
Graphical krijgen
Als je een meer grafische weergave van de hulp wilt, kun je ook de ShowWindow-parameter gebruiken. Deze parameter opent een venster waarmee je eenvoudig de helptekst kunt doorzoeken en alleen bepaalde gebieden kunt tonen via de Instellingen-knop. Deze weergave is handig als je echt op zoek wilt gaan naar helptekst.
Samenvatting
Er zijn nog een paar andere, minder gebruikelijke parameters die je kunt gebruiken met het PowerShell Get-Help-commando. Als je meer wilt weten, weet je hoe je informatie kunt vinden over die aanvullende parameters, toch? Ja, Get-Help kan helptekst over zichzelf vinden.
Gebruik het Get-Help-commando consequent bij het zoeken naar meer informatie over PowerShell-commando’s. Er is weinig reden om naar Google te gaan als je een krachtig hulpsysteem hebt en een commando om je erin te verdiepen.