Comment obtenir l’aide sur PowerShell

Pour pouvoir utiliser pleinement PowerShell, il faut être capable de trouver l’aide d’une commande ou cmdlet quand on en a besoin.
Pour vous y aider, la commande Get-Help mais aussi une documentation en ligne de Microsoft.

Dans ce tutoriel, je vous explique comment obtenir l’aide sur PowerShell.

Comment obtenir l’aide sur PowerShell avec Get-Help

La commande Get-Help fournit l’aide sur les commandes PowerShell.
L’aide de Windows PowerShell décrit les applets de commande, les fonctions, les scripts et les modules Windows PowerShell. Elle explique les concepts tels que les éléments du langage Windows PowerShell

Pour obtenir de l’aide sur une applet de commande, tapez :

Get-Help <commande>

L’alias de la commande est help, donc vous pouvez l’utiliser à la place :

help <nom-applet_commande>

Par exemple pour obtenir l’aide de la commande Get-Help :

Get-Help Get-Process

Celle-ci affiche alors mes rubriques suivantes :

• Nom : Le nom de l’applet/cmdlet
• Résumé : Un résumé très succinct de la commande
• Syntaxe : Des exemples d’utilisation de la commande
• Description : Un description assez complet de la commande
• Liens connexes : D’autres commandes en liens avec la commande et une URL vers la documentation en ligne de Microsoft
• Remarques : Des remarques supplémentaires

Afficher des exemples d’utilisation d’une commande Powershell

Pour obtenir des exemples d’utilisation d’une applet, ajoutez le paramètre -examples :

Get-Help <commande> -examples

Par exemple, pour afficher des exemples d’utilisation de la commande Get-Process :

get-help Get-Process -examples

Afficher l’aide complète d’une commande PowerShell

Il existes des fichiers d’aides plus complètes que vous pouvez obtenir à l’aide des paramètres -detailed et -full :

Get-Help <commande> -Detailed
Get-Help <commande> -Full

Voici les grandes différences :

• Le paramètre Detailed affiche la vue détaillée de l’article d’aide qui inclut des descriptions de paramètres et des exemples
• Le paramètre Full affiche la vue complète de l’article d’aide qui inclut des descriptions de paramètres, des exemples, des types d’objets d’entrée et de sortie, ainsi que des notes supplémentaires

Ouvrir l’aide en ligne d’une commande

Pour obtenir de l’aide en ligne, tapez :

Get-Help <commande> -Online

Par exemple pour ouvrir l’aide en ligne de la commande Get-Process :

Get-Help Get-Process -Online

Le navigateur internet s’ouvre sur la rubrique d’aide de la commande PowerShell.

Faire une recherche dans l’aide

Enfin our rechercher un mot ou une expression dans l’ensemble des fichiers d’aide, tapez :

Get-Help <terme-recherché>

Comment mettre à jour l’aide de Powershell

La commande Update-Help permet de télécharger les fichiers d’aide mis à jour dès qu’ils sont disponibles, de sorte que le contenu de votre aide locale n’est jamais obsolète.

Saisissez simplement la commande pour télécharger la dernière version de l’aide de Powershell.

Update-Help

Comment obtenir la liste des commandes Powershell avec l’aide et description

Vous pouvez aussi afficher la liste complètes des cmdlet, Alias et fonctions PowerShell à l’aide de la commande Get-Command.

Get-Command

Utilisez le paramètre -Type pour lister que les Cmdlet ou que les fonctions :

Get-Command -Type Cmdlet
Get-Command -Type Function
Get-Command -Type Alias

Enfin pour recherche des cmdlet, Alias ou fonctions sur un terme :

Get-Command  <terme-recherché>

Par exemple pour afficher tous les types de commandes contenant le mot Package dans le nom ou la description :

Get-Command Package

Enfin pour exporter la liste des commandes PowerShell vers un fichier CSV :

Get-Command | Export-CSV C:\Users\$env:UserName\Desktop\Commandes.csv

La liste des commandes PowerShell

Liens

• Qu’est-ce que PowerShell sur Windows 10, 11 : exemple de commandes
• PowerShell et CMD (invite de commandes) : les différences
• 14 commandes PowerShell de base pour apprendre et débuter
• La liste des commandes PowerShell
• Les virus ou trojan PowerShell
• Comment exécuter un script PowerShell
• Exécution script désactivée PowerShell : Autoriser l’exécution de Scripts dans PowerShell
• Créer, supprimer, formater des partitions de disque en PowerShell
• Ajouter, supprimer et modifier des comptes utilisateurs et des groupes locaux avec PowerShell
• Comment créer une tâche planifiée en PowerShell
• Configurer les tâches planifiées en PowerShell
• Comment gérer Windows Defender avec PowerShell
• Comment copier ou déplacer des fichiers avec PowerShell
• PowerShell : gérer les partages réseaux et de dossiers de Windows 10
• Les commandes réseaux PowerShell sur Windows 10, 11
• Gérer les services Windows en PowerShell
• PowerShell : supprimer un fichier avec 10 exemples
• Powershell : tester l’existence fichier
• PowerShell : rechercher une chaîne de caractères avec Select-String
• Comment mettre à jour PowerShell sur Windows
• Comment obtenir de l’aide de Windows 10/11 : 5 méthodes

Source(s) : https://learn.microsoft.com/fr-fr/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.3

L’article Comment obtenir l’aide sur PowerShell est apparu en premier sur malekal.com.