關於提示字元

發行項
05/09/2024

簡短描述

描述函 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 Cmdlet 或使用 Get-Item 函式磁碟驅動器中的 Cmdlet。

例如：

PS C:\> Get-Command Prompt

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

若要取得設定提示值的腳本，請使用 dot 方法來取得函式的 PromptScriptBlock 屬性。

例如：

(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 使用 Cmdlet 來判斷是否已 $PSDebugContext 填入自動變數。如果 $PSDebugContext 已填入，表示您處於偵錯模式，並 [DBG]: 新增至提示，如下所示：

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

如果未 $PSDebugContext 填入，函式會新增 PS 至提示。而且，函式會 Get-Location 使用 Cmdlet 來取得目前的檔案系統目錄位置。然後，它會新增右角括號 (>) 。

例如：

PS C:\ps-test>

如果您在巢狀提示字元中，函式會將兩個角括號 (>>) 新增至提示。 (如果自動變數的值 $NestedPromptLevel 大於 1.) ，您會在巢狀提示中

例如，當您在巢狀的提示字元中偵錯時，提示字元會類似下列提示字元︰

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

提示的變更

Cmdlet 會在 Enter-PSSession 遠端電腦的名稱前面加上目前 Prompt 函式。當您使用 Enter-PSSession Cmdlet 來啟動與遠端電腦的工作階段時，命令提示字元會變更為包含遠端電腦的名稱。例如：

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

其他 PowerShell 主機應用程式和替代殼層可能會有自己的自定義命令提示字元。

如需和 $NestedPromptLevel 自動變數的詳細資訊$PSDebugContext，請參閱 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 函式：

例如，使用 [以系統管理員身分執行] 選項開啟 PowerShell 時，下列已修改的Prompt函式會新增[ADMIN]:至內建 PowerShell 提示字元：

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

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

當您使用 [以 系統管理員身分執行 ] 選項啟動 PowerShell 時，會出現類似下列提示的提示：

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

下列 Prompt 函式會顯示下一個命令的歷程記錄標識碼。若要檢視命令歷程記錄，請使用 Get-History Cmdlet。

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 Cmdlet 來建立隨機變更色彩的提示。因為 Write-Host 寫入目前的主應用程式但不會傳回物件，所以此函式包含 Return 語句。如果沒有，PowerShell 會使用預設提示。 PS>

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