about_PSReadLine

简短说明

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

长说明

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

  • 命令行的语法着色
  • 语法错误的可视指示
  • 更好的多行体验(编辑和历史记录)
  • 可自定义密钥绑定
  • Cmd 和 Emacs 模式
  • 许多配置选项
  • Bash 样式完成(在 Cmd 模式下可选,在 Emacs 模式下为默认值)
  • Emacs 洋克/杀环
  • 基于 PowerShell 令牌的“word”移动和删除

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

PSReadLine 2.1.0 随 PowerShell 7.2 一起提供,在所有受支持的 PowerShell 版本中都受支持。 可从 PowerShell 库进行安装。 若要在受支持的 PowerShell 版本中安装 PSReadLine 2.1.0,请运行以下命令。

Install-Module -Name PSReadLine -RequiredVersion 2.1.0

注意

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

Microsoft.PowerShell.PSConsoleReadLine中提供了以下函数。

基本编辑函数

流产

中止当前操作,例如:增量历史记录搜索。

  • Emacs 的: <Ctrl+g>

接受并GetNext

尝试执行当前输入。 如果它可以执行(如 AcceptLine),则在下次调用 ReadLine 时从历史记录中召回下一个项目。

  • Emacs 的: <Ctrl+o>

接受线

尝试执行当前输入。 如果当前输入不完整(例如缺少右括号、方括号或引号),则延续提示将显示在下一行,PSReadLine 等待键编辑当前输入。

  • Cmd:<Enter>
  • Emacs 的: <Enter>
  • Vi 插入模式:<Enter>

AddLine (添加线路)

延续提示显示在下一行上,PSReadLine 等待键编辑当前输入。 这可用于将多行输入作为单个命令输入,即使单行本身完成输入也是如此。

  • Cmd:<Shift+Enter>
  • Emacs 的: <Shift+Enter>
  • Vi 插入模式:<Shift+Enter>
  • Vi 命令模式:<Shift+Enter>

BackwardDeleteChar

删除光标前的字符。

  • Cmd: <Backspace><Ctrl+h>
  • Emacs: <Backspace><Ctrl+Backspace><Ctrl+h>
  • Vi 插入模式:<Backspace>
  • Vi 命令模式:<X><d,h>

向后删除线

与 BackwardKillLine 一样 - 从点到行的开头删除文本,但不会将已删除的文本置于终止环中。

  • Cmd:<Ctrl+Home>
  • Vi 插入模式:<Ctrl+u><Ctrl+Home>
  • Vi 命令模式:<Ctrl+u><Ctrl+Home><d,0>

向后删除单词

删除上一个单词。

  • Vi 命令模式:<Ctrl+w><d,b>

向后杀戮线

清除输入从输入开始到游标的输入。 清除的文本放置在杀伤圈中。

  • Emacs: <Ctrl+u><Ctrl+x,Backspace>

向后杀字

从当前单词的开头清除到光标的输入。 如果光标位于单词之间,则从上一个单词的开头清除输入到游标。 清除的文本放置在杀伤圈中。

  • Cmd: <Ctrl+Backspace><Ctrl+w>
  • Emacs: <Alt+Backspace><Escape,Backspace>
  • Vi 插入模式:<Ctrl+Backspace>
  • Vi 命令模式:<Ctrl+Backspace>

CancelLine (取消线)

取消当前输入,在屏幕上留下输入,但返回到主机,以便再次评估提示。

  • Vi 插入模式:<Ctrl+c>
  • Vi 命令模式:<Ctrl+c>

复制

将所选区域复制到系统剪贴板。 如果未选择任何区域,请复制整行。

  • Cmd:<Ctrl+C>

CopyOrCancelLine (复制或取消线)

如果选择文本,请复制到剪贴板,否则取消该行。

  • Cmd:<Ctrl+c>
  • Emacs 的: <Ctrl+c>

删除在系统剪贴板中放置已删除文本的选定区域。

  • Cmd:<Ctrl+x>

删除字符

删除光标下的字符。

  • Cmd:<Delete>
  • Emacs 的: <Delete>
  • Vi 插入模式:<Delete>
  • Vi 命令模式:<Delete><x><d,l><d,Spacebar>

DeleteCharOrExit

删除光标下的字符,或者如果该行为空,请退出进程。

  • Emacs 的: <Ctrl+d>

DeleteEndOfBuffer

删除到多行缓冲区的末尾。

  • Vi 命令模式:<d,G>

删除Word结束

删除到单词末尾。

  • Vi 命令模式:<d,e>

删除线

