关于 PSReadLine

简短描述

PSReadLine 在 PowerShell 控制台中提供了改进的命令行编辑体验。

详细描述

PowerShell 7.4 附带 PSReadLine 2.3.4。当前版本是 PSReadLine 2.3.4。当前版本的 PSReadLine 可以在 Windows PowerShell 5.1 及更高版本上安装和使用。对于某些功能，您需要运行 PowerShell 7.2 或更高版本。

PSReadLine 为 PowerShell 控制台提供了强大的命令行编辑体验。它提供：

• 命令行的语法着色
• 语法错误的直观指示
• 更好的多行体验（编辑和历史记录）
• 可定制的按键绑定
• Cmd 和 Emacs 模式
• 许多配置选项
• Bash 样式补全（Cmd 模式下可选，Emacs 模式下默认）
• Emacs 猛拉/杀环
• 基于 PowerShell 令牌的“单词”移动和删除
• 预测智能感知
• 在控制台中动态显示帮助，而不会丢失在命令行中的位置

PSReadLine 需要 PowerShell 5.1 或更高版本。 PSReadLine 可与默认的 Windows 控制台主机、Windows 终端和 Visual Studio Code 配合使用。它在 Windows PowerShell ISE 中不起作用。

PSReadLine 可以从 PowerShell 库安装。要在受支持的 PowerShell 版本中安装 PSReadLine，请运行以下命令。

Install-Module -Name PSReadLine -AllowClobber -Force

笔记

从 PowerShell 7.0 开始，如果检测到屏幕阅读器程序，PowerShell 会在 Windows 上跳过自动加载 PSReadLine。目前，PSReadLine 不能很好地与屏幕阅读器配合使用。 Windows 上 PowerShell 7.0 的默认呈现和格式工作正常。如果需要，您可以手动加载该模块。

预测智能感知

预测性 IntelliSense 是对选项卡完成概念的补充，可帮助用户成功完成命令。它使用户能够根据用户历史记录和其他特定于域的插件的匹配预测来发现、编辑和执行完整命令。

启用预测 IntelliSense

默认情况下，预测式 IntelliSense 处于禁用状态。要启用预测，只需运行以下命令：

Set-PSReadLineOption -PredictionSource History

PredictionSource 参数还可以接受满足域特定和自定义要求的插件。

要禁用预测 IntelliSense，只需运行：

Set-PSReadLineOption -PredictionSource None

笔记

PSReadLine 2.2.6 中默认启用预测式 IntelliSense。有关详细信息，请参阅下面注释部分中的 PSReadLine 发布历史记录。

自定义按键绑定

PSReadLine 支持使用 Set-PSReadLineKeyHandler cmdlet 进行自定义键绑定。例如，大多数自定义键绑定都会调用可绑定函数之一

Set-PSReadLineKeyHandler -Key UpArrow -Function HistorySearchBackward

您可以将 ScriptBlock 绑定到键。 ScriptBlock 几乎可以做您想做的任何事情。一些有用的例子包括

• 编辑命令行
• 打开新窗口（例如帮助）
• 更改目录而不更改命令行

ScriptBlock 接收两个参数：

• $key - 一个 [ConsoleKeyInfo] 对象，它是触发自定义绑定的键。如果你将同一个ScriptBlock绑定到多个按键，并且需要根据按键执行不同的操作，可以勾选$key。许多自定义绑定都会忽略此参数。

• $arg - 任意参数。大多数情况下，这将是用户从键绑定 DigitArgument 传递的整数参数。如果您的绑定不接受参数，则忽略此参数是合理的。

让我们看一个将命令行添加到历史记录而不执行它的示例。当您意识到忘记执行某些操作，但又不想重新输入已经输入的命令行时，这非常有用。

$parameters = @{
    Key = 'Alt+w'
    BriefDescription = 'SaveInHistory'
    LongDescription = 'Save current line in history but do not execute'
    ScriptBlock = {
      param($key, $arg)   # The arguments are ignored in this example

      # GetBufferState gives us the command line (with the cursor position)
      $line = $null
      $cursor = $null
      [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$line,
        [ref]$cursor)

      # AddToHistory saves the line in history, but does not execute it.
      [Microsoft.PowerShell.PSConsoleReadLine]::AddToHistory($line)

      # RevertLine is like pressing Escape.
      [Microsoft.PowerShell.PSConsoleReadLine]::RevertLine()
  }
}
Set-PSReadLineKeyHandler @parameters

您可以在文件 SamplePSReadLineProfile.ps1 中看到更多示例，该文件安装在 PSReadLine 模块文件夹中。

