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>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]

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

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <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>]

说明

Get-Help cmdlet 可显示有关 Windows 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，后跟提供程序名称。例如，若要获取 Certificate 提供程序的帮助，请键入 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。

还可以查看 PowerShell 联机帮助文档。若要获取帮助文件的联机版本，请使用 Online 参数，例如：Get-Help Get-Process -Online。

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

Get-Help 可以获取所有支持的语言和区域设置的帮助文章。 Get-Help 将依次在 Windows 的区域设置、父区域设置（例如“pt-BR”对应的“pt”）、回退区域设置中查找帮助文档。从 PowerShell 3.0 开始，如果 Get-Help 在回退区域设置中找不到帮助，它会先查找英语 (en-US) 的帮助文章，然后返回错误消息或显示自动生成的帮助。

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

注意

在 PowerShell 3.0 和 PowerShell 4.0 中，除非将模块导入当前会话，否则 Get-Help 无法在模块中找到 About 文章。若要获取模块中的 About 文章，请使用 Import-Module cmdlet 或运行该模块中包含的 cmdlet 导入该模块。

从 PSReadLine v2.2.2 开始，该模块附带了两个函数，当你在命令行中键入命令时，这些函数可以提供对帮助的快速访问。帮助显示在终端的备用屏幕缓冲区中并分页。

命中 F1 键时，PSReadLine ShowCommandHelp 函数将调用Get-Help -Full离光标左侧最近的 cmdlet 名称。当光标紧邻参数左侧时，函数会跳转到完整帮助主题中该参数的描述。按 Q 退出帮助视图时，你将返回到同一光标位置的命令行，以便可以继续键入命令。

使用键组合 Alt+h 时，PSReadLine ShowParameterHelp 函数会立即在光标左侧显示参数的帮助信息。帮助文本显示在命令行下方。这样你便可以查看参数的描述并继续键入命令。

有关详细信息，请参阅使用动态帮助。

示例

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

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

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

Get-Help <cmdlet-name> 是 Get-Help cmdlet 最简单的默认语法。可以省略 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 的详细信息

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

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

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

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

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

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

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

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

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

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

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

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

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

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：显示包含某个单词的文章列表

此示例显示包含单词 remoting 的文章列表。

当你输入任何文章标题中均未出现过的某个单词时，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-Help Path 参数指定 SQL Server 提供程序的路径。由于指定了提供程序的路径，因此你可以从任何路径位置运行该命令。

第二个示例使用 Set-Location 导航到 SQL Server 提供程序的路径。从该位置开始，Get-Help 无需使用 Path 参数来获取特定于提供程序的帮助。

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
提供程序
常规
常见问题解答
术语表
帮助文件
ScriptCommand
函数
Filter
ExternalScript
全部
DefaultHelp
Workflow
DscResource
类
配置

类型:	String[]
接受的值:	Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Component

显示具有指定组件值（例如 Exchange）的命令。输入组件名称。允许使用通配符。此参数对概念性 (About_) 帮助的显示不起作用。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-Detailed

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

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	True
接受管道输入:	False
接受通配符:	False

-Examples

只显示名称、摘要和示例。仅当帮助文件已安装在计算机上时，此参数才有效。它对概念性 (About_) 帮助的显示不起作用。

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	True
接受管道输入:	False
接受通配符:	False

-Full

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

仅当帮助文件已安装在计算机上时，此参数才有效。它对概念性 (About_) 帮助的显示不起作用。

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-Functionality

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

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-Name

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

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

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

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

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

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

类型:	String
Position:	0
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	True

-Online

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

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

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	True
接受管道输入:	False
接受通配符:	False

-Parameter

只显示指定参数的详细说明。允许使用通配符。此参数对概念性 (About_) 帮助的显示不起作用。

类型:	String[]
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	True

-Path

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

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

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

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

注意

所指定路径的提供程序必须安装了 PowerShell 提供程序帮助文件。如果没有可用的提供程序帮助文件，则不会返回帮助信息。此版本的 PowerShell 随附的提供程序没有可用的提供程序帮助文件。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-Role

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

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

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-ShowWindow

在窗口中显示帮助主题以便于阅读。该窗口包括“查找”搜索功能和“设置”框，在该框中可以设置有关显示的选项，包括只显示帮助主题的选定部分的选项。

ShowWindow 参数支持命令（cmdlet、函数、CIM 命令、脚本）的帮助主题和概念性 About 主题。它不支持提供程序帮助。

此参数是在 PowerShell 7.0 中重新引入的。此参数仅在 Windows 上可用。

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	True
接受管道输入:	False
接受通配符:	False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

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

通过