删除多行缓冲区的当前逻辑行,启用撤消。

  • Vi 命令模式:<d,d><d,_>

删除上一行

删除上一个请求的逻辑行和多行缓冲区中的当前逻辑行。

  • Vi 命令模式:<d,k>

删除 RelativeLines

从缓冲区的开头删除到多行缓冲区中的当前逻辑行。

与大多数 Vi 命令一样,<d,g,g> 命令可以前面加上一个指定绝对行号的数值参数,该参数与当前行号一起构成要删除的行范围。 如果未指定,则数值参数默认为 1,该参数引用多行缓冲区中的第一个逻辑行。

要从多行中删除的实际行数计算为当前逻辑行号与指定数值参数之间的差异,因此可以是负数。 因此,方法名称 相对 部分。

  • Vi 命令模式:<d,g,g>

删除下一行

删除多行缓冲区中的当前逻辑行和下一个请求的逻辑行。

  • Vi 命令模式:<d,j>

DeleteLineToFirstChar

将光标中的文本删除到行的第一个非空白字符。

  • Vi 命令模式:<d,^>

删除到结束

删除到行尾。

  • Vi 命令模式:<D><d,$>

删除单词

删除下一个单词。

  • Vi 命令模式:<d,w>

转发删除线

与 ForwardKillLine 一样 - 从行的点到终点删除文本,但不将已删除的文本置于杀伤环中。

  • Cmd:<Ctrl+End>
  • Vi 插入模式:<Ctrl+End>
  • Vi 命令模式:<Ctrl+End>

InsertLineAbove

无论光标位于当前行上的位置,都会在当前行上方创建新的空行。 光标移动到新行的开头。

  • Cmd:<Ctrl+Enter>

InsertLineBelow

无论光标位于当前行上的位置,都会在当前行下方创建新的空行。 光标移动到新行的开头。

  • Cmd:<Shift+Ctrl+Enter>

倒置大小写

反转当前字符的情况,并移动到下一个字符。

  • Vi 命令模式:<~>

杀戮线

清除从光标到输入末尾的输入。 清除的文本放置在杀伤圈中。

  • Emacs 的: <Ctrl+k>

KillRegion (杀戮区域)

终止光标和标记之间的文本。

  • 函数未绑定。

杀戮词

清除从光标到当前单词末尾的输入。 如果光标位于单词之间,则输入将从光标清除到下一个单词的末尾。 清除的文本放置在杀伤圈中。

  • Cmd: <Alt+d><Ctrl+Delete>
  • Emacs: <Alt+d><Escape,d>
  • Vi 插入模式:<Ctrl+Delete>
  • Vi 命令模式:<Ctrl+Delete>

粘贴系统剪贴板中的文本。

  • Cmd: <Ctrl+v><Shift+Insert>
  • Vi 插入模式:<Ctrl+v>
  • Vi 命令模式:<Ctrl+v>

重要

使用 粘贴 函数时,剪贴板缓冲区的全部内容将粘贴到 PSReadLine 的输入缓冲区中。 然后,输入缓冲区将传递给 PowerShell 分析器。 使用控制台应用程序的 右键单击 粘贴方法粘贴的输入一次复制到输入缓冲区一个字符。 复制换行符时,输入缓冲区将传递给分析器。 因此,输入一次分析一行。 粘贴方法之间的差异会导致不同的执行行为。

PasteAfter (粘贴后)

将剪贴板粘贴到光标后,将光标移动到粘贴文本的末尾。

  • Vi 命令模式:<p>

PasteBefore (粘贴前)

将剪贴板粘贴到光标之前,将光标移动到粘贴文本的末尾。

  • Vi 命令模式:<P>

PrependAndAccept

前面添加一个“#”并接受该行。

  • Vi 命令模式:<#>

重做

撤消撤消。

  • Cmd:<Ctrl+y>
  • Vi 插入模式:<Ctrl+y>
  • Vi 命令模式:<Ctrl+y>

RepeatLastCommand

重复最后一个文本修改。

  • Vi 命令模式:<.>

还原线

将所有输入还原到当前输入。

  • Cmd:<Escape>
  • Emacs: <Alt+r><Escape,r>

ShellBackwardKillWord (贝壳向后杀字)

从当前单词的开头清除到光标的输入。 如果光标位于单词之间,则从上一个单词的开头清除输入到游标。 清除的文本放置在杀伤圈中。

函数未绑定。

ShellKillWord (贝壳杀字)

清除从光标到当前单词末尾的输入。 如果光标位于单词之间,则输入将从光标清除到下一个单词的末尾。 清除的文本放置在杀伤圈中。

