Skip to content

GetHelp

The Get-Help cmdlet is a powerful tool in PowerShell that provides information about commands, cmdlets, and modules. It has several parameters that allow you to customize the help output to suit your needs. Here are some of the most common parameters for the Get-Help cmdlet with examples:

1. -Name

This parameter specifies the name of the command or cmdlet that you want help with. For example: 

Get-Help -Name Get-ChildItem
This command will display help for the Get-ChildItem cmdlet, which is used to list the contents of a directory.

2. -Category

This parameter specifies the category of help that you want to display. For example: 

Get-Help -Category Navigation
This command will display all cmdlets related to navigation.

3. -Detailed

This parameter displays detailed help information, including examples and parameter descriptions. For example: 

Get-Help -Name Get-ChildItem -Detailed
This command will display detailed help information for the Get-ChildItem cmdlet.

4. -Examples

This parameter displays examples of how to use the command or cmdlet. For example: 

Get-Help -Name Get-ChildItem -Examples
This command will display examples of how to use the Get-ChildItem cmdlet.

5. -Full

This parameter displays the full help information, including syntax and parameter descriptions. For example: 

Get-Help -Name Get-ChildItem -Full
This command will display the full help information for the Get-ChildItem cmdlet.

6. -Parameter

This parameter displays help information for a specific parameter of a command or cmdlet. For example: 

Get-Help -Name Get-ChildItem -Parameter Path
This command will display help information for the Path parameter of the Get-ChildItem cmdlet.

7. -Online

This parameter opens the online version of the help file for the command or cmdlet. For example:

```
Get-Help -Name Get-ChildItem -Online
```
This command will open the online version of the help file for the Get-ChildItem cmdlet.

In summary, the Get-Help cmdlet is a versatile tool that can provide a lot of information about commands, cmdlets, and modules in PowerShell. By using the appropriate parameters, you can customize the help output to suit your needs and become more proficient in PowerShell.