Get-Help

Displays information about Windows PowerShell commands and concepts.

Get-Help [[-Name] String] [-Path String] [-Category String[]] [-Component String[]] [-Functionality String[]] [-Role String[]] [-Full] [CommonParameters]

Get-Help [[-Name] String] [-Path String] [-Category String[]] [-Component String[]] [-Functionality String[]] [-Role String[]] [-Detailed] [CommonParameters]

Get-Help [[-Name] String] [-Path String] [-Category String[]] [-Component String[]] [-Functionality String[]] [-Role String[]] [-Examples] [CommonParameters]

Get-Help [[-Name] String] [-Path String] [-Category String[]] [-Component String[]] [-Functionality String[]] [-Role String[]] -Parameter String [CommonParameters]

Get-Help [[-Name] String] [-Path String] [-Category String[]] [-Component String[]] [-Functionality String[]] [-Role String[]] [-Online] [CommonParameters]

TheGet-Helpcmdlet displays information about PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts.

To get help for a PowerShell command, typeGet-Helpfollowed by the command name, such as:Get-Help Get-Process.

Conceptual help topics in PowerShell begin with about_, such as about_Comparison_Operators. To see all about_ topics, typeGet-Help about_*. To see a particular topic, typeGet-Help about_topic-name, such asGet-Help about_Comparison_Operators.

To get help for a PowerShell provider, typeGet-Helpfollowed by the provider name. For example, to get help for the Certificate provider, typeGet-Help Certificate.

In addition toGet-Help, you can also typehelporman, which displays one screen of text at a time, orcmdlet-name -?, which is identical toGet-Helpbut works only for commands.

Get-Helpgets the help content that it displays from help files on your computer. Without the help files,Get-Helpdisplays only basic information about commands. Some PowerShell modules come with help files. However, starting in Windows PowerShell 3.0, the modules that come with the Windows operating system do not include help files. To download or update the help files for a module in Windows PowerShell 3.0, use theUpdate-Helpcmdlet.

You can also view the help topics for PowerShell online in the Microsoft Docs. To get the online version of a help topic, use theOnlineparameter, such as:Get-Help Get-Process -Online. To read all of the help topics, seePowerShell Documentationin the Microsoft Docs.

If you typeGet-Helpfollowed by the exact name of a help topic, or by a word unique to a help topic,Get-Helpdisplays the topic contents. If you enter a word or word pattern that appears in several help topic titles,Get-Helpdisplays a list of the matching titles. If you enter a word that does not appear in any help topic titles,Get-Helpdisplays a list of topics that include that word in their contents.

Get-Helpcan get help topics for all supported languages and locales.Get-Helpfirst looks for help files in the locale set for Windows, then in the parent locale, such as pt for pt-BR, and then in a fallback locale. Beginning in Windows PowerShell 3.0, ifGet-Helpdoes not find help in the fallback locale, it looks for help topics in English, en-US, before it returns an error message or displaying auto-generated help.

For information about the symbols thatGet-Helpdisplays in the command syntax diagram, seeabout_Command_Syntax. For information about parameter attributes, such asRequiredandPosition, seeabout_Parameters.

TROUBLESHOOTING NOTE: In Windows PowerShell 3.0 and Windows PowerShell 4.0,Get-Helpcannot find About topics in modules unless the module is imported into the current session. This is a known issue. To get About topics in a module, import the module, either by using the Import-Module cmdlet or by running a cmdlet in the module.

Example 1: Display basic information about a command

These commands display basic information about theFormat-Tablecmdlet.

Get-Help nameis the simplest and default syntax ofGet-Helpcmdlet. You can omit the parameter name (Name).

command-name -?works only for commands.

Example 2: Display basic information one page at a time

These commands display basic information about theFormat-Tablecmdlet one page at a time.

Thehelpis a function that runsGet-Helpcmdlet internally and displays the result one page at a time.

Themanis an alias for thehelpfunction.

TheOut-Host -Pagingreceives the outputs ofGet-Help Format-Tablefrom pipeline and displays them one page at a time. For more information, seeOut-Host.

Example 3: Display more information for a cmdlet

These commands display more information about theFormat-Tablecmdlet than usual.

TheDetailedparameter displays the detailed view of the help topic, which includes parameter descriptions and examples.

TheFullparameter displays the full view of the help topic, which includes parameter descriptions, examples, input and output object types, and additional notes.