函数未绑定。

交换角色

交换当前字符及其之前的字符。

  • Emacs 的: <Ctrl+t>
  • Vi 插入模式:<Ctrl+t>
  • Vi 命令模式:<Ctrl+t>

撤消

撤消上一次编辑。

  • Cmd:<Ctrl+z>
  • Emacs: <Ctrl+_><Ctrl+x,Ctrl+u>
  • Vi 插入模式:<Ctrl+z>
  • Vi 命令模式:<Ctrl+z><u>

撤消全部

撤消以前对行所做的所有编辑。

  • Vi 命令模式:<U>

UnixWordRubout

从当前单词的开头清除到光标的输入。 如果光标位于单词之间,则从上一个单词的开头清除输入到游标。 清除的文本放置在杀伤圈中。

  • Emacs 的: <Ctrl+w>

验证和接受线

尝试执行当前输入。 如果当前输入不完整(例如缺少右括号、方括号或引号),则延续提示将显示在下一行,PSReadLine 等待键编辑当前输入。

  • Emacs 的: <Ctrl+m>

ViAcceptLine 公司

接受该行并切换到“插入”模式。

  • Vi 命令模式:<Enter>

ViAcceptLineOrExit

与 Emacs 模式下的 DeleteCharOrExit 类似,但接受行而不是删除字符。

  • Vi 插入模式:<Ctrl+d>
  • Vi 命令模式:<Ctrl+d>

ViAppendLine (维附加线)

新行插入到当前行下方。

  • Vi 命令模式:<o>

ViBackwardDeleteGlob

删除上一个单词,仅使用空格作为单词分隔符。

  • Vi 命令模式:<d,B>

ViBackwardGlob (维落后全球)

将光标移回上一个单词的开头,仅使用空格作为分隔符。

  • Vi 命令模式:<B>

ViDeleteBrace 维删除大括号

查找匹配的大括号、括号或方括号,并删除其中的所有内容,包括大括号。

  • Vi 命令模式:<d,%>

ViDeleteEndOfGlob

删除到单词末尾。

  • Vi 命令模式:<d,E>

ViDeleteGlob

删除下一个 glob (空格分隔的单词)。

  • Vi 命令模式:<d,W>

ViDeleteToBeforeChar

在给定字符之前删除。

  • Vi 命令模式:<d,t>

ViDeleteToBeforeCharBackward

在给定字符之前删除。

  • Vi 命令模式:<d,T>

ViDeleteToChar

在给定字符之前删除。

  • Vi 命令模式:<d,f>

ViDeleteToCharBackward

向后删除,直到给定字符。

  • Vi 命令模式:<d,F>

ViInsertAtBeginning (开始插入)

切换到“插入”模式,并将光标定位在行的开头。

  • Vi 命令模式:<I>

ViInsertAtEnd

切换到“插入”模式,并将光标置于行尾。

  • Vi 命令模式:<A>

ViInsertLine 插入

新行插入到当前行上方。

  • Vi 命令模式:<O>

ViInsertWithAppend

从当前行位置追加。

  • Vi 命令模式:<a>

ViInsertWithDelete (维插入删除)

删除当前字符并切换到“插入”模式。

  • Vi 命令模式:<s>

ViJoinLines 公司

联接当前行和下一行。

  • Vi 命令模式:<J>

ViReplaceLine 系列

清除整个命令行。

  • Vi 命令模式:<S><c,c>

ViReplaceToBeforeChar

替换到给定字符为止。

  • Vi 命令模式:<c,t>

ViReplaceToBeforeCharBackward

替换到给定字符为止。

  • Vi 命令模式:<c,T>

ViReplaceToChar

在给定字符之前删除。

  • Vi 命令模式:<c,f>

ViReplaceToCharBackward

替换到给定字符为止。

  • Vi 命令模式:<c,F>

ViYankBeginningOfLine 系列

从缓冲区开头到光标的洋基。

  • Vi 命令模式:<y,0>

ViYankEndOfGlob

从光标到 WORD 结尾的洋克。

  • Vi 命令模式:<y,E>

维扬克EndOfWord

从光标到单词结尾的洋克。

  • Vi 命令模式:<y,e>

维扬克左

光标左侧的洋克字符(s)。

  • Vi 命令模式:<y,h>

维扬克线

对整个缓冲区进行唠叨。

  • Vi 命令模式:<y,y>

ViYankNextGlob

从光标到下一个 WORD 的开头的洋克。

  • Vi 命令模式:<y,W>

维扬克下一个单词

