HOME > Help系コマンドレット > Update-Help
Update-Help
Update-Helpは、ヘルプを更新するコマンドです。
エイリアスなし
解説
PowerShellモジュールのヘルプファイルをインストールします。
PowerShellのヘルプファイルを最新の状態に保つために便利なコマンドです。
構文
- （構文）
- Update-Help [[-Module] <string[]>] [[-SourcePath] <string[]>] [[-UICulture] <cultureinfo[]>] [<CommonParameters>] Update-Help [[-Module] <string[]>] [[-UICulture] <cultureinfo[]>] [<CommonParameters>]
| パラメータ | 説明 |
|---|---|
| -Modulem モジュール | 特定のモジュールのヘルプファイルを更新する ※モジュール名をカンマで区切って複数指定可 （例）Update-Help -Module Microsoft.PowerShell.Core |
| -FullyQualifiedModule | xx |
| -SourcePath パス | ファイル共有からヘルプファイルをダウンロードしてインストールする （例）Update-Help -SourcePath "\\Server\Share\Help" |
| -LiteralPath パス | 対象パスを指定する （例）-LiteralPath "D:\test" |
| -Recurse | ヘルプファイルを再帰的に検索する |
| -UICulture 言語コード | ダウンロードするヘルプファイルの言語を指定する （例）Update-Help -UICulture ja-JP |
| -UseDefaultCredentials | 現在のユーザーの資格情報を使用してインターネットダウンロードを含むコマンドを実行する |
| -Force | 強制的に実行する |
| -Credential 資格情報 | 資格情報を指定する |
| -WhatIf | 実行はせずに実行結果の確認のみ行う |
| -Confirm | 実行前に確認メッセージの表示を行う |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
保存したヘルプファイルからヘルプを更新する
Update-Help -SourcePath "C:\PSHelp"
すべてのモジュールのヘルプを更新する
Update-Help
特定のモジュールのヘルプを更新
Update-Help -Module Microsoft.PowerShell.Utility
コマンドのヘルプを表示する
Get-Help Update-Help
備考
- PowerShell6.0以前では、実行には管理者としてPowerShellを実行する必要があります。
- Update-Helpコマンドはデフォルトで1日1回しか実行できません。この制限を無視して実行したい場合は-Forceパラメータを指定してください。
関連項目
- Help系コマンドレット
- Get-Help：ヘルプを表示する
- Save-Help：ヘルプを保存する
- Update-Help：ヘルプを更新する