大多数键绑定使用一些辅助函数来编辑命令行。这些 API 记录在 about_PSReadLine_Functions 中。

笔记

命令历史

PSReadLine 维护一个历史文件，其中包含您从命令行输入的所有命令和数据。历史文件是一个名为 $ ($host.Name)_history.txt 的文件。在 Windows 系统上，历史文件存储在 $env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine 中。在非 Windows 系统上，历史文件存储在 $env:XDG_DATA_HOME/powershell/PSReadLine 或 $env:HOME/.local/share/powershell/PSReadLine 中。

历史记录可能包含敏感数据，包括密码。 PSReadLine 尝试过滤掉敏感信息。任何包含以下字符串的命令行都不会写入历史文件。

password

asplaintext

token

apikey

secret

PSReadLine 2.2.0 改进了敏感数据的过滤

• 使用已解析命令行的 PowerShell 抽象语法树 (AST) 来查找敏感数据。

• 使用 SecretManagement 模块中的安全 cmdlet 允许列表来允许将这些命令添加到历史记录中。允许名单包含：

  Get-Secret

Get-SecretInfo

Get-SecretVault

Register-SecretVault

Remove-Secret

Set-SecretInfo

Set-SecretVaultDefault

Test-SecretVault

Unlock-SecretVault

Unregister-SecretVault

例如，允许将以下命令写入历史文件：

Get-Secret PSGalleryApiKey -AsPlainText # Get-Secret is in the allowlist
$token = Get-Secret -Name github-token -Vault MySecret
[MyType]::CallRestAPI($token, $url, $args)
$template -f $token

以下命令不会写入历史文件：

$token = 'abcd' # Assign expr-value to sensitive variable name.
Set-Secret abc $mySecret # Set-Secret is not in the allowlist.
ConvertTo-SecureString stringValue -AsPlainText # '-AsPlainText' is an alert.
Invoke-WebRequest -Token xxx # Expr-value as argument to '-Token'.
Get-ResultFromTwo -Secret1 (Get-Secret -Name blah -AsPlainText) -Secret2 sdv87ysdfayf798hfasd8f7ha # '-Secret2' has expr-value argument.

如果您不想将其他命令写入历史记录文件，可以使用 Set-PSReadLineOption cmdlet 的 AddToHistoryHandler 参数。有关如何使用 AddToHistoryHandler 的示例，请参阅 Set-PSReadLineOption 的示例 7。

PSReadLine 2.3.4 改进了敏感数据的过滤

改进了默认的敏感历史记录清理，以允许历史记录包含安全的属性访问。

当敏感字符串是属性访问的一部分时：

• 如果此成员访问操作不是分配的一部分，那么我们认为它是安全的
• 否则，如果右侧是管道或变量，我们也认为它是安全的

例如，以下用例被认为是安全的，可以保存到历史记录中。

$a.Secret = Get-Secret -Name github-token -Vault MySecret
$a.Secret = $secret
$a.Password.Secret | Set-Value
$token = (Get-AzAccessToken -ResourceUrl 'https://app.contoso.com').Token

该版本还改进了敏感历史记录清理，以允许使用 az、gcloud 和 kubectl 命令行工具检索令牌。

例如，以下用例被认为是安全的，可以保存到历史记录中。

kubectl get secrets
kubectl get secret db-user-pass -o jsonpath='{.data.password}' | base64 --decode
kubectl describe secret db-user-pass
az account get-access-token --resource=https://app.contoso.com --query accessToken --output tsv
$env:PGPASS = gcloud auth print-access-token

PSReadLine 发布历史

自 Windows PowerShell 5.1 中发布的版本以来，PSReadLine 已进行了许多更新。

• 当前版本是 PSReadLine 2.3.4
• PowerShell 7.4 附带 PSReadLine 2.3.4
• PowerShell 7.3 附带 PSReadLine 2.2.6
• PowerShell 7.2 附带 PSReadLine 2.1.0
• PowerShell 7.0.11 附带 PSReadLine 2.0.4
• PowerShell 5.1 附带 PSReadLine 2.0.0

有关更改的完整列表，请参阅 PSReadLine 更改日志。

• PSReadLine 2.3.4

除了多个错误修复之外，此版本还包括以下增强功能：

• 用于预测 IntelliSense 的可滚动 ListView

  • 根据终端窗口的大小自动调整大小
• 最多可包含 50 个预测结果
• 显示结果数量和当前预测源的动态列表标题

向 PSReadLine 提供反馈和贡献

GitHub 上的 PSReadLine

请随意提交拉取请求或在 GitHub 页面上提交反馈。

参见

• PSReadLine 深受 GNU readline 库的影响。