PowerShell 中 PSReadline 的详细信息

PowerShell 是一个出色的跨平台任务自动化解决方案。但说实话，您是否感觉 PowerShell 命令行体验中缺少了一些东西？为什么不转向 PSReadline PowerShell 模块？

PSReadline 包含 cmdlet，可让您自定义 PowerShell 体验并为其添加功能。在本教程中，您将了解如何安装最新的 PowerShell 并使用 PSReadline 及其一些更高级的功能。

准备好？继续阅读，将您的 PowerShell 体验提升到新的水平！

先决条件

本教程将是一个实践演示。如果您想跟随，请确保您拥有：

• 运行 Windows、macOS 或 Linux 的系统 - 本教程使用 Windows 10，但更高版本也适用。

• .NET 6 SDK - 本教程使用 v.6.0.203。

• PowerShell 7+ - 本教程使用 PowerShell 7.2.4

安装 PSReadline 模块

在使用 PSReadline 模块之前，您首先必须安装它。就像其他 PowerShell 模块一样，您将运行 Install-Module 来安装 PSReadline 模块。

PSReadline 的 2.x 版本提供了许多功能，例如语法着色、自定义键绑定等。您可以访问 PSReadline 发行说明以获取完整的功能列表。

1. 以管理员身份打开 PowerShell，以确保您可以运行需要提升权限的命令。

2. 接下来，运行下面的 Install-Module 命令以从 PowerShell 库安装 PSReadline 模块。

Install-Module PSReadLine -AllowPrerelease -Force

3. 现在，运行下面的 Get-InstalledModule 命令来验证 PSReadline 模块是否已安装。

Get-InstalledModule -Name PSReadLine

通过 PowerShell 历史记录搜索命令

现在 PSReadLine 模块已安装，您已准备好体验 PowerShell 环境体验。也许您已经多次运行相同的命令。在这种情况下，请使用 Set-PSReadLineKeyHandler cmdlet 启用功能，以便您从历史记录中搜索命令。

PowerShell 历史记录会跟踪您在 PowerShell 控制台上运行的所有命令。通过 PSReadLine 模块，您可以设置按键（通常是向上和向下箭头键）来在历史记录中搜索命令。

运行下面的每个命令以启用可让您通过历史记录搜索命令的功能。这些命令不提供输出，但映射向上和向下箭头键以对历史记录中的命令执行向后和向前搜索。

# Enables Up Arrow key to search backward for commands in the history.
Set-PSReadLineKeyHandler -Key UpArrow -Function HistorySearchBackward
# Enables Up Arrow key to search forward for commands in the history.
Set-PSReadLineKeyHandler -Key DownArrow -Function HistorySearchForward

接下来，按向上或向下箭头键，找到所需的命令后按 Enter 来运行它。

请注意，下面的 PowerShell 会在您的历史记录中搜索与您目前输入的内容相匹配的上一个或下一个命令。当您不喜欢重复运行长或复杂的命令时，此功能非常有用，可以节省您的时间。

将功能绑定到按键

您刚刚将向上和向下箭头键映射到 PowerShell 历史记录中注册的搜索命令。但是你可以将其他键绑定到不同的功能吗？是的！ Get-PSReadlineKeyHandler 将提供绑定和未绑定函数的列表。

1. 运行以下不带参数的命令，该命令默认列出默认的键盘绑定。

Get-PSReadlineKeyHandler

以下只是一长串默认键盘绑定的一部分。此列表有助于刷新您对哪些键调用哪些功能或命令的记忆。

2. 现在，运行下面相同的 Get-PSReadlineKeyHandler 命令，但这次附加 -Unbound 参数。这样做会告诉 Get-PSReadlineKeyHandler 命令仅打印未绑定的键。

您将看到尚未映射到任何键或组合键的功能列表。

Get-PSReadlineKeyHandler -Unbound

您可以看到您还获得了一长串未绑定的密钥。

3. 向下滚动到历史函数部分，您将看到 BeginningOfHistory 命令已解除绑定。

4. 现在，运行以下 Set-PSReadlineKeyHandler 命令，该命令不提供输出，但将 BeginningOfHistory 函数绑定到 Ctrl+b 组合键。

确保 Ctrl+b 组合键内没有空格。

请注意，组合键区分大小写。 Ctrl+b 组合键与 Ctrl+B 不同。因此，您可以选择将 Ctrl+B 绑定到不同的函数。

Set-PSReadLineKeyHandler -Chord Ctrl+b -Function BeginningOfHistory

如果您的按键绑定有多个按键序列，请用冒号分隔按键序列：Ctrl+X:Ctrl+L。

5. 最后，按 Ctrl+b 组合键，PowerShell 会获取历史记录中的第一个命令，如下所示。

