2023-10-25 10:00:02 +01:00
|
|
|
# Get-Help
|
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
> Display help information and documentation for PowerShell commands (aliases, cmdlets, and functions).
|
2023-10-25 10:00:02 +01:00
|
|
|
> This command can only be run through PowerShell.
|
|
|
|
> More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-help>.
|
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
- Display general help information for a specific PowerShell command:
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
`Get-Help {{command}}`
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
- Display a more detailed documentation for a specific PowerShell command:
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
`Get-Help {{command}} -Detailed`
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
- Display the full technical documentation for a specific PowerShell command:
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
`Get-Help {{command}} -Full`
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
- Print only the documentation for a specific parameter of the PowerShell command (use `*` to show all parameters), if available:
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
`Get-Help {{command}} -Parameter {{parameter}}`
|
2023-10-25 10:00:02 +01:00
|
|
|
|
|
|
|
- Print only the examples of the cmdlet, if available:
|
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
`Get-Help {{command}} -Examples`
|
2023-10-25 10:00:02 +01:00
|
|
|
|
|
|
|
- List all available cmdlet help pages:
|
|
|
|
|
|
|
|
`Get-Help *`
|
|
|
|
|
|
|
|
- Update the current help and documentation knowledge base using `Update-Help`:
|
|
|
|
|
|
|
|
`Update-Help`
|
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
- View an online version of PowerShell command documentation in the default web browser:
|
2023-10-25 10:00:02 +01:00
|
|
|
|
2023-11-30 07:09:50 +00:00
|
|
|
`Get-Help {{command}} -Online`
|