Get-Help (Microsoft.PowerShell.Core)

Get-Help

显示有关 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 显示有关 PowerShell 概念和命令的信息，包括 cmdlet、函数、公共信息模型 (CIM) 命令、工作流、提供程序、别名和脚本。

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

PowerShell 中的概念帮助文章以 about_ 开头，例如 about_Comparison_Operators。要查看所有 about_ 文章，请输入 Get-Help about_*。要查看特定文章，请输入 Get-Help about_，例如 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。

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

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

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

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

笔记

在 PowerShell 3.0 和 PowerShell 4.0 中，Get-Help 无法在模块中找到关于文章，除非将模块导入到当前会话中。要获取模块中的关于文章，请使用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。

示例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 接收来自管道的输出并一次显示一页。有关详细信息，请参阅主机外。

示例 3：显示 cmdlet 的更多信息

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

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

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

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 \，例如 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 脚本 的帮助。有关如何为函数和脚本编写帮助的信息，请参阅 about_Comment_Based_Help。

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

参数

-Category

仅显示指定类别中的项目及其别名的帮助。概念性文章位于帮助文件类别中。

该参数可接受的值如下：

• 别名
• 命令行工具
• 提供者
• 一般的
• 常问问题
• 词汇表
• HelpFile
• ScriptCommand
• 功能
• 筛选
• ExternalScript
• 全部
• DefaultHelp
• 工作流程
• DscResource
• 班级
• 配置

String[]

别名、Cmdlet、提供程序、常规、常见问题解答、术语表、帮助文件、ScriptCommand、函数、筛选器、ExternalScript、全部、DefaultHelp、工作流、DscResource、类、配置

命名

None

False

False

False

-Component

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

String[]

命名

None

False

False

True

-Detailed

在基本帮助显示中添加参数说明和示例。仅当计算机上安装了帮助文件时，该参数才有效。它对概念性（关于_）帮助的显示没有影响。

SwitchParameter

命名

False

True

False

False

-Examples

仅显示名称、概要和示例。仅当计算机上安装了帮助文件时，该参数才有效。它对概念性（关于_）帮助的显示没有影响。

SwitchParameter

命名

False

True

False

False

-Full

显示 cmdlet 的完整帮助文章。 完整包括参数描述和属性、示例、输入和输出对象类型以及附加注释。

仅当计算机上安装了帮助文件时，该参数才有效。它对概念性（关于_）帮助的显示没有影响。

SwitchParameter

命名

False

False

False

False

-Functionality

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

String[]

命名

None

False

False

True

-Name

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

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

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

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

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

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

String

0

None

False

True

True

-Online

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

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

SwitchParameter

命名

False

True

False

False

-Parameter

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

String[]

命名

None

True

False

True

-Path

获取帮助，解释 cmdlet 如何在指定的提供程序路径中工作。输入 PowerShell 提供程序路径。

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

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

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

笔记

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

String

命名

None

False

False

True

-Role

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

输入用户在组织中扮演的角色。某些 cmdlet 根据此参数的值在其帮助文件中显示不同的文本。此参数对核心 cmdlet 的帮助没有影响。

String[]

命名

None

False

False

True

-ShowWindow

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

ShowWindow 参数支持命令（cmdlet、函数、CIM 命令、脚本）的帮助主题和概念性关于 文章。它不支持提供者帮助。

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

SwitchParameter

命名

False

True

False

False

输入

无

您无法将对象通过管道传输到此 cmdlet。

输出

扩展CmdletHelpInfo

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

字符串

如果您获得概念性帮助文章，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 表示参数名称是必需的，但该参数可以出现在命令中的任何位置。

• Numeric表示参数名称是可选的，但是当省略名称时，参数必须位于数字指定的位置。例如，2 表示当省略参数名称时，该参数必须是命令中第二个或唯一一个未命名的参数。当使用参数名称时，参数可以出现在命令中的任何位置。

• 默认值。如果命令中未包含参数，则 PowerShell 使用的参数值或默认行为。

• 接受管道输入。指示是否可以 (true) 或不能 (false) 通过管道将对象发送到参数。 按属性名称表示管道对象必须具有与参数名称同名的属性。

• 接受通配符。指示参数的值是否可以包含通配符，例如星号 (*) 或问号 (?)。