Show-Command

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

PowerShell コマンド情報をグラフィカル ウィンドウに表示します。

構文

Show-Command
    [[-Name] <String>]
    [-Height <Double>]
    [-Width <Double>]
    [-NoCommonParameter]
    [-ErrorPopup]
    [-PassThru]
    [<CommonParameters>]

説明

このコマンドレットは、Windows プラットフォームでのみ使用できます。

コマンドレット Show-Command を使用すると、コマンド ウィンドウで PowerShell コマンドを作成できます。 コマンド ウィンドウの機能を使用して、コマンドを実行することやコマンドを返すことができます。

Show-Command は非常に便利な教育と学習ツールです。 Show-Command は、コマンドレット、関数、ワークフロー、CIM コマンドを含むすべてのコマンドの種類で機能します。

パラメーターがない場合は、 Show-Command インストールされているすべてのモジュールで使用可能なすべてのコマンドを一覧表示するコマンド ウィンドウが表示されます。 モジュール内のコマンドを検索するには、[モジュール] ボックスの一覧からモジュールを選択します。 コマンドを選択するには、コマンド名をクリックします。

コマンド ウィンドウを使用するには、[名前] を使用するか、[コマンド] ボックスの一覧でコマンド名をクリックして、コマンドを選択します。 各パラメーター セットは、個別のタブに表示されます。アスタリスクは必須パラメーターを示します。 パラメーターに値を入力するには、テキスト ボックスに値を入力するか、ドロップダウン ボックスから値を選択します。 スイッチ パラメーターを追加するには、パラメーター チェック ボックスをオンにします。

準備ができたら、[コピー] をクリックして、作成したコマンドをクリップボードにコピーするか、[実行] をクリックしてコマンドを実行できます。 また、PassThru パラメーターを使用して、PowerShell コンソールなどのホスト プログラムにコマンドを返すこともできます。 コマンドの選択を取り消し、すべてのコマンドを表示するビューに戻すには、Ctrl キーを押して選択したコマンドをクリックします。

PowerShell 統合スクリプト環境 (I Standard Edition) では、ウィンドウのShow-Commandバリエーションが既定で表示されます。 このコマンド ウィンドウの使用方法については、PowerShell I Standard Edition ヘルプ トピックを参照してください。

このコマンドレットは、PowerShell 7 で再導入されました。

このコマンドレットにはユーザー インターフェイスが必要であるため、Windows Server Core または Windows Nano Server では機能しません。 このコマンドレットは、Windows デスクトップをサポートする Windows システムでのみ使用できます。

例

例 1: コマンド ウィンドウを開く

次の使用例は、ウィンドウの既定のビューを Show-Command 表示します。 [ コマンド] ウィンドウには、コンピューターにインストールされているすべてのモジュールのすべてのコマンドの一覧が表示されます。

Show-Command

例 2: コマンド ウィンドウでコマンドレットを開く

次のInvoke-Command使用例は、[コマンド] ウィンドウにコマンドレットを表示します。 この表示を使用して、コマンドを実行 Invoke-Command できます。

Show-Command -Name "Invoke-Command"

例 3: 指定されたパラメーターを使用してコマンドレットを開く

このコマンドを実行すると、コマンドレットの Show-Command ウィンドウがConnect-PSSession開きます。

Show-Command -Name "Connect-PSSession" -Height 700 -Width 1000 -ErrorPopup

Height パラメーターと Width パラメーターは、コマンド ウィンドウの寸法を指定します。 ErrorPopup パラメーターには、エラー コマンド ウィンドウが表示されます。

[実行] をクリックすると、Connect-PSSessionコマンド ラインでコマンドを入力した場合と同様にConnect-PSSession、コマンドが実行されます。

例 4: コマンドレットの新しい既定のパラメーター値を指定する

この例では、自動変数を$PSDefaultParameterValues使用して、コマンドレットの Height、Width、および ErrorPopup パラメーターに新しい既定値をShow-Command設定します。

$PSDefaultParameterValues = @{
    "Show-Command:Height" = 700
    "Show-Command:Width" = 1000
    "Show-Command:ErrorPopup" = $True
}

コマンドを Show-Command 実行すると、新しい既定値が自動的に適用されます。 すべての PowerShell セッションでこれらの既定値を使用するには、変数を $PSDefaultParameterValues PowerShell プロファイルに追加します。 詳細については、「about_Profilesとabout_Parameters_Default_Values」を参照してください。

例 5: グリッド ビューに出力を送信する

このコマンドは、コマンドレットとOut-GridViewコマンドレットを一緒にShow-Command使用する方法を示しています。

Show-Command Get-ChildItem | Out-GridView

このコマンドでは、コマンドレットを Show-Command 使用してコマンドレットのコマンド ウィンドウをGet-ChildItem開きます。 [実行] ボタンをクリックすると、コマンドがGet-ChildItem実行され、出力が生成されます。 パイプライン演算子 ( | ) は、コマンドの出力を Get-ChildItem コマンドレットに Out-GridView 送信し、対話型ウィンドウに出力を Get-ChildItem 表示します。

例 6: [コマンド] ウィンドウで作成したコマンドを表示する

