CmdID / PowerShell / Cmdlets / Get
Get-Help
Displays information about PowerShell commands and concepts. PowerShell reference
From the PowerShell reference 12 parameters 1 Sigma rule looks for it
What it does
Displays information about PowerShell commands and concepts. The Get-Help cmdlet displays information about PowerShell concepts and commands, including cmdlets, functions, Common Information Model (CIM) commands, workflows, providers, aliases, and scripts. To get help for a PowerShell cmdlet, type Get-Help followed by the cmdlet name, such as: Get-Help Get-Process. Conceptual help articles in PowerShell begin with about_, such as about_Comparison_Operators. To see all about_ articles, type Get-Help about_*. To see a particular article, type Get-Help about_<article-name>, such as Get-Help about_Comparison_Operators. To get help for a PowerShell provider, type Get-Help followed by the provider name. For example, to get help for the Certificate provider, type Get-Help Certificate. You can also type help or man, which displays one screen of text at a time. Or, <cmdlet-name> -?, that's identical to Get-Help, but only works for cmdlets. Get-Help gets the help content that it displays from help files on your computer. Without the help files, Get-Help displays only basic information about cmdlets. Some PowerShell modules include help files. Beginning in PowerShell 3.0, the modules that come with the Windows operating system don't include help files. To download or update the help files for a module in PowerShell 3.0, use the Update-Help cmdlet. You can also view the PowerShell help documents online. To get the online version of a help file, use the Online parameter, such as: Get-Help Get-Process -Online. If you type Get-Help followed by the exact name of a help article, or by a word unique to a help article, Get-Help displays the article's content. If you specify the exact name of a command alias, Get-Help displays the help for the original command. If you enter a word or word pattern that appears in several help article titles, Get-Help displays a list of the matching titles. If you enter any text that doesn't appear in any help article titles, Get-Help displays a list of articles that include that text in their contents. Get-Help can get help articles for all supported languages and locales. Get-Help first 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. …
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>]Get-Help [[-Name] <String>] [-Path <String>] [-Category <String[]>] [-Component <String[]>] [-Functionality <String[]>] [-Role <String[]>] -ShowWindow [<CommonParameters>]Display basic help information about a cmdlet
Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?IdentifyDisplay basic information one page at a time
help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -PagingIdentifyDisplay more information for a cmdlet
Get-Help Format-Table -Detailed
Get-Help Format-Table -FullIdentifyDisplay selected parts of a cmdlet by using parameters
Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupByIdentifyDisplay online version of help
Get-Help Format-Table -OnlineIdentifyDisplay help about the help system
Get-HelpIdentifyDisplay available help articles
Get-Help *IdentifyDisplay a list of conceptual articles
Get-Help about_*IdentifySearch for a word in cmdlet help
Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern ClixmlIdentifyDisplay a list of articles that include a word
Get-Help -Name remotingIdentifyIts page in the reference: Get-Help.
Parameters
-CategoryDisplays help only for items in the specified category and their aliases. Conceptual articles are in the HelpFile category.
The acceptable values for this parameter are as follows:
- Alias
- Cmdlet
- Provider
- General
- FAQ
- Glossary
- HelpFile
- ScriptCommand
- Function
- Filter
- ExternalScript
- All
- DefaultHelp
- Workflow
- DscResource
- Class
- Configuration-ComponentDisplays 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.-DetailedAdds parameter descriptions and examples to the basic help display. This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual (About_) help.-ExamplesDisplays only the name, synopsis, and examples. This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual (About_) help.-FullDisplays the entire help article for a cmdlet. Full includes parameter descriptions and attributes, examples, input and output object types, and additional notes.
This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual (About_) help.-FunctionalityDisplays 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.-NameGets help about the specified command or concept. Enter the name of a cmdlet, function, provider, script, or workflow, such as Get-Member, a conceptual article name, such as about_Objects, or an alias, such as ls. Wildcard characters are permitted in cmdlet and provider names, but you can't use wildcard characters to find the names of function help and script help articles.
To get help for a script that isn't located in a path that's listed in the $Env:PATH environment variable, type the script's path and file name.
If you enter the exact name of a help article, Get-Help displays the article contents.
If you enter a word or word pattern that appears in several help article titles, Get-Help displays a list of the matching titles.
If you enter any text that doesn't match any help article titles, Get-Help displays a list of articles that include that text in their contents.
The names of conceptual articles, such as about_Objects, must be entered in English, even in
non-English versions of PowerShell.-OnlineDisplays the online version of a help article in the default browser. This parameter is valid only for cmdlet, function, workflow, and script help articles. You can't use the Online parameter with Get-Help in a remote session.
For information about supporting this feature in help articles that you write, see about_Comment_Based_Help, and Supporting Online Help, and Writing Help for PowerShell Cmdlets.-ParameterDisplays only the detailed descriptions of the specified parameters. Wildcards are permitted. This parameter has no effect on displays of conceptual (About_) help.-PathGets help that explains how the cmdlet works in the specified provider path. Enter a PowerShell provider path.
This parameter gets a customized version of a cmdlet help article that explains how the cmdlet works in the specified 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 article 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 a
Get-Help command or, from any path location, use the Path parameter of Get-Help to specify
the provider path. You can also find custom cmdlet help online in the provider help section of the
help articles.
For more information about PowerShell providers, see about_Providers.
NOTE: The provider for the path specified must have a PowerShell provider help file installed. If no provider help file is available, no help information is returned. There are no provider help files available for the providers included with this version of PowerShell.-RoleDisplays 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.-ShowWindowDisplays the help topic in a window for easier reading. The window includes a Find search feature and a Settings box that lets you set options for the display, including options to display only selected sections of a help topic.
The ShowWindow parameter supports help topics for commands (cmdlets, functions, CIM commands, workflows, scripts) and conceptual About articles. It doesn't support provider help.
This parameter was introduced in PowerShell 3.0.