about_Prompts

项目
10/07/2023

简短说明

介绍 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 函数，请在 Function 驱动器中使用 Get-Command cmdlet 或使用 Get-Item cmdlet。

例如：

PS C:\> Get-Command Prompt

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

若要获取设置提示符的值的脚本，请使用点方法获取 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 cmdlet 测试 $PSDebugContext 自动变量是否具有值。如果 $PSDebugContext 具有值，则你在调试模式下运行，且 [DBG]: 已添加到提示符，如下所示：

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

如果未填充 $PSDebugContext，则函数会将 PS 添加到提示符。并且，该函数使用 Get-Location cmdlet 获取当前文件系统目录位置。随后，它会添加一个右尖括号 (>)。

例如：

PS C:\ps-test>

如果处于嵌套提示符中，则该函数会将两个尖括号 (>>) 添加到提示符。如果 $NestedPromptLevel 自动变量的值大于 0，则处于嵌套提示符中。

例如，在嵌套提示符中进行调试时，提示符类似于以下提示符：

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

对提示符的更改

Enter-PSSession cmdlet 会将远程计算机的名称追加到当前 Prompt 函数前面。使用 Enter-PSSession cmdlet 启动与远程计算机的会话时，命令提示符会更改为包含远程计算机的名称。例如：

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

其他 PowerShell 主机应用程序和备用 shell 可能具有其自己的自定义命令提示符。

有关 $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 提示符。

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 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 " "
}

保存 Prompt 函数

与任何函数一样，Prompt 函数仅存在于当前会话中。若要保存 Prompt 函数以用于将来的会话，请将它添加到 PowerShell 配置文件中。有关配置文件的详细信息，请参阅 about_Profiles。