この例では、ウィンドウで作成したコマンドを Show-Command 示します。 このコマンドは、結果を文字列で返す Show-Command PassThru パラメーターを使用します。

Show-Command -PassThru

Get-EventLog -LogName "Windows PowerShell" -Newest 5

たとえば、ウィンドウをShow-Command使用して、Windows PowerShell イベント ログで 5 つの最新のイベントを取得し、[OK] をクリックするコマンドを作成Get-EventLogすると、上記の出力が返されます。 コマンド文字列を表示すると、PowerShell を学習するのに役立ちます。

例 7: 変数にコマンドを保存する

この例では、コマンドレットの PassThru パラメーターを使用するときに取得するコマンド文字列を実行する方法をShow-Command示します。 この方法により、コマンドを表示して使用することができます。

$C = Show-Command -PassThru
$C
Invoke-Expression $C

Get-EventLog -LogName "PowerShell" -Newest 5

Index Time          EntryType   Source                 InstanceID Message
----- ----          ---------   ------                 ---------- -------
11520 Dec 16 16:37  Information Windows PowerShell            400 Engine state is changed from None to Available...
11519 Dec 16 16:37  Information Windows PowerShell            600 Provider "Variable" is Started. ...
11518 Dec 16 16:37  Information Windows PowerShell            600 Provider "Registry" is Started. ...
11517 Dec 16 16:37  Information Windows PowerShell            600 Provider "Function" is Started. ...
11516 Dec 16 16:37  Information Windows PowerShell            600 Provider "FileSystem" is Started. ...

最初のコマンドでは、コマンドレットの PassThru パラメーターを Show-Command 使用し、コマンドの結果を変数に $C 保存します。 この場合、ウィンドウを Show-Command 使用して、Windows PowerShell イベント ログの最新の 5 つのイベントを取得するコマンドを作成 Get-EventLog します。 [OK] をクリックすると、Show-Command変数に保存されているコマンド文字列が$C返されます。

例 8: コマンドの出力を変数に保存する

この例では、 ErrorPopup パラメーターを使用して、コマンドの出力を変数に保存します。

$P = Show-Command Get-Process -ErrorPopup
$P

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    473      33    94096     112532   709     2.06   4492 powershell

ErrorPopup は、ウィンドウにエラーを表示するだけでなく、新しいコマンドを作成するのではなく、現在のコマンドにコマンド出力を返します。 このコマンドを実行すると、ウィンドウが Show-Command 開きます。 ウィンドウの機能を使用して、パラメーターの値を設定することができます。 コマンドを実行するには、ウィンドウの [実行] ボタンをShow-Commandクリックします。

パラメーター

-ErrorPopup

コマンド ラインにエラーを表示するだけでなく、コマンドレットがポップアップ ウィンドウにエラーを表示することを示します。 既定では、ウィンドウで実行されるコマンドで Show-Command エラーが生成されると、エラーはコマンド ラインにのみ表示されます。

また、(ウィンドウの [実行] ボタンを使用して) コマンドを実行すると、ErrorPopup パラメーターは、コマンドを実行して新しいコマンドに出力を返すのではなく、コマンドの結果を現在のコマンドに返Show-Commandします。 この機能を使用すると、コマンドの結果を変数に保存できます。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Height

ウィンドウの高さを Show-Command ピクセル単位で指定します。 300 以上で画面の解像度以下の値を入力します (ピクセル単位)。 値が大きすぎてコマンド ウィンドウが画面に表示されていない場合は、 Show-Command エラーが発生します。 既定の高さは 600 ピクセルです。 Name パラメーターをShow-Command含むコマンドの場合、既定の高さは 300 ピクセルです。

Type:Double
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

指定されたコマンドについて、コマンド ウィンドウが表示されます。 コマンドレット、関数、CIM コマンドの名前など、1 つのコマンドの名前を入力します。 このパラメーターを省略すると、 Show-Command コンピューターにインストールされているすべてのモジュールのすべての PowerShell コマンドを一覧表示するコマンド ウィンドウが表示されます。

Type:String
Aliases:CommandName
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoCommonParameter

このコマンドレットがコマンド表示の [共通パラメーター] セクションを省略することを示します。 既定では、共通パラメーターはコマンド ウィンドウの下部の展開可能なセクションに表示されます。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。 コマンド文字列を実行するには、コマンド プロンプトでコピーして貼り付けるか、変数に保存し、コマンドレットを Invoke-Expression 使用して変数内の文字列を実行します。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Width

ウィンドウの幅を Show-Command ピクセル単位で指定します。 300 以上で画面の解像度以下の値を入力します (ピクセル単位)。 値が大きすぎてコマンド ウィンドウが画面に表示されていない場合は、 Show-Command エラーが発生します。 既定の幅は 300 ピクセルです。

Type:Double
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

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

出力

None

既定では、このコマンドレットは出力を返しません。

String

PassThru パラメーターを使用すると、このコマンドレットはコマンド文字列を返します。

Object

ErrorPopup パラメーターを使用すると、このコマンドレットはコマンド出力 (任意のオブジェクト) を返します。

メモ

PowerShell には、次のエイリアスが Show-Command含まれています。

  • Windows:
    • shcm

このコマンドレットは、Windows プラットフォームでのみ使用できます。

Show-Command はリモート セッションでは機能しません。