PowerShell Get-Help Parameter Discovery
Use Get-Help with the -Parameter switch to learn about a specific parameter of a CmdLet.
Get-Help Get-ChildItem -Parameter Filter
This returns a focused description of that parameter, including:
- What it does
- Required/optional status
- Position
- Default value
- Accepted value type
- Pipeline input support
Common help views
| Command | What it shows |
|---|---|
Get-Help CmdLetName |
Synopsis and syntax |
Get-Help CmdLetName -Parameter Name |
Single parameter details |
Get-Help CmdLetName -Detailed |
Parameters plus examples |
Get-Help CmdLetName -Full |
Complete help topic |
Get-Help CmdLetName -Examples |
Usage examples only |
Key point
The built-in PowerShell help system is updated daily, so it keeps pace with new CmdLets and changes to existing ones. It is the primary tool for discovering what a CmdLet (or one of its parameters) does. Related CmdLet discovery topics include Get-Member CmdLet, Select-Object, PowerShell ForEach-Object CmdLet, and Experimenting with PowerShell.