PowerShell Genie

Get-Help

Look up syntax, parameters and examples for a PowerShell command. Use the help output to understand a command before running it.

Command 1 min read Windows PowerShell 5.1 and PowerShell 7

Documentation: Microsoft Learn — get-help

Written and tested by Dhrub Bharali · Updated

Syntax

1PS> Get-Help [[-Name] <string>] [-Full | -Detailed | -Examples | -Parameter <String> | -Online | -ShowWindow] [<CommonParameters>]
See the command anatomy

Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.

Get-Help [[-Name] <string>] [-Full | -Detailed | -Examples | -Parameter <String> | -Online | -ShowWindow] [<CommonParameters>]
  1. Stage 1Get-Help-Name -Full
  2. Stage 2-Detailed-Detailed
  3. Stage 3-Examples-Examples
  4. Stage 4-Parameter-Parameter
  5. Stage 5-Online-Online
  6. Stage 6-ShowWindow]-ShowWindow

    Try it

    Windows PowerShell

    PowerShell example · browser support is limited.

    Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.

    Interactive simulation · fictional data

    Examples

    Read examples for a command

    1PS> Get-Help Get-Service -Examples
    Show reference output

    Illustrative output · values vary by environment

    Example command to look for in installed help:
Get-Service

Lists service objects. The complete help text depends on the installed version and help files.

    Get-Help -Examples

    1PS> Get-Help Get-Process -Examples
    Show reference output

    Illustrative output · values vary by environment

    Example command to look for in installed help:
Get-Process

Returns running process objects. Read the local help for the examples shipped with your version.

    Get-Help -Online

    1PS> Get-Help about_Objects -Online
    Show reference output

    Illustrative output · values vary by environment

    Opens the online documentation in your browser.
No objects are returned to the pipeline.

    Parameters

    Parameter definitions:

    • -Name
    • -Full

    Microsoft Learn — get-help

    Use help for the command you actually have

    Start with Get-Help CommandName -Examples for usage, then use -Full for detailed help or -Parameter Name for one parameter. Help describes a command; it does not run the example.

    Missing help is not a missing command

    Local help files may not be installed or current. Use Update-Help where supported and allowed, or -Online to open the published reference. Online help opens a browser rather than returning example objects.

    Check the version

    Read the help for the module and PowerShell version installed on the target. A parameter documented for a newer release may not exist locally. Use Get-Command CommandName -Syntax to inspect the syntax exposed by that installation.

    Names beginning with about_ are conceptual help topics. They are read with Get-Help, not executed as commands.

    Inspect installed command syntax

    Updated 1 October 2026. Browser outputs are fictional; check the installed module help for your environment.

    Put this command to work

    Read command help

    Read the syntax help for Get-Service.

    Review the lesson

    Recap

    Get-Help Look up syntax, parameters and examples for a PowerShell command. Use the help output to understand a command before running it.

    Next: PowerShell command reference
    Genie guideGet-Help

    Look up syntax, parameters and examples for a PowerShell command. Use the help output to understand a command before running it. The console below is pre-loaded — run it, then change a value and run it again.

    Explore PowerShell Genie

    Related