将光标后的单词(s)唠叨。

  • Vi 命令模式:<y,w>

维扬克百分比

从匹配大括号到/从匹配大括号。

  • Vi 命令模式:<y,%>

ViYank上一个全球

从 WORD(s)开始到光标的洋克。

  • Vi 命令模式:<y,B>

维扬克上一个单词

在光标前对单词进行扬克。

  • Vi 命令模式:<y,b>

维扬克赖特

光标下方和右侧的洋克字符。

  • Vi 命令模式:<y,l><y,Spacebar>

ViYankToEndOfLine

从光标到缓冲区末尾的洋基。

  • Vi 命令模式:<y,$>

ViYankToFirstChar

从第一个非空格字符到光标的洋基。

  • Vi 命令模式:<y,^>

美国 佬

将最近终止的文本添加到输入。

  • Emacs 的: <Ctrl+y>

YankLastArg

从上一个历史记录行中获取最后一个参数。 使用参数时,第一次调用它的行为就像 YankNthArg 一样。 如果多次调用,而是循环访问历史记录,而 arg 设置方向(负反方向)。

  • Cmd:<Alt+.>
  • Emacs: <Alt+.>, , <Alt+_><Escape,.><Escape,_>

YankNthArg

从上一个历史记录行获取第一个参数(命令后)。 使用参数时,将第 n 个参数(从 0 开始),如果参数为负,则从最后一个参数开始。

  • Emacs: <Ctrl+Alt+y><Escape,Ctrl+y>

洋克波普

如果上一操作是洋克或洋克Pop,请将之前被延边的文本替换为杀伤环中的下一个终止文本。

  • Emacs: <Alt+y><Escape,y>

游标移动函数

BackwardChar (向后字符)

将光标向左移动一个字符。 这可能会将光标移到上一行多行输入。

  • Cmd:<LeftArrow>
  • Emacs: <LeftArrow><Ctrl+b>
  • Vi 插入模式:<LeftArrow>
  • Vi 命令模式:<LeftArrow><Backspace><h>

BackwardWord

将光标移回当前单词的开头,或者在单词之间移动前一个单词的开头。 Word 边界由一组可配置的字符定义。

  • Cmd:<Ctrl+LeftArrow>
  • Emacs: <Alt+b><Escape,b>
  • Vi 插入模式:<Ctrl+LeftArrow>
  • Vi 命令模式:<Ctrl+LeftArrow>

定义单词边界的字符在 PSConsoleReadLineOptions 对象的 WordDelimiters 属性中配置。 若要查看或更改 WordDelimiters 属性,请参阅 Get-PSReadLineOptionSet-PSReadLineOption

行的起点

如果输入具有多行,则移动到当前行的开头,或者如果已在行的开头,则移动到输入的开头。 如果输入有一行,请移动到输入的开头。

  • Cmd:<Home>
  • Emacs: <Home><Ctrl+a>
  • Vi 插入模式:<Home>
  • Vi 命令模式:<Home>

Line终点

如果输入具有多行,则移动到当前行的末尾,或者如果已在行末尾,则移动到输入的末尾。 如果输入有一行,则移动到输入的末尾。

  • Cmd:<End>
  • Emacs: <End><Ctrl+e>
  • Vi 插入模式:<End>

ForwardChar

将光标向右移动一个字符。 这可能会将光标移到多行输入的下一行。

  • Cmd:<RightArrow>
  • Emacs: <RightArrow><Ctrl+f>
  • Vi 插入模式:<RightArrow>
  • Vi 命令模式:<RightArrow><Space><l>

转发 Word

将光标向前移动到当前单词的末尾,或者在单词之间移动至下一个单词的末尾。 Word 边界由一组可配置的字符定义。

  • Emacs: <Alt+f><Escape,f>

定义单词边界的字符在 PSConsoleReadLineOptions 对象的 WordDelimiters 属性中配置。 若要查看或更改 WordDelimiters 属性,请参阅 Get-PSReadLineOptionSet-PSReadLineOption

GotoBrace

转到匹配的大括号、括号或方括号。

  • Cmd:<Ctrl+]>
  • Vi 插入模式:<Ctrl+]>
  • Vi 命令模式:<Ctrl+]>

转到列

移动到 arg 指示的列。

  • Vi 命令模式:<|>

GotoFirstNonBlankOfLine

将光标移到行中的第一个非空字符。

  • Vi 命令模式:<^><_>

MoveToEndOfLine

将光标移动到输入的末尾。

  • Vi 命令模式:<End><$>

NextLine 系列

将光标移到下一行。

  • 函数未绑定。

