Get-PSReadLineKeyHandler
Gets the key bindings for the PSReadLine module.
Syntax
Get-PSReadLineKeyHandler
[-Bound]
[-Unbound]
[<CommonParameters>] Get-PSReadLineKeyHandler
[-Chord] <String[]>
[<CommonParameters>] Description
If no parameter is specified, returns the currently bound key functions for the PSReadLine module.
If Chord parameter is specified, the cmdlet returns the specific bound keys.
Examples
Example 1: Get all key mappings
This command returns all key mappings, bound and unbound.
Get-PSReadLineKeyHandler -Bound -Unbound
Key Function Description
--- -------- -----------
Enter AcceptLine Accept the input or move to the next line if input is missing a closing token.
Shift+Enter AddLine Move the cursor to the next line without attempting to execute the input
Escape RevertLine Equivalent to undo all edits (clears the line except lines imported from history)
LeftArrow BackwardChar Move the cursor back one character
RightArrow ForwardChar Move the cursor forward one character
Ctrl+LeftArrow BackwardWord Move the cursor to the beginning of the current or previous word
Ctrl+RightArrow NextWord Move the cursor forward to the start of the next word
Shift+LeftArrow SelectBackwardChar Adjust the current selection to include the previous character
Shift+RightArrow SelectForwardChar Adjust the current selection to include the next character
Ctrl+Shift+LeftArrow SelectBackwardWord Adjust the current selection to include the previous word
Ctrl+Shift+RightArrow SelectNextWord Adjust the current selection to include the next word
UpArrow PreviousHistory Replace the input with the previous item in the history
DownArrow NextHistory Replace the input with the next item in the history
Home BeginningOfLine Move the cursor to the beginning of the line
End EndOfLine Move the cursor to the end of the line
Shift+Home SelectBackwardsLine Adjust the current selection to include from the cursor to the end of the line
Shift+End SelectLine Adjust the current selection to include from the cursor to the start of the line
Delete DeleteChar Delete the character under the cursor
Backspace BackwardDeleteChar Delete the character before the cursor
Ctrl+Spacebar MenuComplete Complete the input if there is a single completion, otherwise complete the input by selecting from a menu o...
Tab TabCompleteNext Complete the input using the next completion
Shift+Tab TabCompletePrevious Complete the input using the previous completion
Ctrl+a SelectAll Select the entire line. Moves the cursor to the end of the line
Ctrl+c CopyOrCancelLine Either copy selected text to the clipboard, or if no text is selected, cancel editing the line with Cancel...
Ctrl+C Copy Copy selected region to the system clipboard. If no region is selected, copy the whole line
Ctrl+l ClearScreen Clear the screen and redraw the current line at the top of the screen
Ctrl+r ReverseSearchHistory Search history backwards interactively
...Example 2: Get bound keys
This command returns only bound keys and key combinations.
Get-PSReadLineKeyHandler
Key Function Description
--- -------- -----------
Enter AcceptLine Accept the input or move to the next line if input is missing a closing token.
Shift+Enter AddLine Move the cursor to the next line without attempting to execute the input
Escape RevertLine Equivalent to undo all edits (clears the line except lines imported from history)
LeftArrow BackwardChar Move the cursor back one character
RightArrow ForwardChar Move the cursor forward one character
Ctrl+LeftArrow BackwardWord Move the cursor to the beginning of the current or previous word
Ctrl+RightArrow NextWord Move the cursor forward to the start of the next word
Shift+LeftArrow SelectBackwardChar Adjust the current selection to include the previous character
Shift+RightArrow SelectForwardChar Adjust the current selection to include the next character
Ctrl+Shift+LeftArrow SelectBackwardWord Adjust the current selection to include the previous word
Ctrl+Shift+RightArrow SelectNextWord Adjust the current selection to include the next word
UpArrow PreviousHistory Replace the input with the previous item in the history
DownArrow NextHistory Replace the input with the next item in the history
Home BeginningOfLine Move the cursor to the beginning of the line
End EndOfLine Move the cursor to the end of the line
Shift+Home SelectBackwardsLine Adjust the current selection to include from the cursor to the end of the line
Shift+End SelectLine Adjust the current selection to include from the cursor to the start of the line
Delete DeleteChar Delete the character under the cursor
Backspace BackwardDeleteChar Delete the character before the cursor
Ctrl+Spacebar MenuComplete Complete the input if there is a single completion, otherwise complete the input by selecting from a menu o...
Tab TabCompleteNext Complete the input using the next completion
...Example 3: Get specific key bindings
This command returns only the bindings for the specified keys.
Get-PSReadLineKeyHandler -Chord Enter, Shift+Enter
Key Function Description
--- -------- -----------
Enter AcceptLine Accept the input or move to the next line if input is missing a closing token.
Shift+Enter AddLine Move the cursor to the next line without attempting to execute the input
...Parameters
-Bound
Indicates that this cmdlet returns functions that are bound.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | True |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Chord
Return only functions bound to specific keys or sequences.
| Type: | String[] |
| Aliases: | Key |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Unbound
Indicates that this cmdlet returns functions that are unbound.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
This cmdlet returns a KeyHandler object.