Get-Help

構文

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 コマンドレットには、コマンドレット、関数、共通情報モデル (CIM) コマンド、ワークフロー、プロバイダー、エイリアス、スクリプトなど、PowerShell の概念とコマンドに関する情報が表示されます。

PowerShell コマンドレットのヘルプを表示するには、「 Get-Help 」と入力し、その後にコマンドレット名 (例: Get-Help Get-Process) を入力します。

PowerShell の概念的なヘルプ記事は、about_Comparison_Operatorsなどのabout_から始まります。 すべての about_ 記事を表示するには、「 Get-Help about_*」と入力します。 特定の記事を表示するには、Get-Help about_Comparison_OperatorsなどのGet-Help about_<article-name>を入力します。

PowerShell プロバイダーのヘルプを表示するには、「 Get-Help 」と入力し、その後にプロバイダー名を入力します。 たとえば、証明書プロバイダーのヘルプを表示するには、「 Get-Help Certificate」と入力します。

helpまたはmanを入力して、一度に 1 画面のテキストを表示することもできます。 または、 <cmdlet-name> -?、 Get-Helpと同じですが、コマンドレットでのみ機能します。

Get-Help は、コンピューター上のヘルプ ファイルから表示されるヘルプ コンテンツを取得します。 ヘルプ ファイルがない場合、 Get-Help はコマンドレットに関する基本情報のみを表示します。 一部の PowerShell モジュールには、ヘルプ ファイルが含まれています。 PowerShell 3.0 以降、Windows オペレーティング システムに付属するモジュールにはヘルプ ファイルは含まれません。 PowerShell 3.0 でモジュールのヘルプ ファイルをダウンロードまたは更新するには、 Update-Help コマンドレットを使用します。

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 ヘルプが見つからない場合、エラー メッセージを返すか自動生成されたヘルプを表示する前に、英語 ( -US) のヘルプ記事を検索します。

コマンド構文図に表示 Get-Help シンボルの詳細については、 about_Command_Syntaxを参照してください。 パラメーター属性 ( Required Position など) については、 about_Parametersを参照してください。

PSReadLine v2.2.2 以降では、コマンド ラインでコマンドを入力するときに役立つ簡単なアクセスを提供する 2 つの関数が付属しています。 ヘルプは、ページングのある代替画面バッファーのターミナルに表示されます。

F1 キーを押すと、PSReadLine ShowCommandHelp 関数は、カーソルの左側に最も近いコマンドレット名のGet-Help -Fullを呼び出します。 カーソルがパラメーターの左側にある場合、関数は完全なヘルプ トピックでそのパラメーターの説明にジャンプします。 Q を押してヘルプ ビューを終了すると、同じカーソル位置にあるコマンド ラインに戻り、コマンドの入力を続けることができます。

キーの組み合わせを Alt+hを使用すると、 PSReadLine ShowParameterHelp 関数は、カーソルの左側にパラメーターのヘルプ情報をすぐに表示します。 コマンド ラインの下にヘルプ テキストが表示されます。 これにより、パラメーターの説明を確認し、コマンドの入力を続けることができます。

詳細については、「 動的ヘルプの使用」を参照してください。

例

例 1: コマンドレットに関する基本的なヘルプ情報を表示する

次の例では、 Format-Table コマンドレットに関する基本的なヘルプ情報を表示します。

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

Get-Help <cmdlet-name> は、 Get-Help コマンドレットの最も単純で既定の構文です。 Name パラメーターは省略できます。

構文 <cmdlet-name> -? はコマンドレットに対してのみ機能します。

例 2: 基本情報を一度に 1 ページずつ表示する

これらの例では、 Format-Table コマンドレットに関する基本的なヘルプ情報を 1 ページずつ表示します。

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

help は、コマンドレット Get-Help 内部で実行され、結果を一度に 1 ページずつ表示する関数です。

man は、 help 関数のエイリアスです。

Get-Help Format-Table は、パイプラインの下にオブジェクトを送信します。 Out-Host -Paging はパイプラインから出力を受け取り、一度に 1 ページずつ表示します。 詳細については、「 Out-Host」を参照してください。

例 3: コマンドレットの詳細情報を表示する

次の例では、 Format-Table コマンドレットに関するより詳細なヘルプ情報を表示します。

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

Detailed パラメーターには、パラメーターの説明と例を含むヘルプ記事の詳細ビューが表示されます。

Full パラメーターには、パラメーターの説明、例、入力オブジェクトと出力オブジェクトの種類、および追加のメモを含むヘルプ記事の完全なビューが表示されます。

Detailed および Full パラメーターは、コンピューターにヘルプ ファイルがインストールされているコマンドに対してのみ有効です。 パラメーターは、概念 (about_) のヘルプ記事には有効ではありません。

例 4: パラメーターを使用してコマンドレットの選択した部分を表示する

次の例では、 Format-Table コマンドレット ヘルプの選択した部分を表示します。

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