下一页

将光标向前移动到下一个单词的开头。 Word 边界由一组可配置的字符定义。

  • Cmd:<Ctrl+RightArrow>
  • Vi 插入模式:<Ctrl+RightArrow>
  • Vi 命令模式:<Ctrl+RightArrow>

定义单词边界的字符在 PSConsoleReadLineOptions 对象的 WordDelimiters 属性中配置。 若要查看或更改 WordDelimiters 属性,请参阅 Get-PSReadLineOptionSet-PSReadLineOption

下一个WordEnd

将光标向前移动到当前单词的末尾,或者在单词之间移动至下一个单词的末尾。 Word 边界由一组可配置的字符定义。

  • Vi 命令模式:<e>

定义单词边界的字符在 PSConsoleReadLineOptions 对象的 WordDelimiters 属性中配置。 若要查看或更改 WordDelimiters 属性,请参阅 Get-PSReadLineOptionSet-PSReadLineOption

上一页

将光标移动到上一行。

  • 函数未绑定。

ShellBackwardWord

将光标移回当前单词的开头,或者在单词之间移动前一个单词的开头。 Word 边界由 PowerShell 令牌定义。

  • 函数未绑定。

壳前字

将光标向前移动到下一个单词的开头。 Word 边界由 PowerShell 令牌定义。

  • 函数未绑定。

ShellNextWord

将光标向前移动到当前单词的末尾,或者在单词之间移动至下一个单词的末尾。 Word 边界由 PowerShell 令牌定义。

  • 函数未绑定。

ViBackwardChar 系列

在 Vi 编辑模式下将光标移到左侧的一个字符。 这可能会将光标移到上一行多行输入。

  • Vi 插入模式:<LeftArrow>
  • Vi 命令模式:<LeftArrow><Backspace><h>

维落后Word

将光标移回当前单词的开头,或者在单词之间移动前一个单词的开头。 Word 边界由一组可配置的字符定义。

  • Vi 命令模式:<b>

定义单词边界的字符在 PSConsoleReadLineOptions 对象的 WordDelimiters 属性中配置。 若要查看或更改 WordDelimiters 属性,请参阅 Get-PSReadLineOptionSet-PSReadLineOption

ViForwardChar

在 Vi 编辑模式下将光标移动到右侧的一个字符。 这可能会将光标移到多行输入的下一行。

  • Vi 插入模式:<RightArrow>
  • Vi 命令模式:<RightArrow><Spacebar><l>

ViEndOfGlob

将光标移动到单词的末尾,仅使用空格作为分隔符。

  • Vi 命令模式:<E>

ViEndOfPreviousGlob

移动到上一个单词的末尾,仅使用空格作为单词分隔符。

  • 函数未绑定。

ViGotoBrace 维戈托大括号

类似于 GotoBrace,但基于字符而不是基于令牌。

  • Vi 命令模式:<%>

ViNextGlob

移动到下一个单词,仅使用空格作为单词分隔符。

  • Vi 命令模式:<W>

ViNextWord

将光标向前移动到下一个单词的开头。 Word 边界由一组可配置的字符定义。

  • Vi 命令模式:<w>

定义单词边界的字符在 PSConsoleReadLineOptions 对象的 WordDelimiters 属性中配置。 若要查看或更改 WordDelimiters 属性,请参阅 Get-PSReadLineOptionSet-PSReadLineOption

历史记录函数

历史的开端

移动到历史记录中的第一项。

  • Emacs 的: <Alt+<>

清除历史记录

清除 PSReadLine 中的历史记录。 这不会影响 PowerShell 历史记录。

  • Cmd:<Alt+F7>

历史结束

移动到历史记录中的最后一项(当前输入)。

  • Emacs 的: <Alt+>>

ForwardSearch历史

通过历史记录执行增量转发搜索。

  • Cmd:<Ctrl+s>
  • Emacs 的: <Ctrl+s>

历史搜索向后

将当前输入替换为 PSReadLine 历史记录中的“上一个”项,该项与开始和输入和游标之间的字符匹配。

  • Cmd:<F8>

历史搜索转发

将当前输入替换为 PSReadLine 历史记录中的“下一步”项,该项与开始和输入和游标之间的字符匹配。

  • Cmd:<Shift+F8>

下一页历史

将当前输入替换为 PSReadLine 历史记录中的“下一步”项。

  • Cmd:<DownArrow>
  • Emacs: <DownArrow><Ctrl+n>
  • Vi 插入模式:<DownArrow>
  • Vi 命令模式:<DownArrow><j><+>

上一页历史