TheDetailedandFullparameters are effective only for the commands whose help files are installed on the computer. They are not effective for the conceptual (about_) help topics.

Example 4: Display selected parts of a cmdlet by using parameters

These commands display selected parts of theFormat-Tablecmdlet help.

TheExamplesparameter displays only the NAME, SYNOPSIS, and all Examples. You can not specify an Example number because theExamplesparameter is a switch parameter.

TheParameterparameter displays only the descriptions of the specified parameters. If you specify only the wildcard character (*), it displays the descriptions of all parameters.

These parameters are not effective for the conceptual (about_) help topics.

Example 5: Display online version of help

This command displays the online version of the help topic for theFormat-Tablecmdlet in your default web browser.

Example 6: Display help about the help system

TheGet-Helpcmdlet without parameters displays information about the PowerShell help system.

Example 7: Display available help topics

This command displays a list of all help topics available on your system.

Example 8: Display a list of conceptual topics

This command displays a list of the conceptual topics included in Windows PowerShell help. All of these topics begin with the characters about_. To display a particular help file, type get-help topic-name, for example,Get-Help about_Signing.

This command displays the conceptual topics only when the help files for those topics are installed on the computer. For information about downloading and installing help files in Windows PowerShell 3.0, see Update-Help.

Example 9: Search for a word in cmdlet help

This example shows how to search for a word in particular cmdlet help topic. This command searches for the word Clixml in the full version of the help topic for the Add-Member cmdlet.

Because theGet-Helpcmdlet generates aMamlCommandHelpInfoobject, not a string, you have to use a cmdlet that transforms the help topic content into a string, such as Out-String or Out-File.

Example 10: Display a list of topics that include a word

This command displays a list of topics that include the word remoting.

When you enter a word that does not appear in any topic title,Get-Helpdisplays a list of topics that include that word.

Example 11: Display provider specific help

The first command uses the *Path* parameter of **Get-Help** to specify the provider path. This command can be entered at any path location. PS C:\ Get-Help Get-Item -Path SQLSERVER:\DataCollection NAME Get-Item SYNOPSIS Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection. … The second command uses the Set-Location cmdlet (alias = cd) to navigate to the provider path. From that location, even without the *Path* parameter, the **Get-Help** command gets the provider-specific help for the **Get-Item** cmdlet. PS C:\ cd SQLSERVER:\DataCollection SQLSERVER:\DataCollection Get-Help Get-Item NAME Get-Item SYNOPSIS Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection. … The third command shows that a **Get-Help** command in a file system path, and without the *Path* parameter, gets the standard help for the **Get-Item** cmdlet. PS C:\ Get-Item NAME Get-Item SYNOPSIS Gets the item at the specified location. …

This example shows how to get help that explains how to use the Get-Item cmdlet in theDataCollectionnode of the Windows PowerShellSQL Server provider. The example shows two ways of getting the provider-specific help forGet-Item.

You can also get provider-specific help for cmdlets online in the section that describes the provider. For example, for provider-specific online help for theNew-Itemcmdlet in each WSMan provider path, see New-Item for ClientCertificate in the TechNet library.

Example 12: Display help for a script

This command gets help for the MyScript.ps1 script. For information about how to write help for your functions and scripts, see about_Comment_Based_Help.

Adds parameter descriptions and examples to the basic help display.

This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual (About_) help.

Displays only the name, synopsis, and examples. To display only the examples, type(Get-Help \cmdlet-name\).Examples.

This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual (About_) help.

Displays the online version of a help topic in the default Internet browser. This parameter is valid only for cmdlet, function, workflow and script help topics. You cannot use theOnlineparameter inGet-Helpcommands in a remote session.

