Découvrir une commande à l’aide du système d’aide
Le système d’aide intégré à PowerShell peut vous fournir les informations dont vous avez besoin pour comprendre une commande. Utilisez la cmdlet Get-Command pour rechercher une commande dont vous avez besoin. Après avoir trouvé la commande de votre choix, vous pouvez avoir besoin d’informations sur ses actions et les façons de l’appeler.
Découvrir les applets de commande en utilisant le système d’aide et la commande Get-Help
Vous pouvez utiliser l’applet de commande de base Get-Help pour en savoir plus sur la commande choisie. En général, vous appelez Get-Help en la spécifiant par son nom et en ajoutant l’indicateur -Name qui contient le nom de l’applet de commande sur laquelle vous voulez en savoir plus. Voici un exemple :
Get-Help -Name Get-Help
Mettre à jour l’aide
Les nouvelles versions de PowerShell n’incluent pas le système d’aide par défaut. La première fois que vous exécutez Get-Help, vous êtes invité à installer les fichiers d’aide. Vous pouvez également exécuter l’applet de commande Update-Help pour installer les fichiers d’aide. Comme un appel à Update-Help télécharge de nombreux fichiers d’aide, par défaut, la commande peut extraire l’aide une seule fois par jour. Vous pouvez remplacer ce comportement d’extraction en utilisant l’indicateur -Force.
Vous mettez à jour les fichiers d’aide sur Windows différemment de ce qu’il faut faire sur Linux ou macOS. Le processus diffère, car quand vous exécutez l’applet de commande Update-Help, les fichiers d’aide sont extraits via Internet en correspondance avec la culture de votre ordinateur. Sur Windows, une culture est déjà installée, mais elle est absente sur Linux et macOS. Vous devez donc spécifier une culture quand vous mettez à jour les fichiers d’aide sur Linux et macOS.
Voici un exemple de commande :
Update-Help -UICulture en-US -Verbose
Cette commande spécifie l’indicateur -UICulture. Il lui donne la valeur en-US, qui extrait les fichiers d’aide « US-English » (en anglais). Pour mettre à jour vos fichiers d’aide sur macOS ou Linux, utilisez une culture qui correspond à celle de votre ordinateur.
Explorer les sections d’aide
Quand vous appelez Get-Help sur une applet de commande, une page d’aide est retournée. La page comprend de nombreuses sections. Vous verrez probablement ces sections courantes :
- NOM : indique le nom de la commande.
- SYNTAXE : montre comment appeler la commande à l’aide d’une combinaison d’indicateurs, et parfois de paramètres autorisés.
- ALIASES : répertorie les alias d’une commande. Un alias est un nom différent pour une commande, et il peut être utilisé pour appeler la commande.
- REMARQUES : Fournit des informations sur les commandes à exécuter pour obtenir de l’aide supplémentaire pour cette commande.
- PARAMÈTRES : fournit des détails sur le paramètre. Elle liste son type, une description plus longue et les valeurs acceptables, le cas échéant.
Filtrer la réponse de l’aide
Si vous ne voulez pas afficher la page d’aide complète, vous pouvez affiner la réponse en ajoutant des indicateurs à votre commande Get-Help. Voici quelques indicateurs que vous pouvez utiliser :
- Complet : retourne une page d’aide détaillée. Il spécifie des informations comme les paramètres, les entrées et les sorties, que vous n’obtenez pas dans la réponse standard.
- Détaillé : retourne une réponse qui ressemble à la réponse standard, mais elle inclut une section pour les paramètres.
- Exemples : retourne uniquement des exemples, le cas échéant.
- En ligne : ouvre une page web pour votre commande.
- Paramètre : nécessite un nom de paramètre en tant qu’argument. Il liste les propriétés d’un paramètre spécifique.
Par exemple, vous pouvez utiliser la commande suivante pour retourner seulement la section Exemples de la page d’aide.
Get-Help Get-FileHash -Examples
Améliorer l’expérience de lecture
Exécuter Get-Help retourne la totalité de la page d’aide. Cette page risque de ne pas fournir la meilleure expérience de lecture. Vous devrez peut-être la faire défiler pour trouver la section que vous souhaitez lire. Une meilleure approche consiste à utiliser l’alias help. L’alias help envoie le résultat de Get-Help dans une fonction qui permet la lecture ligne par ligne de votre sortie. Il permet aussi la lecture de la réponse page par page en paginant la sortie. Vous allez utiliser l’alias help dans l’unité suivante.