Il n’y a pas de cmdlets plus familiers pour les débutants et les experts que la commande d’aide PowerShell, Get-Help. En raison du système d’aide intégré et actualisable de PowerShell, la commande Get-Help de PowerShell est la manière dont vous découvrez ce que font les commandes, leurs paramètres, et même (espérons-le) de nombreux exemples utiles sur la manière d’utiliser la commande.
Chaque cmdlet et fonction que vous rencontrez est censé avoir un contenu d’aide intégré que la cmdlet PowerShell Get-Help peut lire. Je dis « censé » parce que malheureusement, certains auteurs n’incluent pas de contenu d’aide.
Le contenu d’aide associé aux commandes peut être trouvé en exécutant Get-Help. Cette commande lit à la fois l’aide basée sur des commentaires et basée sur XML qui est créée par l’auteur du cmdlet ou de la fonction.
L’utilisation la plus courante de la cmdlet Get-Help est de l’utiliser pour trouver le contenu d’aide d’une commande particulière. Par exemple, peut-être avez-vous découvert une nouvelle commande appelée Get-Content avec la cmdlet Get-Command et vous voulez en savoir plus à son sujet. Vous utiliseriez le paramètre Name sur Get-Help. Cela renverrait un ensemble d’informations de base sur cette commande, comme vous pouvez le voir ci-dessous.
Vous remarquerez que bien que beaucoup d’informations soient retournées, ce n’est qu’un résumé des choses que vous pouvez faire. Et vous ne sauriez jamais que Get-Help peut également renvoyer d’autres types de contenu d’aide comme des exemples.
Recherche d’informations sur les paramètres
Vous pouvez approfondir le contenu d’aide de plusieurs façons différentes. L’une de ces façons consiste à trouver des informations sur un seul paramètre d’une commande. Peut-être que dans l’exemple que j’utilise ici, je vois une référence à un paramètre Raw et je ne suis pas tout à fait sûr de ce que ce paramètre fait. Je peux utiliser le paramètre Parameter sur Get-Help avec le paramètre Name pour ne retourner que des informations sur ce paramètre de commande particulier.
PowerShell Get-Help et Exemples
Une des meilleures choses concernant le système d’aide PowerShell est qu’il prend en charge nativement les exemples. Les exemples sont un excellent moyen de voir, avec contexte, comment utiliser une commande particulière. Si l’auteur de la commande a ajouté des exemples à son contenu d’aide, vous pouvez voir ces exemples en utilisant le paramètre Examples. Lorsque vous utilisez ce paramètre, Get-Help renverra un ou plusieurs exemples de la façon dont cette commande est utilisée dans différentes circonstances.
Obtention d’une aide détaillée
Les résumés, les informations sur les paramètres et les exemples ne sont pas les seules informations retournées par la commande Get-Help de PowerShell. Parfois, vous avez besoin de voir toutes les informations disponibles pour une cmdlet. Dans ce cas, vous avez toujours les paramètres Detailed et Full disponibles. Chacun de ces paramètres affiche une quantité croissante d’informations.
Le paramètre Detailed ajoute des descriptions et des exemples de paramètres à l’affichage principal de l’aide. En essence, ils se combinent en utilisant le paramètre Examples et afficheront des informations pour tous les paramètres comme si vous aviez utilisé le paramètre Parameter sur tous les paramètres de commande.
Si le paramètre Detailed n’est pas suffisant, vous pouvez toujours adopter une approche radicale et obtenir tout le contenu d’aide avec le paramètre Full. Ce paramètre ne filtre aucune information. Le paramètre Full lit tout le contenu d’aide défini pour une commande particulière.
Obtenir une représentation graphique
Si vous souhaitez une représentation plus graphique de l’aide, vous pouvez également utiliser le paramètre ShowWindow. Ce paramètre ouvre une fenêtre qui vous permet de rechercher facilement le contenu d’aide et de ne montrer que certaines zones via le bouton Settings. Cette vue est utile si vous voulez vraiment explorer le contenu de l’aide.
Résumé
Il existe quelques autres paramètres moins courants que vous pouvez utiliser avec la commande PowerShell Get-Help. Si vous souhaitez en savoir plus, vous savez comment trouver des informations sur ces paramètres supplémentaires, n’est-ce pas ? Oui, Get-Help peut trouver du contenu d’aide sur lui-même.
Utilisez la commande Get-Help de manière régulière lorsque vous recherchez plus d’informations sur les commandes PowerShell. Il y a peu de besoin d’aller sur Google lorsque vous avez un système d’aide puissant et une commande pour vous aider à y accéder.