about_Prompts

[アーティクル]
11/06/2024

簡単な説明

Prompt関数について説明し、カスタム Prompt関数を作成する方法を示します。

詳細な説明

PowerShell コマンドプロンプトは、PowerShell でコマンドを実行する準備ができていることを示します。

PS C:\>

PowerShell には、組み込みの Prompt 関数があります。 PowerShell プロファイルスクリプトでは、独自のカスタマイズされた Prompt 関数を定義できます。

Prompt 関数について

Prompt関数は、PowerShell プロンプトの外観を決定します。 PowerShell には組み込みの Prompt 関数が付属していますが、独自の Prompt 関数を定義することでオーバーライドできます。

Prompt関数には、次の構文があります。

function Prompt { <function-body> }

Prompt関数はオブジェクトを返す必要があります。ベストプラクティスとして、文字列または文字列として書式設定されたオブジェクトを返します。推奨される最大長は 80 文字です。

たとえば、次の Prompt 関数は、"Hello, World" 文字列の後に右山かっこ (>) を返します。

PS C:\> function prompt {"Hello, World > "}
Hello, World >

Prompt 関数の取得

Prompt関数を取得するには、Get-Command コマンドレットを使用するか、関数ドライブで Get-Item コマンドレットを使用します。

次に例を示します。

PS C:\> Get-Command Prompt

CommandType     Name      ModuleName
-----------     ----      ----------
Function        prompt

プロンプトの値を設定するスクリプトを取得するには、dot メソッドを使用して、Prompt関数の ScriptBlock プロパティを取得します。

次に例を示します。

(Get-Command Prompt).ScriptBlock

"PS $($executionContext.SessionState.Path.CurrentLocation)$('>' * ($nestedPromptLevel + 1)) "
# .Link
# https://go.microsoft.com/fwlink/?LinkID=225750
# .ExternalHelp System.Management.Automation.dll-help.xml

すべての関数と同様に、 Prompt 関数は Function: ドライブに格納されます。現在の Prompt 関数を作成するスクリプトを表示するには、次のように入力します。

(Get-Item function:prompt).ScriptBlock

既定のプロンプト

既定のプロンプトは、 Prompt 関数がエラーを生成するか、オブジェクトを返さない場合にのみ表示されます。

既定の PowerShell プロンプトは次のとおりです。

PS>

たとえば、次のコマンドは、 Prompt 関数を $nullに設定します。これは無効です。その結果、既定のプロンプトが表示されます。

PS C:\> function prompt {$null}
PS>

PowerShell には組み込みのプロンプトが付属しているため、通常は既定のプロンプトは表示されません。

組み込みプロンプト

PowerShell には、組み込みの Prompt 関数が含まれています。

function prompt {
  "PS $($executionContext.SessionState.Path.CurrentLocation)$('>' * ($nestedPromptLevel + 1)) ";
  # .Link
  # https://go.microsoft.com/fwlink/?LinkID=225750
  # .ExternalHelp System.Management.Automation.dll-help.xml
}

この関数は、 Test-Path コマンドレットを使用して、 $PSDebugContext 自動変数に値があるかどうかをテストします。 $PSDebugContext値がある場合は、デバッグモードで実行し、次のように[DBG]:がプロンプトに追加されます。

[DBG]: PS C:\ps-test>

$PSDebugContextが設定されていない場合、この関数はプロンプトにPSを追加します。また、この関数では、 Get-Location コマンドレットを使用して、現在のファイルシステムディレクトリの場所を取得します。次に、右山かっこ (>) を追加します。

次に例を示します。

PS C:\ps-test>

入れ子になったプロンプトの場合、この関数は 2 つの山かっこ (>>) をプロンプトに追加します。 $NestedPromptLevel自動変数の値が 0 より大きい場合は、入れ子になったプロンプトが表示されます。

たとえば、入れ子になったプロンプトでデバッグする場合、プロンプトは次のプロンプトのようになります。

[DBG] PS C:\ps-test>>>