For information about supporting this feature in help topics that you write, see about_Comment_Based_Help ( and Supporting Online Help ( andHow to Write Cmdlet Helpin the MSDN library.

Displays only the detailed descriptions of the specified parameters. Wildcards are permitted.

This parameter has no effect on displays of conceptual (About_) help.

Displays help only for items in the specified category and their aliases. The acceptable values for this parameter are:

Conceptual topics are in the HelpFile category.

Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration

Displays commands with the specified component value, such as Exchange. Enter a component name. Wildcard characters are permitted.

This parameter has no effect on displays of conceptual (About_) help.

Displays the whole help topic for a cmdlet. This includes parameter descriptions and attributes, examples, input and output object types, and additional notes.

This parameter is effective only when help files are for the command are installed on the computer. It has no effect on displays of conceptual (About_) help.

Displays help for items with the specified functionality. Enter the functionality. Wildcard characters are permitted.

This parameter has no effect on displays of conceptual (About_) help.

Gets help about the specified command or concept. Enter the name of a cmdlet, function, provider, script, or workflow, such asGet-Member, a conceptual topic name, such asabout_Objects, or an alias, such asls. Wildcard characters are permitted in cmdlet and provider names, but you cannot use wildcard characters to find the names of function help and script help topics.

To get help for a script that is not located in a path that is listed in the Path environment variable, type the path and file name of the script.

If you enter the exact name of a help topic,Get-Helpdisplays the topic contents. If you enter a word or word pattern that appears in several help topic titles,Get-Helpdisplays a list of the matching titles. If you enter a word that does not match any help topic titles,Get-Helpdisplays a list of topics that include that word in their contents.

The names of conceptual topics, such asabout_Objects, must be entered in English, even in non-English versions of Windows PowerShell.

Gets help that explains how the cmdlet works in the specified provider path. Enter a Windows PowerShell provider path.

This parameter gets a customized version of a cmdlet help topic that explains how the cmdlet works in the specified Windows PowerShell provider path. This parameter is effective only for help about a provider cmdlet and only when the provider includes a custom version of the provider cmdlet help topic in its help file. To use this parameter, install the help file for the module that includes the provider.

To see the custom cmdlet help for a provider path, go to the provider path location and enter aGet-Helpcommand or, from any path location, use thePathparameter ofGet-Helpto specify the provider path. You can also find custom cmdlet help online in the provider help section of the help topics. For example, you can find help for theNew-Itemcmdlet in the Wsman:*\ClientCertificate path (

For more information about Windows PowerShell providers, seeabout_Providers.

Displays help customized for the specified user role. Enter a role. Wildcard characters are permitted.

Enter the role that the user plays in an organization. Some cmdlets display different text in their help files based on the value of this parameter. This parameter has no effect on help for the core cmdlets.

You cannot pipe objects to this cmdlet.

If you runGet-Helpon a command that does not have a help file,Get-Helpreturns an ExtendedCmdletHelpInfo object that represents autogenerated help.

If you get a conceptual help topic,Get-Helpreturns it as a string.

If you get a command that has a help file,Get-Helpreturns aMamlCommandHelpInfoobject.

Windows PowerShell 3.0 does not include help files. To download and install the help files thatGet-Helpreads, use theUpdate-Helpcmdlet. You can use theUpdate-Helpcmdlet to download and install help files for the core commands that come with Windows PowerShell and for any modules that you install. You can also use it to update the help files so that the help on your computer is never outdated.

You can also read the help topics about the commands that come with Windows PowerShell online starting at Scripting with Windows PowerShell (

Get-Helpdisplays help in the locale set for the Windows operating system or in the fallback language for that locale. If you do not have help files for the primary or fallback locale,Get-Helpbehaves as if there are no help files on the computer. To get help for a different locale, use Region and Language in Control Panel to change the settings.

The full view of help includes a table of information about the parameters. The table includes the following fields:

Required. Indicates whether the parameter is required (true) or optional (false).

Position. Indicates whether the parameter is named or positional (numbered). Positional parameters must appear in a specified place in the command.

—- Named indicates that the parameter name is required, but that the parameter can appear anywhere in the command.

—- Number indicates that the parameter name is optional, but when the name is omitted, the parameter must be in the place specified by the number. For example, 2 indicates that when the parameter name is omitted, the parameter must be the second (2) or only unnamed parameter in the command. When the parameter name is used, the parameter can appear anywhere in the command.

Default value. The parameter value that Windows PowerShell uses if you do not include the parameter in the command.

Accepts pipeline input. Indicates whether you can (true) or cannot (false) send objects to the parameter through a pipeline. By Property Name means that the pipelined object must have a property that has the same name as the parameter name.

Accepts wildcard characters. Indicates whether the value of a parameter can include wildcard characters, such as * and ?.

The feedback system for this content will be changing soon. Old comments will not be carried over. If content within a comment thread is important to you, please save a copy. For more information on the upcoming change,we invite you to read our blog post.