启用命令自动建议

如果您的历史记录中有很多命令，那么找到您想要重新运行的命令可能会很困难。如果您之前已经运行了大量命令，那么使用向上和向下箭头键查找目标命令会变得很乏味。那么命令自动建议听起来怎么样？

PSReadline 可以使用 PSReadLineOption 提供命令历史记录建议。此功能可根据您过去使用过的命令完成您的输入。

运行以下命令，该命令不提供输出，但启用命令历史记录建议功能。

Set-PSReadLineOption -PredictionSource History

现在，开始输入目标命令的一部分，您将看到 PowerShell 根据您的历史记录建议可能的命令。内嵌阴影文本显示按向右箭头键将完成的内容。

按向右箭头键接受建议，然后按 Enter 运行命令。

创建命令行预测器

在 PowerShell 中自定义键绑定是让您的工作更快、更轻松的好方法。 PSReadLine 2.x.x 进一步扩展了此功能，允许您创建自己的智能命令行预测器。

要创建命令行 (CLI) 预测器，您将在自己的代码上实现预测 IntelliSense 功能以创建命令行 (CLI) 预测器。当您键入时，此 CLI 预测器会提供有关哪些 cmdlet 或函数可能适合您正在处理的上下文的建议。这些建议基于您的命令历史记录和特定域插件。

您需要 PowerShell 7.2+ 和 PSReadLine 2.2.2+ 才能使用此功能。默认5.1版本的PowerShell不支持此功能。

创建命令行预测器（PowerShell 模块）：

1. 运行以下 dotnet 命令在工作目录中创建基本 .NET 类库项目。您可以根据需要命名该项目，但在本教程中该项目称为 SamplePredictor。

dotnet new classlib --name SamplePredictor

2. 在您的首选文本编辑器中打开项目文件夹 (SamplePredictor) 中的 SamplePredictor.csproj 文件。

3. 现在，将 SamplePredictor.csproj 文件的内容替换为以下代码。

此代码告诉编译器该项目面向 .NET 6.0 并包含对 PowerShell SDK 的引用。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.PowerShell.SDK" Version="7.2.0" />
  </ItemGroup>

</Project>

4. 接下来，删除项目文件夹 (SamplePredictor) 中的默认 Class1.cs 文件。

5. 在文本编辑器上创建一个新的 SamplePredictorClass.cs 文件，然后从随附的 ATA GitHub 存储库复制并粘贴代码。

此代码向 PowerShell 注册您的预测器以便可以使用它，然后在卸载模块时取消注册它。同时，当您的预测器被调用时，此代码会返回“HELLO WORLD”消息。

您会注意到在代码块顶部附近声明了一个标识符变量。此标识符是唯一标识您的预测器的 GUID，以便 PowerShell 可以跟踪它。

6. 现在，在项目文件夹 (SamplePredictor) 中运行以下 dotnet build 命令来构建项目。此命令生成一个扩展名为 .dll（您的 PowerShell 模块）的程序集文件。

此 .dll 文件位于项目文件夹 (SamplePredictor) 内的 bin/Debug/net6.0 中。

dotnet build

您现在已经有了一个 PowerShell 模块，需要将其导入到 PowerShell 会话中（第八步）。

7. 导航至 SamplePredictor/bin/Debug/net6.0 文件夹，验证 .dll 文件是否存在。

8. 运行以下命令，这些命令不提供输出，但执行以下操作：

• Set-PSReadLineOption cmdlet 告诉 PowerShell 使用您创建的预测器 (-PredictionSource HistoryAndPlugin)。

• Import-Module cmdlet 将模块导入到 PowerShell 会话中。

Set-PSReadLineOption -PredictionSource HistoryAndPlugin
Import-Module .\bin\Debug\net6.0\SamplePredictor.dll

9. 现在，运行下面的 Get-PSSubsystem 命令以查看已注册命令预测器的列表。

Get-PSSubsystem -Kind CommandPredictor

您将看到您的预测器出现在列表中，如下所示。

10. 最后，在提示中输入任何内容，您将看到出现内嵌阴影建议，这确认您的预测器正在工作。您现在已经成功编写了 PowerShell 命令预测器！

结论

在本教程中，您学习了如何安装 PSReadline 模块并根据您的喜好自定义 PowerShell 的功能。您使用 C# 语言创建了一个自定义命令预测器，您可以通过更改其输出的消息或其功能来进一步自定义该预测器。

您现在已经充分了解如何使用 PSReadline 模块。但不要停在这里！为什么不使用 Microsoft 辅助标记语言 (MAML) 为您的预测器创建帮助页面？通过帮助页面让您的用户了解如何使用您的预测器及其功能！