about_PSReadLine

简短说明

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

详细说明

PowerShell 7.2 随 PSReadLine 2.1.0 一起提供。 有较新版本可用。 可以在 Windows PowerShell 5.1 及更新版本上安装和使用 PSReadLine 的当前版本。 对于某些功能,需要运行 PowerShell 7.2 或更高版本。

PSReadLine 为 PowerShell 控制台提供强大的命令行编辑体验。 提供以下功能:

  • 命令行的语法着色
  • 语法错误的直观指示
  • 编辑和历史记录) (更好的多行体验
  • 可自定义的键绑定
  • Cmd 和 Emacs 模式
  • 许多配置选项
  • Bash 样式完成在 Cmd 模式下 (可选,在 Emacs 模式下默认)
  • 埃马克扬克/杀环
  • 基于 PowerShell 令牌的“word”移动和删除
  • 预测 IntelliSense
  • 在控制台中动态显示“帮助”,而不会丢失命令行上的位置

PSReadLine 需要 PowerShell 5.1 或更高版本。 PSReadLine 适用于默认的 Windows 控制台主机、窗口终端和Visual Studio Code。 它在Windows PowerShell ISE 中不起作用。

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

Install-Module -Name PSReadLine -AllowClobber -Force

注意

从 PowerShell 7.0 开始,如果检测到屏幕阅读器程序,PowerShell 将跳过在 Windows 上自动加载 PSReadLine。 目前,PSReadLine 无法很好地与屏幕阅读器配合使用。 Windows 上 PowerShell 7.0 的默认呈现和格式设置正常工作。 如有必要,可以手动加载模块。

预测 IntelliSense

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

启用预测 IntelliSense

预测性 IntelliSense 默认禁用。 若要启用预测,只需运行以下命令:

Set-PSReadLineOption -PredictionSource History

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

若要禁用预测 IntelliSense,只需运行:

Set-PSReadLineOption -PredictionSource None

注意

在 PSReadLine 2.2.6 中默认启用预测 IntelliSense。 有关详细信息,请参阅下面的“说明”部分中的 PSReadLine 发布历史记录

自定义键绑定

PSReadLine 支持使用 cmdlet 的 Set-PSReadLineKeyHandler 自定义密钥绑定。 大多数自定义键绑定调用 可绑定函数之一,例如

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$HOME/.local/share/powershell/PSReadLine

历史记录可能包含包括密码在内的敏感数据。 PSReadLine 尝试筛选出敏感信息。 包含以下字符串的任何命令行不会写入历史记录文件。

  • password
  • asplaintext
  • 令牌
  • 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.

PSReadLine 发布历史记录

自 Windows PowerShell 5.1 中随附的版本以来,PSReadLine 已经进行了许多更新。

  • POWERShell 7.3 随 PSReadLine 2.2.6 一起提供
  • POWERShell 7.2.5 随 PSReadLine 2.1.0 一起提供
  • POWERShell 7.0.11 随 PSReadLine 2.0.4 一起提供
  • POWERShell 5.1 随 PSReadLine 2.0.0 一起提供

有关更改的完整列表,请参阅 PSReadLine ChangeLog

  • PSReadLine 2.2.6

    在此版本中,预测 IntelliSense 功能默认启用,具体取决于以下条件:

    • 如果支持虚拟终端 (VT) ,并且 PSReadLine 在 PowerShell 7.2 或更高版本中运行, 则 PredictionSource 设置为 HistoryAndPlugin
    • 如果支持 VT,并且 PSReadLine 在 7.2 之前的 PowerShell 中运行, 则 PredictionSource 设置为 History
    • 如果不支持 VT,则 PredictionSource 设置为 None
  • PSReadLine 2.2.5

    带有小 bug 修复的官方服务版本。

  • PSReadLine 2.2.2

    • PSReadLine 添加了两个新的预测 IntelliSense 功能:
      • 添加了 PredictionViewStyle 参数,以允许选择新的 ListView
      • 将 PSReadLine 连接到 CommandPrediction PowerShell 7.2 中引入的 API,以允许用户导入可呈现自定义源中建议的预测器模块。
    • 更新为使用 1.0.0 版 Microsoft.PowerShell.Pager 获取动态帮助
    • 改进了敏感历史记录项的清理
    • 大量 bug 修复和较小的改进
  • PSReadLine 2.1.0

    此版本汇总了自 2.0.4 版本以来添加的以下增强功能:

    • 从命令历史记录添加预测 IntelliSense 建议
    • 许多 bug 修复和 API 增强功能
  • PSReadLine 2.0.4

    此版本汇总了自 2.0.0 版本以来添加的以下增强功能:

    • -Chord向 添加了 参数Get-PSReadLineKeyHandler,以允许搜索特定键绑定

参与 PSReadLine 的反馈&

GitHub 上的 PSReadLine

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

另请参阅

  • PSReadLine 受到 GNU 读行 库的严重影响。