将当前输入替换为 PSReadLine 历史记录中的“上一个”项。

  • Cmd:<UpArrow>
  • Emacs: <UpArrow><Ctrl+p>
  • Vi 插入模式:<UpArrow>
  • Vi 命令模式:<UpArrow><k><->

ReverseSearch历史

通过历史记录执行增量向后搜索。

  • Cmd:<Ctrl+r>
  • Emacs 的: <Ctrl+r>

ViSearchHistoryBackward (视频搜索历史向后)

提示搜索字符串,并在 AcceptLine 上启动搜索。

  • Vi 插入模式:<Ctrl+r>
  • Vi 命令模式:</><Ctrl+r>

完成函数

完成

尝试对光标周围的文本执行完成操作。 如果有多个可能的完成,则最长的明确前缀用于完成。 如果尝试完成最长的明确完成,则会显示可能的完成列表。

  • Emacs 的: <Tab>

尝试对光标周围的文本执行完成操作。 如果有多个可能的完成,则最长的明确前缀用于完成。 如果尝试完成最长的明确完成,则会显示可能的完成列表。

  • Cmd: <Ctrl+@><Ctrl+Spacebar>
  • Emacs 的: <Ctrl+Spacebar>

可能的Completions

显示可能的完成列表。

  • Emacs 的: <Alt+=>
  • Vi 插入模式:<Ctrl+Spacebar>
  • Vi 命令模式:<Ctrl+Spacebar>

TabCompleteNext

尝试完成光标周围的文本,并完成下一个可用完成。

  • Cmd:<Tab>
  • Vi 命令模式:<Tab>

TabCompletePrevious (选项卡上一页)

尝试使用上一个可用完成操作完成光标周围的文本。

  • Cmd:<Shift+Tab>
  • Vi 命令模式:<Shift+Tab>

ViTabComplete下一页

根据需要结束当前编辑组,并调用 TabCompleteNext。

  • Vi 插入模式:<Tab>

ViTabComplete上一个

根据需要结束当前编辑组,并调用 TabCompletePrevious。

  • Vi 插入模式:<Shift+Tab>

杂项函数

AcceptNextSuggestionWord

接受内联或所选建议的下一个单词。

  • 函数未绑定。

接受建议

接受当前内联或所选建议。

  • 函数未绑定。

捕获屏幕

启动交互式屏幕捕获 - 向上/向下箭头选择行,输入所选文本作为文本和 HTML 复制到剪贴板。

  • 函数未绑定。

清屏

清除屏幕并在屏幕顶部绘制当前线条。

  • Cmd:<Ctrl+l>
  • Emacs 的: <Ctrl+l>
  • Vi 插入模式:<Ctrl+l>
  • Vi 命令模式:<Ctrl+l>

DigitArgument (数字参数)

启动要传递给其他函数的新数字参数。 可以将它用作键压调用的下一个函数的乘数。 例如,按 <Alt+1><Alt+0>数字参数 值设置为 10。 然后,按 # 键会将 10 # 个字符(##########)发送到输入行。 同样,可以将此项用于其他作,例如 <Delete>Left-Arrow

  • Cmd: <Alt+0>, , <Alt+1>, , <Alt+2><Alt+3><Alt+4><Alt+5><Alt+6><Alt+7><Alt+8><Alt+9><Alt+->
  • Emacs: <Alt+0><Alt+1>, , , <Alt+2><Alt+3><Alt+4><Alt+5><Alt+6><Alt+7><Alt+8><Alt+9><Alt+->
  • Vi 命令模式:<0><1><2><3><4><5><6><7><8><9>

调用提示

清除当前提示并调用提示函数以重新显示提示。 适用于更改状态的自定义键处理程序。 例如,更改当前目录。

  • 函数未绑定。

ScrollDisplayDown (滚动显示向下)

向下滚动一个屏幕。

  • Cmd:<PageDown>
  • Emacs 的: <PageDown>

ScrollDisplayDownLine

向下滚动一行显示。

  • Cmd:<Ctrl+PageDown>
  • Emacs 的: <Ctrl+PageDown>

ScrollDisplayToCursor (滚动显示到光标)

将显示器滚动到光标。

  • Emacs 的: <Ctrl+End>

ScrollDisplayTop (滚动显示顶部)

将显示器滚动到顶部。

  • Emacs 的: <Ctrl+Home>

ScrollDisplayUp (滚动显示向上)

向上滚动显示一个屏幕。

  • Cmd:<PageUp>
  • Emacs 的: <PageUp>

ScrollDisplayUpLine 系列

