PowerShellのヘルプコマンド（Get-Help）の使い方を徹底解説

PowerShellヘルプコマンド（Get-Help）とは

特定のコマンドについてヘルプを表示したい場合は、Get-Help コマンドレット（エイリアス：help）を使います。ヘルプを確認したいコマンド名を続けて指定するだけで、そのコマンドの詳細情報を簡単に取得できます。

基本的な使い方

help Get-Service

このコマンドを実行すると、NAME（名前）、SYNOPSIS（概要）、SYNTAX（構文）、DESCRIPTION（説明）、RELATED LINKS（関連リンク）、REMARKS（備考）といった各項目の説明が表示されます。

表示内容を切り替える主なパラメータ

Get-Helpには、目的に応じて表示内容を変えられる複数のパラメータが用意されています。

• -Full ─ パラメータの詳細な説明と使用例を含む完全なヘルプを表示します。

help Get-Service -Full

• -Detailed ─ パラメータの詳細な説明を表示します。ただし、使用例は含まれません。

help Get-Service -Detailed

• -Examples ─ 使用例に関するヘルプのみがPowerShell画面に表示されます。

help Get-Service -Examples

• -Online ─ Microsoft公式サイト上でオンラインヘルプを検索して表示します。

help Get-Service -Online

Update-Helpでヘルプコンテンツを最新に保つ

PowerShellを新規インストール・アップデートした場合や、PowerShellがプリインストールされた新しいOSを導入した際には、MicrosoftのWebサイトからヘルプコンテンツを更新しておく必要があります。更新には Update-Help コマンドを使用します。

ヘルプの内容は時間の経過とともに古くなることがあり、Microsoftも継続的にヘルプを更新しているため、月に1回程度の更新が推奨されています。古いヘルプがシステムに残っていると、一部のコマンドレットのヘルプが正しく表示されない場合があります。そのようなときも、ヘルプコンテンツを更新すれば解決できます。

-ShowWindowで別ウィンドウにヘルプを表示する

-ShowWindow パラメータを指定すると、対象コマンドのヘルプが独立したウィンドウで表示されます。

help Get-Service -ShowWindow

表示されたウィンドウの Settings（設定） ボタンからは、特定の項目だけを絞り込んで表示するフィルター機能を利用できます。

特定のセクションのヘルプだけが必要な場合は、該当する設定を選択してください。

-Parameterで特定のパラメータのヘルプを調べる

コマンドライン上で、特定のパラメータに関するヘルプを確認したい場合は、-Parameter パラメータにパラメータ名を指定します。

help Get-Service -Parameter ComputerName

PS C:\Users\Chirag.Nagarekar> help Get-Service -Parameter ComputerName

-ComputerName <System.String[]>
    指定されたコンピューター上で実行中のサービスを取得します。
    既定値はローカルコンピューターです。
    リモートコンピューターのNetBIOS名、IPアドレス、または完全修飾ドメイン名（FQDN）
    を入力してください。ローカルコンピューターを指定するには、
    コンピューター名、ドット（.）、または localhost を入力します。

    このパラメータはWindows PowerShellリモーティングに依存しません。
    コンピューターがリモートコマンドを実行できるよう構成されていない場合でも、
    Get-Service の ComputerName パラメータを使用できます。

    Required?                    false
    Position?                    named
    Default value                None
    Accept pipeline input?       True (ByPropertyName)
    Accept wildcard characters?  false

すべてのパラメータのヘルプを一括で表示したい場合は、パラメータ名の代わりにワイルドカード「*」を指定します。

help Get-Service -Parameter *

同様に、コマンドライン上で使用例セクションのみのヘルプを確認したい場合も、-Examples を指定するだけでOKです。

help Get-Service -Examples