プロンプトに対する変更

Enter-PSSession コマンドレットは、リモートコンピューターの名前を現在のPrompt関数の先頭に付加します。 Enter-PSSession コマンドレットを使用してリモートコンピューターとのセッションを開始すると、コマンドプロンプトが変更され、リモートコンピューターの名前が含まれます。次に例を示します。

PS Hello, World> Enter-PSSession Server01
[Server01]: PS Hello, World>

その他の PowerShell ホストアプリケーションや代替シェルには、独自のカスタムコマンドプロンプトがある場合があります。

自動変数の $PSDebugContext と $NestedPromptLevel の詳細については、 about_Automatic_Variablesを参照してください。

プロンプトをカスタマイズする方法

プロンプトをカスタマイズするには、新しい Prompt 関数を記述します。この関数は保護されていないため、上書きできます。

Prompt関数を記述するには、次のように入力します。

function prompt { }

次に、中かっこの間に、プロンプトを作成するコマンドまたは文字列を入力します。

たとえば、次のプロンプトにはコンピューター名が含まれます。

function prompt {"PS [$env:COMPUTERNAME]> "}

Server01 コンピューターでは、プロンプトは次のプロンプトのようになります。

PS [Server01] >

次の Prompt 関数には、現在の日時が含まれています。

function prompt {"$(Get-Date)> "}

プロンプトは次のプロンプトのようになります。

03/15/2012 17:49:47>

既定の Prompt 関数を変更することもできます。

たとえば、次の変更された Prompt 関数は、昇格されたセッションで実行するときに、組み込みの PowerShell プロンプトに [ADMIN]: を追加します。

function prompt {
  $identity = [Security.Principal.WindowsIdentity]::GetCurrent()
  $principal = [Security.Principal.WindowsPrincipal] $identity
  $adminRole = [Security.Principal.WindowsBuiltInRole]::Administrator

  $(if (Test-Path variable:/PSDebugContext) { '[DBG]: ' }
    elseif($principal.IsInRole($adminRole)) { "[ADMIN]: " }
    else { '' }
  ) + 'PS ' + $(Get-Location) +
    $(if ($NestedPromptLevel -ge 1) { '>>' }) + '> '
}

Run as administrator オプションを使用して PowerShell を起動すると、次のようなプロンプトが表示されます。

[ADMIN]: PS C:\ps-test>

次の Prompt 関数は、次のコマンドの履歴 ID を表示します。コマンド履歴を表示するには、 Get-History コマンドレットを使用します。

function prompt {
   # The at sign creates an array in case only one history item exists.
   $history = @(Get-History)
   if($history.Count -gt 0)
   {
      $lastItem = $history[$history.Count - 1]
      $lastId = $lastItem.Id
   }

   $nextCommand = $lastId + 1
   $currentDirectory = Get-Location
   "PS: $nextCommand $currentDirectory >"
}

次のプロンプトでは、 Write-Host コマンドレットと Get-Random コマンドレットを使用して、ランダムに色を変更するプロンプトを作成します。 Write-Hostは現在のホストアプリケーションに書き込みますが、オブジェクトを返さないため、この関数には Return ステートメントが含まれます。これを指定しない場合、PowerShell は既定のプロンプト PS>を使用します。

function prompt {
    $color = Get-Random -Min 1 -Max 16
    Write-Host ("PS " + $(Get-Location) +">") -NoNewLine `
     -ForegroundColor $Color
    return " "
}

Prompt 関数の保存

他の関数と同様に、 Prompt 関数は現在のセッションにのみ存在します。今後のセッション用に Prompt 関数を保存するには、PowerShell プロファイルに追加します。プロファイルの詳細については、「about_Profiles」を参照してください。

次の方法で共有

about_Prompts

簡単な説明

詳細な説明

Prompt 関数について

Prompt 関数の取得

既定のプロンプト

組み込みプロンプト

プロンプトに対する変更

プロンプトをカスタマイズする方法

Prompt 関数の保存

関連項目

その他のリソース