向上滚动显示一行。

  • Cmd:<Ctrl+PageUp>
  • Emacs 的: <Ctrl+PageUp>

SelfInsert (自我插入)

插入密钥。

  • 函数未绑定。

ShowKeyBindings

显示所有绑定键。

  • Cmd:<Ctrl+Alt+?>
  • Emacs 的: <Ctrl+Alt+?>
  • Vi 插入模式:<Ctrl+Alt+?>

ViCommandMode

将当前作模式从 Vi-Insert 切换到 Vi-Command。

  • Vi 插入模式:<Escape>

ViDigitArgumentInChord

在 vi 的和弦之一中,启动一个新的数字参数以传递给其他函数。

  • 函数未绑定。

可视化编辑

在由 $env:EDITOR 或 $env:VISUAL 指定的文本编辑器中编辑命令行。

  • Emacs 的: <Ctrl+x,Ctrl+e>
  • Vi 命令模式:<v>

ViExit 出口

退出 shell。

  • 函数未绑定。

ViInsertMode (视频插入模式)

切换到“插入”模式。

  • Vi 命令模式:<i>

WhatIsKey

读取密钥并告诉我密钥的绑定内容。

  • Cmd:<Alt+?>
  • Emacs 的: <Alt+?>

选择函数

ExchangePointAndMark

光标放置在标记的位置,标记将移动到光标的位置。

  • Emacs 的: <Ctrl+x,Ctrl+x>

全选

选择整行。

  • Cmd:<Ctrl+a>

SelectBackwardChar

调整当前所选内容以包含上一个字符。

  • Cmd:<Shift+LeftArrow>
  • Emacs 的: <Shift+LeftArrow>

选择BackwardsLine

调整当前所选内容,以便从光标包含到行的开头。

  • Cmd:<Shift+Home>
  • Emacs 的: <Shift+Home>

SelectBackwardWord

调整当前所选内容以包含上一个单词。

  • Cmd:<Shift+Ctrl+LeftArrow>
  • Emacs 的: <Alt+B>

SelectForwardChar

调整当前所选内容以包含下一个字符。

  • Cmd:<Shift+RightArrow>
  • Emacs 的: <Shift+RightArrow>

选择转发词

调整当前所选内容以使用 ForwardWord 包含下一个单词。

  • Emacs 的: <Alt+F>

选择线

调整当前所选内容,以便从光标包含到行尾。

  • Cmd:<Shift+End>
  • Emacs 的: <Shift+End>

选择下一个单词

调整当前所选内容以包含下一个单词。

  • Cmd:<Shift+Ctrl+RightArrow>

SelectShellBackwardWord

调整当前所选内容以使用 ShellBackwardWord 包含上一个单词。

  • 函数未绑定。

选择 ShellForwardWord

调整当前所选内容以使用 ShellForwardWord 包含下一个单词。

  • 函数未绑定。

SelectShellNextWord

调整当前所选内容以使用 ShellNextWord 包含下一个单词。

  • 函数未绑定。

赛特马克

标记光标的当前位置,以便在后续编辑命令中使用。

  • Emacs 的: <Ctrl+@>

预测 IntelliSense 函数

注意

需要启用预测 IntelliSense 才能使用这些函数。

AcceptNextWordSuggestion

接受预测 IntelliSense 中内联建议的下一个词。 通过运行以下命令,可以将此函数与 Ctrl+F 绑定。

Set-PSReadLineKeyHandler -Chord "Ctrl+f" -Function ForwardWord

接受建议

当光标位于当前行的末尾时,按 RightArrow 接受来自 Predictive IntelliSense 的当前内联建议。

搜索函数

角色搜索

读取字符并向前搜索该字符的下一个匹配项。 如果指定了参数,则向前(如果为负)搜索第 n 个匹配项。

  • Cmd:<F3>
  • Emacs 的: <Ctrl+]>
  • Vi 插入模式:<F3>
  • Vi 命令模式:<F3>

字符搜索向后

读取字符并向后搜索该字符的下一个匹配项。 如果指定了参数,则向后(如果为负)搜索第 n 个匹配项。

  • Cmd:<Shift+F3>
  • Emacs 的: <Ctrl+Alt+]>
  • Vi 插入模式:<Shift+F3>
  • Vi 命令模式:<Shift+F3>

RepeatLastCharSearch

重复最后一次记录的字符搜索。

  • Vi 命令模式:<;>

RepeatLastCharSearchBackwards

重复最后记录的字符搜索,但方向相反。

  • Vi 命令模式:<,>

重复搜索

