「PowerShellのコマンドって多すぎて覚えられない…」
「引数やオプションの意味がわからず手が止まる…」
そんなときに役立つのが、PowerShell標準搭載のコマンドリファレンス機能、Get-Help
コマンドレットです。
このコマンドを使えば、コマンドの概要・使い方・引数一覧・使用例まで、すべてPowerShell上で確認できます。
本記事では、Get-Help
の基本から実践的な活用法、表示内容の読み方、ヘルプの最新化方法まで、初心者にもやさしく丁寧に解説します。
Get-Helpとは?その役割とメリット
Get-Help
は、PowerShellに搭載されているコマンドヘルプ閲覧専用のコマンドレットです。
以下の情報が取得できます:
- コマンドの概要
- 構文(使用書式)
- 使用可能なパラメータ一覧
- 具体的な使用例(Examples)
- 関連コマンドや注意点
メリット
- ネット接続がなくても基本情報が読める
- 日本語ヘルプのインストールも可能
- 実行しながら調べられるため、学習効率がアップ!
- オフラインでも使える公式ドキュメント
- 自分で作成したカスタムヘルプも追加可能
Get-Help
はhelp
やman
などのエイリアス(別名)でも呼び出せます:
help Get-Process
man Get-Process
基本的な使い方
最も基本的な使い方は:
Get-Help <コマンド名>
例:
Get-Help Get-Process
これでGet-Process
の使い方が表示されます。
オンラインヘルプを開く
最新の情報をブラウザで確認したい場合は、-Online
パラメータを使います:
Get-Help Get-Service -Online
これにより、マイクロソフトの公式ドキュメントが自動的にブラウザで開きます。
キーワードでコマンドを検索
特定のコマンド名がわからない場合は、キーワード検索も可能です:
Get-Help *process*
これにより、「process」という単語を含むすべてのコマンドヘルプが表示されます。
表示されるヘルプ情報の見方
Get-Help
の基本出力には以下の項目があります:
- Name:コマンド名
- Synopsis:概要説明
- Syntax:構文とパラメータの組み合わせ
- Description:詳細な解説
- Related Links:関連コマンド
- Remarks:追加の参考情報
構文(Syntax)の読み方
構文セクションは特に重要で、以下のような形式で表示されます:
SYNTAX
Get-Process [[-Name] <String[]>] [-ComputerName <String[]>] [-Module] [-FileVersionInfo] [<CommonParameters>]
Get-Process -Id <Int32[]> [-ComputerName <String[]>] [-Module] [-FileVersionInfo] [<CommonParameters>]
この表記の読み方:
[]
で囲まれているパラメータはオプション(省略可能)<>
で囲まれている部分はユーザーが指定する値[]
内に-Name
のように括弧付きで書かれている場合、パラメータ名の省略が可能<String[]>
のように[]
が付いている型は配列(複数の値を指定可能)- 複数の構文パターンがある場合、それぞれ異なる使い方を示している
使用例の確認方法(-Examples)
実際の使用方法を見たいときは-Examples
オプションを使います:
Get-Help Get-Service -Examples
出力例(一部):
Example 1:
Get-Service
このコマンドは、すべてのサービスを一覧表示します。
Example 2:
Get-Service -DisplayName "*network*"
このコマンドは、表示名に "network" が含まれるサービスを取得します。
初心者が学習する際は、このオプションが特に役立ちます。
実際のコマンド使用例を見ることで、使い方が直感的に理解できます。
詳細情報・パラメータヘルプの確認方法
詳細情報(-Detailed
):
Get-Help Stop-Process -Detailed
パラメータ説明付き(-Full
):
Get-Help New-Item -Full
これにより、すべてのスイッチ・オプションの説明が確認できます。
特に複雑なコマンドレットを使う場合は、各パラメータの詳細な説明が非常に役立ちます。
よく使われるその他のパラメータ
パラメータ | 説明 | 使用例 |
---|---|---|
-Full | 最も詳細な情報を表示 | Get-Help Get-ChildItem -Full |
-Detailed | 詳細情報(例と説明) | Get-Help Get-Process -Detailed |
-Examples | 使用例のみ表示 | Get-Help New-Item -Examples |
-Parameter | 特定パラメータの詳細 | Get-Help Get-Process -Parameter Id |
-ShowWindow | 別ウィンドウで表示 | Get-Help Get-Service -ShowWindow |
-Online | オンラインドキュメントを開く | Get-Help Write-Host -Online |
ヘルプを最新状態に更新する方法(Update-Help)
初期状態では、Get-Help
の情報が古い・簡易版になっていることがあります。
以下のコマンドでオンラインの最新ヘルプをダウンロードできます:
Update-Help
※インターネット接続が必要。管理者としてPowerShellを起動してください。
特定モジュールだけ更新する場合:
Update-Help -Module Microsoft.PowerShell.Management
日本語ヘルプの更新
日本語UIのWindows環境では、日本語のヘルプも更新できます:
Update-Help -UICulture ja-JP
オフライン環境での更新
インターネット接続がない環境でも、別のPCでダウンロードしたヘルプを使用できます:
# インターネット接続があるPCで実行
Save-Help -DestinationPath "C:\HelpFiles" -Module Microsoft.PowerShell.Management
# オフライン環境で実行
Update-Help -SourcePath "C:\HelpFiles" -Module Microsoft.PowerShell.Management
よくあるエラーと対処法
エラー内容 | 原因・対策 |
---|---|
Update-Help is not recognized | PowerShellバージョンが古い。PowerShell 3.0以上が必要です。 |
Insufficient permissions | 管理者としてPowerShellを実行してください。 |
Unable to download Help files | インターネット接続またはプロキシ設定を確認しましょう。 |
Help not found | 指定したコマンドが存在しないか、ヘルプファイルがインストールされていません。 |
Failed to update Help | -Force パラメータを追加して再試行してください。 |
ヘルプが見つからない場合
# コマンドが存在するか確認
Get-Command <コマンド名>
# 強制的にヘルプを更新
Update-Help -Force
ヘルプの言語を変更したい場合
# 利用可能な言語を確認
Get-UICulture
# 特定の言語でヘルプを更新
Update-Help -UICulture en-US
実践的なGet-Help活用法
コマンドをカテゴリで探す
Get-Help -Category Cmdlet
コマンドの詳細な使い方を学ぶ
Get-Help about_* # すべての概念ヘルプトピック一覧
Get-Help about_Operators # 演算子についての詳細ヘルプ
Aboutトピックの確認
PowerShellの概念や機能について学ぶには「about_*」トピックが便利です:
Get-Help about_Arrays # 配列について
Get-Help about_Functions # 関数について
Get-Help about_CommonParameters # 共通パラメータについて
特定のパラメータだけを確認
Get-Help Get-ChildItem -Parameter Recurse
まとめ:PowerShell初心者こそGet-Helpを使いこなそう
PowerShellを学ぶ上で最も基本かつ強力なコマンドがGet-Help
です。
コマンドリファレンスを手元に置いて作業できるような感覚で、使い方がわからなくなったときのポケットリファレンスとして大いに活用できます。
今日のポイント
Get-Help <コマンド名>
で使い方を確認-Examples
,-Full
で詳細までチェック可能Update-Help
でヘルプ内容を最新に更新Get-Help about_*
で概念的な知識を学ぶ-Online
で公式ドキュメントに即アクセス
コメント