Get-Help

参考

模块:: Microsoft.PowerShell.Core

显示有关 PowerShell 命令和概念的信息。

语法

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

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

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

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

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

说明

该 Get-Help cmdlet 显示有关 PowerShell 概念和命令的信息，包括 cmdlet、函数、通用信息模型 (CIM) 命令、工作流、提供程序、别名和脚本。

若要获取有关 PowerShell cmdlet 的帮助，请键入 Get-Help 后跟 cmdlet 名称，例如： Get-Help Get-Process。

PowerShell 中的概念帮助文章从 about_开始，例如 about_Comparison_Operators。若要查看所有 about_ 文章，请键入 Get-Help about_*。若要查看特定项目，请键入 Get-Help about_<article-name>，例如 Get-Help about_Comparison_Operators。

若要获取有关 PowerShell 提供程序的帮助，请键入 Get-Help ，后跟提供程序名称。例如，若要获取有关证书提供程序的帮助，请键入 Get-Help Certificate。

还可以键入 help 或 man，一次显示一个文本屏幕。或者， <cmdlet-name> -?它与 Get-Help相同，但仅适用于 cmdlet。

Get-Help 从计算机上的帮助文件中获取它显示的帮助内容。如果没有帮助文件， Get-Help 则仅显示有关 cmdlet 的基本信息。某些 PowerShell 模块包括帮助文件。从 PowerShell 3.0 开始，Windows 操作系统附带的模块不包含帮助文件。若要在 PowerShell 3.0 中下载或更新模块的帮助文件，请使用 Update-Help cmdlet。

还可以在Microsoft Docs中联机查看 PowerShell 帮助文档。若要获取帮助文件的联机版本，请使用 Online 参数，例如：Get-Help Get-Process -Online。若要阅读所有 PowerShell 文档，请参阅 powerShell 文档Microsoft Docs。

如果键入 Get-Help 后跟帮助文章的确切名称或帮助文章唯一的单词， Get-Help 则显示文章的内容。如果指定命令别名的确切名称， Get-Help 则显示原始命令的帮助。如果输入出现在多个帮助文章标题中的单词或单词模式， Get-Help 则显示匹配标题的列表。如果输入的任何文本未出现在任何帮助文章标题中， Get-Help 则会显示在其内容中包含该文本的文章列表。

Get-Help 可以获取有关所有受支持语言和区域设置的帮助文章。 Get-Help首先在 Windows 的区域设置中查找帮助文件，然后在父区域设置中查找帮助文件，例如 pt-BR，然后在回退区域设置中查找。从 PowerShell 3.0 开始，如果在 Get-Help 回退区域设置中找不到帮助，它会在返回错误消息或显示自动生成的帮助之前查找英语（ en-US）的帮助文章。

有关命令语法图中显示的符号 Get-Help 的信息，请参阅 about_Command_Syntax。有关参数属性（例如 Required 和 Position）的信息，请参阅 about_Parameters。

注意

在 PowerShell 3.0 和 PowerShell 4.0 中，除非模块已导入当前会话， Get-Help 否则无法在模块中找到 “关于 ”文章。这是已知问题。若要获取模块中的 “关于 ”文章，请使用 Import-Module cmdlet 或通过运行模块中包含的 cmdlet 导入模块。

示例

示例 1：显示有关 cmdlet 的基本帮助信息

这些示例显示有关 Format-Table cmdlet 的基本帮助信息。

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> 是 cmdlet 的最简单默认语法 Get-Help 。可以省略 Name 参数。

语法 <cmdlet-name> -? 仅适用于 cmdlet。

示例 2：一次显示一页基本信息

这些示例一次显示一页有关 Format-Table cmdlet 的基本帮助信息。

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help 是在内部运行 Get-Help cmdlet 并一次显示一页结果的函数。

man 是函数的 help 别名。

Get-Help Format-Table 在管道中向下发送对象。 Out-Host -Paging 从管道接收输出，并一次显示一页。有关详细信息，请参阅 Out-Host。

示例 3：显示 cmdlet 的详细信息

这些示例显示有关 cmdlet 的 Format-Table 更详细的帮助信息。

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Detailed 参数显示帮助文章的详细视图，其中包括参数说明和示例。

Full 参数显示帮助文章的完整视图，其中包括参数说明、示例、输入和输出对象类型以及其他说明。

Detailed 和 Full 参数仅对计算机上安装了帮助文件的命令有效。参数对于概念 (about_) 帮助文章无效。

示例 4：使用参数显示 cmdlet 的选定部分