Examples パラメーターには、ヘルプ ファイルの NAME および SYNOPSIS セクション、およびすべての例が表示されます。 Examples パラメーターは switch パラメーターであるため、Example 番号を指定できません。

Parameter パラメーターには、指定されたパラメーターの説明のみが表示されます。 アスタリスク (*) ワイルドカード文字のみを指定すると、すべてのパラメーターの説明が表示されます。 Parameterがパラメーター名 (GroupBy など) を指定すると、そのパラメーターに関する情報が表示されます。

これらのパラメーターは、概念 (about_) のヘルプ記事には有効ではありません。

例 5: オンライン バージョンのヘルプを表示する

次の使用例は、既定の Web ブラウザーで、 Format-Table コマンドレットのヘルプ記事のオンライン バージョンを表示します。

Get-Help Format-Table -Online

例 6: ヘルプ・システムに関するヘルプを表示する

パラメーターのない Get-Help コマンドレットには、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: コマンドレット ヘルプで単語を検索する

この例では、コマンドレットのヘルプ記事で単語を検索する方法を示します。

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のプロバイダー固有のヘルプを取得する 2 つの方法を示します。 これらのコマンドは、PowerShell SQL Server プロバイダーの DataCollection ノードで Get-Item コマンドレットを使用する方法を説明するヘルプを取得します。

最初の例では、 Get-Help Path パラメーターを使用して、SQL Server プロバイダーのパスを指定します。 プロバイダーのパスが指定されているため、任意のパスの場所からコマンドを実行できます。

2 番目の例では、 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

-Component

-Detailed

-Examples

-Full

-Functionality

-Name

-Online

-Parameter

-Path

-Role

-ShowWindow

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

ExtendedCmdletHelpInfo

ヘルプ ファイルがないコマンドで Get-Help を実行すると、 Get-Help は自動生成されたヘルプを表す ExtendedCmdletHelpInfo オブジェクトを返します。

String

概念的なヘルプ記事が表示された場合、 Get-Help はそれを文字列として返します。

MamlCommandHelpInfo

ヘルプ ファイルを含むコマンドを取得した場合、 Get-Help は MamlCommandHelpInfo オブジェクトを返します。

メモ

PowerShell 3.0 にはヘルプ ファイルは含まれません。 読み取り Get-Help ヘルプ ファイルをダウンロードしてインストールするには、 Update-Help コマンドレットを使用します。 Update-Help コマンドレットを使用すると、PowerShell に付属するコア コマンドと、インストールするモジュールのヘルプ ファイルをダウンロードしてインストールできます。 また、このコマンドレットを使用してヘルプ ファイルを更新して、コンピューター上のヘルプを最新に保つこともできます。

PowerShell オンラインに付属するコマンドに関するヘルプ記事については、「 Windows PowerShell の概要を参照してください。

Get-Help は、Windows オペレーティング システムのロケール セットまたはそのロケールのフォールバック言語でヘルプを表示します。 プライマリ ロケールまたはフォールバック ロケールのヘルプ ファイルがない場合、 Get-Help はコンピューターにヘルプ ファイルがないかのように動作します。 別のロケールのヘルプを表示するには、コントロール パネルの Region および Language を使用して設定を変更します。 Windows 10 以降では、 Settings、 Time および言語。

ヘルプの完全なビューには、パラメーターに関する情報のテーブルが含まれています。 この表には、次のフィールドが含まれます。

• 必須。 パラメーターが必須 (true) であるか省略可能 (false) であるかを示します。

• 位置。 パラメーターが名前付きか位置指定 (数値) かを示します。 位置指定パラメーターは、コマンド内の特定の場所に指定する必要があります。

• 名前付き は、パラメーター名は必須ですが、パラメーターはコマンド内の任意の場所に表示できることを示します。

• 数値 はパラメーター名が省略可能であることを示しますが、名前を省略する場合は、数値で指定された場所にパラメーターを指定する必要があります。 たとえば、 2 は、パラメーター名を省略した場合、パラメーターはコマンドの 2 番目または唯一の名前のないパラメーターである必要があることを示します。 パラメーター名を使用する場合は、コマンド内の任意の場所にパラメーターを指定できます。

• 既定値。 コマンドにパラメーターを含めない場合に PowerShell で使用されるパラメーター値または既定の動作。

• パイプライン入力を受け入れます。 パイプラインを介してパラメーターにオブジェクトを送信できるかどうかを示します (true) か、または (false) 送信できません。 プロパティ名 は、パイプライン オブジェクトにパラメーター名と同じ名前を持つプロパティが必要であることを意味します。

• ワイルドカード文字を受け入れます。 パラメーターの値に、アスタリスク (*) や疑問符 (?) などのワイルドカード文字を含めることができるかどうかを示します。

関連リンク

• about_Command_Syntax
• about_Comment_Based_Help
• Get-Command
• 更新可能なヘルプのサポート
• Update-Help
• コメントベースのヘルプ トピックを記述する
• PowerShell コマンドレットのヘルプの記述