PowerShell コマンドのヘルプの確認方法と更新方法

2020/04/18

ここでは PowerShell を管理者モードで起動して作業を行います。管理者モードでの起動の仕方は次の通りです。

  • メニューから Windows PowerShell を探す
  • Windows PowerShell を右クリックして 管理者として実行 を選ぶ

PowerShell を管理者で実行する

ヘルプの確認

# 基本的なヘルプを表示
Get-Help <cmdlet_name>

# 詳細なヘルプを表示
Get-Help <cmdlet_name> -detailed

# 技術的なヘルプを表示
Get-Help <cmdlet_name> -full

Get-ChildItem のヘルプを表示するときにはこのように行います。

Get-ChildItem のヘルプを表示

Get-Help Get-ChildItem
Get-Help Get-ChildItem -detailed
Get-Help Get-ChildItem -full

詳細なヘルプや技術的なヘルプは、ヘルプファイルを更新(手元に取得)していないと見れません。
詳細ヘルプを取得せずに確認したいときは、-Online スイッチも付けます。

Get-ChildItem の詳細ヘルプ(オンライン)を表示

Get-Help Get-ChildItem -detailed -Online

ヘルプファイルを更新する

PowerShell ではコマンドラインからヘルプを見ることができますが、デフォルトで詳細を見るにはブラウザ経由でないとみれません。そこで、最初に手元のマニュアルを更新しておくと便利です。

Update-Help