这些示例显示 cmdlet 帮助的 Format-Table 选定部分。

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Examples 参数显示帮助文件的 NAME 和 SYNOPSIS 部分，以及所有 Examples。无法指定 Example 编号，因为 Examples 参数是 switch 参数。

Parameter 参数仅显示指定参数的说明。如果仅指定星号 (*) 通配符，则它将显示所有参数的说明。当 Parameter 指定参数名称（如 GroupBy）时，将显示有关该参数的信息。

这些参数对概念 (about_) 帮助文章无效。

示例 5：显示联机版本的帮助

此示例在默认 Web 浏览器中显示 cmdlet 的帮助文章 Format-Table 联机版本。

Get-Help Format-Table -Online

示例 6：显示有关帮助系统的帮助

不带参数的 Get-Help cmdlet 显示有关 PowerShell 帮助系统的信息。

Get-Help

示例 7：显示可用的帮助文章

此示例显示计算机上可用的所有帮助文章的列表。

Get-Help *

示例 8：显示概念文章列表

此示例显示 PowerShell 帮助中包含的概念文章列表。所有这些文章都以 字符about_开头。若要显示特定的帮助文件，请键入 Get-Help \<about_article-name\>，例如 Get-Help about_Signing。

仅显示计算机上安装了帮助文件的概念文章。有关在 PowerShell 3.0 中下载和安装帮助文件的信息，请参阅 Update-Help。

Get-Help about_*

示例 9：cmdlet 帮助中单词的搜索

此示例演示如何在 cmdlet 帮助文章中搜索单词。

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help 使用 Full 参数获取的 Add-Member帮助信息。 MamlCommandHelpInfo 对象在管道中向下发送。 Out-String使用 Stream 参数将对象转换为字符串。 Select-String 使用 Pattern 参数在字符串中搜索 Clixml。

示例 10：显示包含单词的文章列表

本示例显示包含“ 远程处理”一词的文章列表。

输入未出现在任何文章标题中的单词时， Get-Help 将显示包含该单词的文章列表。

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

示例 11：显示特定于提供程序的帮助

此示例演示获取针对 Get-Item的提供程序特定帮助的两种方法。这些命令获得帮助，说明如何在 PowerShell SQL Server提供程序的 DataCollection 节点中使用 Get-Item cmdlet。

第一个示例使用 Get-HelpPath 参数指定SQL Server提供程序的路径。由于指定了提供程序的路径，因此可以从任何路径位置运行命令。

第二个示例使用 Set-Location 导航到SQL Server提供程序的路径。从该位置获取特定于提供程序的帮助不需要 Get-HelpPath 参数。

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.
    ...

Set-Location 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.
    ...

示例 12：显示脚本的帮助

此示例获取有关的 MyScript.ps1 script帮助。有关如何为函数和脚本编写帮助的信息，请参阅 about_Comment_Based_Help。

Get-Help -Name C:\PS-Test\MyScript.ps1

参数

-Category

只显示指定类别及其别名中的项的帮助。概念文章位于 HelpFile 类别中。

此参数的可接受值如下所示：

Alias
Cmdlet
提供程序
常规
常见问题解答
术语表
HelpFile
ScriptCommand
函数
筛选器
ExternalScript
全部
DefaultHelp
工作流
DscResource
类
配置

Type:	String[]
Accepted values:	Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Component

显示具有指定组件值的命令，例如 Exchange。输入组件名称。允许使用通配符。此参数对概念 (About_) 帮助的显示没有影响。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Detailed

将参数说明和示例添加到基本帮助显示。仅当帮助文件安装在计算机上时，此参数才有效。它不会影响概念 (About_) 帮助。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Examples

只显示名称、摘要和示例。若要仅显示示例，请键入 (Get-Help \<cmdlet-name\>).Examples。

仅当帮助文件安装在计算机上时，此参数才有效。它不会影响概念 (About_) 帮助。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Full

显示 cmdlet 的整个帮助文章。完整内容包括参数说明和属性、示例、输入和输出对象类型以及其他说明。

仅当帮助文件安装在计算机上时，此参数才有效。它不会影响概念 (About_) 帮助。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Functionality

显示具有指定功能的项的帮助。输入功能。允许使用通配符。此参数对概念 (About_) 帮助的显示没有影响。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Name

获取有关指定命令或概念的帮助。输入 cmdlet、函数、提供程序、脚本或工作流的名称，例如 Get-Member、概念项目名称（如 about_Objects）或别名（如 ls）。 cmdlet 和提供程序名称中允许使用通配符，但不能使用通配符来查找函数帮助和脚本帮助文章的名称。

