about_Prompts

[アーティクル]
03/23/2022

簡単な説明

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

長い説明

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

PS C:\>

PowerShell プロンプトは、組み込み関数によって決定 Prompt されます。独自の関数を作成し、 Prompt PowerShell プロファイルに保存することで、プロンプトをカスタマイズできます。

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 メソッドを使用して関数の ScriptBlock プロパティを取得 Prompt します。

次に例を示します。

(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 {
    $(if (Test-Path variable:/PSDebugContext) { '[DBG]: ' }
      else { '' }) + 'PS ' + $(Get-Location) +
        $(if ($NestedPromptLevel -ge 1) { '>>' }) + '> '
}

関数は、コマンドレットを 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 変更された関数は、[ [ADMIN]: 管理者として実行] オプションを使用して PowerShell を開いた場合に、組み込みの PowerShell プロンプトに追加 されます。

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) { '>>' }) + '> '
}

[管理者として実行] オプションを使用して 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 関数の保存

関連項目

フィードバック