按照与之前相同的方向重复最后一次搜索。

  • Vi 命令模式:<n>

RepeatSearchBackward

按照与之前相同的方向重复最后一次搜索。

  • Vi 命令模式:<N>

搜索字符

阅读下一个字符,然后找到它,前进,然后返回一个字符。 这是针对“t”功能。

  • Vi 命令模式:<f>

搜索 CharBackward

读取下一个字符,然后找到它,向后,然后返回一个字符。 这是针对“T”功能。

  • Vi 命令模式:<F>

SearchCharBackwardWithBackoff

读取下一个字符,然后找到它,向后,然后返回一个字符。 这是针对“T”功能。

  • Vi 命令模式:<T>

SearchCharWithBackoff

阅读下一个字符,然后找到它,前进,然后返回一个字符。 这是针对“t”功能。

  • Vi 命令模式:<t>

搜索转发

提示搜索字符串,并在 AcceptLine 上启动搜索。

  • Vi 插入模式:<Ctrl+s>
  • Vi 命令模式:<?><Ctrl+s>

自定义键绑定

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

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

大多数键绑定使用一些帮助程序函数来编辑命令行。 下一部分将记录这些 API。

自定义密钥绑定支持 API

以下函数在 Microsoft.PowerShell.PSConsoleReadLine 中公开,但不能直接绑定到密钥。 大多数在自定义密钥绑定中都很有用。

void AddToHistory(string command)

将命令行添加到历史记录中,而无需执行它。

void ClearKillRing()

清除杀手环。 这主要用于测试。

void Delete(int start, int length)

从头开始删除长度字符。 此操作支持撤消/重做。

void Ding()

根据用户首选项执行 Ding 操作。

void GetBufferState([ref] string input, [ref] int cursor)
void GetBufferState([ref] Ast ast, [ref] Token[] tokens,
  [ref] ParseError[] parseErrors, [ref] int cursor)

这两个函数检索有关输入缓冲区的当前状态的有用信息。 第一个更常用于简单情况。 如果绑定使用 Ast 执行更高级的内容,则使用第二个。

IEnumerable[Microsoft.PowerShell.KeyHandler]
  GetKeyHandlers(bool includeBound, bool includeUnbound)

IEnumerable[Microsoft.PowerShell.KeyHandler]
  GetKeyHandlers(string[] Chord)

这两个函数由 Get-PSReadLineKeyHandler使用。 第一个用于获取所有键绑定。 第二个用于获取特定密钥绑定。

Microsoft.PowerShell.PSConsoleReadLineOptions GetOptions()

此函数由 Get-PSReadLineOption 使用,在自定义键绑定中可能不太有用。

void GetSelectionState([ref] int start, [ref] int length)

如果命令行上没有选择,该函数将返回 start 和 length 的 -1。 如果命令行上有选定内容,则返回所选内容的开始和长度。

void Insert(char c)
void Insert(string s)

在光标处插入字符或字符串。 此操作支持撤消/重做。

string ReadLine(runspace remoteRunspace,
  System.Management.Automation.EngineIntrinsics engineIntrinsics)

这是 PSReadLine 的主要入口点。 它不支持递归,因此在自定义键绑定中不起作用。

void RemoveKeyHandler(string[] key)

此函数由 Remove-PSReadLineKeyHandler 使用,在自定义键绑定中可能不太有用。

void Replace(int start, int length, string replacement)

替换某些输入。 此操作支持撤消/重做。 这优先于 Delete,后跟 Insert,因为它被视为撤消的单个操作。

void SetCursorPosition(int cursor)

将光标移动到给定偏移量。 游标移动未跟踪撤消。

void SetOptions(Microsoft.PowerShell.SetPSReadLineOption options)

此函数是 cmdlet Set-PSReadLineOption 使用的帮助程序方法,但对于想要暂时更改设置的自定义键绑定可能很有用。

bool TryGetArgAsInt(System.Object arg, [ref] int numericArg,
  int defaultNumericArg)

此帮助程序方法用于遵循 DigitArgument 的自定义绑定。 典型的调用如下所示

[int]$numericArg = 0
[Microsoft.PowerShell.PSConsoleReadLine]::TryGetArgAsInt($arg,
  [ref]$numericArg, 1)

笔记

命令历史记录

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 尝试筛选出敏感信息。 包含以下字符串的任何命令行都不会写入历史记录文件。

  • 密码
  • asplaintext
  • 代币
  • apikey
  • 机密

反馈并贡献给PSReadLine

GitHub 上的 PSReadLine

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

另请参阅

  • PSReadLine 深受 GNU readline 库的影响。