若要获取有关不在环境变量中列出的路径中的脚本的 $env:Path 帮助，请键入脚本的路径和文件名。

如果输入帮助文章的确切名称， Get-Help 则显示文章内容。

如果输入出现在多个帮助文章标题中的单词或单词模式， Get-Help 则显示匹配标题的列表。

如果输入的任何文本与任何帮助文章标题都不匹配， Get-Help 则显示在其内容中包含该文本的文章列表。

概念性文章（如） about_Objects的名称必须以英语输入，即使在非英语版本的 PowerShell 中也是如此。

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-Online

在默认浏览器中显示帮助文章的在线版本。此参数仅适用于 cmdlet、函数、工作流和脚本帮助文章。不能在远程会话中使用 Online 参数 Get-Help 。

有关在撰写的帮助文章中支持此功能的信息，请参阅 about_Comment_Based_Help、支持联机帮助和编写 PowerShell Cmdlet 的帮助。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Parameter

只显示指定参数的详细说明。允许使用通配符。此参数对概念 (About_) 帮助的显示没有影响。

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-Path

获取说明 cmdlet 在指定的提供程序路径中的工作方式的帮助。输入 PowerShell 提供程序路径。

此参数获取 cmdlet 帮助文章的自定义版本，其中介绍了 cmdlet 在指定的 PowerShell 提供程序路径中的工作方式。仅当提供程序 cmdlet 在其帮助文件中包含提供程序 cmdlet 帮助文章的自定义版本时，此参数才有效。若要使用此参数，请安装包含该提供程序的模块的帮助文件。

若要查看提供程序路径的自定义 cmdlet 帮助，请转到提供程序路径位置并输入 Get-Help 命令，或者从任意路径位置使用的Get-Help Path 参数指定提供程序路径。还可以在帮助文章的提供程序帮助部分中联机查找自定义 cmdlet 帮助。

有关 PowerShell 提供程序的详细信息，请参阅 about_Providers。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Role

显示为指定的用户角色自定义的帮助。输入角色。允许使用通配符。

输入用户在组织中所扮演的角色。某些 cmdlet 将在其帮助文件中显示不同的文本，具体取决于此参数的值。此参数对核心 cmdlet 的帮助不起作用。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

输入

None

无法将对象通过管道向下发送到 Get-Help。

输出

ExtendedCmdletHelpInfo

如果在 Get-Help 没有帮助文件的命令上运行， Get-Help 则返回一个代表自动生成的帮助 的 ExtendedCmdletHelpInfo 对象。

String

如果收到概念帮助文章， Get-Help 请将其作为字符串返回。

MamlCommandHelpInfo

如果获取具有帮助文件的命令， Get-Help 则返回 MamlCommandHelpInfo 对象。

备注

PowerShell 3.0 不包括帮助文件。若要下载并安装读取的帮助文件 Get-Help ，请使用 Update-Help cmdlet。可以使用 Update-Help cmdlet 下载和安装 PowerShell 附带的核心命令以及安装的任何模块的帮助文件。还可以使用它来更新帮助文件，以使计算机上的帮助永不过时。

还可以从入门 Windows PowerShell 开始阅读有关 PowerShell 联机随附的命令的帮助文章。

Get-Help 在 Windows 操作系统的区域设置或该区域设置的回退语言中显示帮助。如果没有主要区域设置或回退区域设置的帮助文件， Get-Help 则行为就像计算机上没有帮助文件一样。若要获取有关不同区域设置的帮助，请使用控制面板中的区域和语言更改设置。在Windows 10，设置，时间 & 语言。

帮助的完整视图包括有关参数的信息表。该表包括以下字段：

“必需”。指示参数是必需的 (true) 还是可选的 (false)。
位置。指示参数是命名参数还是位置 (数值) 。位置参数必须出现在命令中的指定位置。
Named 指示参数名称是必需的，但参数可以出现在命令中的任意位置。
数值指示参数名称是可选的，但省略该名称时，参数必须位于数字指定的位置。例如， 2 指示在省略参数名称时，参数必须是命令中的第二个或唯一未命名的参数。当使用了参数名称时，该参数可以出现在命令中的任意位置。
默认值。如果未在命令中包含参数，则 PowerShell 使用的参数值或默认行为。
接受管道输入。指示是否可以 (true) ，还是无法 (false) 通过管道将对象发送到参数。 “属性名称 ”表示管道对象必须具有与参数名称同名的属性。
接受通配符。指示参数的值是否可以包含通配符，例如星号 () * 或问号 (?) 。