Jason Shirk 3e23733fd5 Support 2 key chords
Support for 2 key chords has been added.

There is a small breaking change in Set-PSReadlineKeyHandler
because the -CtrlX switch is no longer needed.  It could have
been left in, but it's better to just remove it - not very
many people use this module yet.

The signature of key handlers was also changed to better support
features that have not yet been implemented.  The signature change
shouldn't affect any existing key handlers because default arguments
should cover those cases.
2013-09-11 17:55:30 -07:00
2013-09-11 17:55:30 -07:00
2013-09-11 17:55:30 -07:00
2013-09-11 17:55:30 -07:00
2013-05-12 23:52:15 -07:00
2013-09-09 11:02:12 -07:00
2013-07-22 10:00:33 -07:00
2013-07-22 10:00:33 -07:00

PSReadLine

This module replaces the command line editing experience in PowerShell.exe. It provides:

  • Syntax coloring
  • Simple syntax error notification
  • A better multi-line experience (both editing and history)
  • Customizable key bindings
  • Cmd and emacs modes (neither are fully implemented yet, but both are usable)
  • Many configuration options
  • Bash style completion (optional in Cmd mode, default in Emacs mode)
  • Emacs yank/kill ring
  • PowerShell token based "word" movement and kill

Many planned features are not yet implemented, but in it's current state, the module is very usable.

The "out of box" experience is meant to be very familiar to PowerShell.exe users - there should be no need to learn any new key strokes.

Usage

To start using, just import the module:

Import-Module PSReadLine

To use Emacs key bindings, you can use:

Set-PSReadlineOption -EditMode Emacs

To view the current key bindings:

Get-PSReadlineKeyHandler

There are many configuration options, see the options to Set-PSReadlineOption. PSReadline has help for it's cmdlets as well as an about_PSReadline topic - see those topics for more detailed help.

To set your own custom keybindings, use the cmdlet Set-PSReadlineKeyHandler. For example, for a better history experience, try:

Set-PSReadlineKeyHandler -Key UpArrow -BriefDescription HistorySearchBackward -Handler { 
    [PSConsoleUtilities.PSConsoleReadLine]::HistorySearchBackward()
}
Set-PSReadlineKeyHandler -Key DownArrow -BriefDescription HistorySearchForward -Handler { 
    [PSConsoleUtilities.PSConsoleReadLine]::HistorySearchForward()
}

With these bindings, up arrow/down arrow will work like PowerShell/cmd if the current command line is blank. If you've entered some text though, it will search the history for commands that start with the currently entered text.

To enable bash style completion without using Emacs mode, you can use:

Set-PSReadlineKeyHandler -Key Tab -BriefDescription Complete -Handler { 
    [PSConsoleUtilities.PSConsoleReadLine]::Complete()
}

See the public methods of [PSConsoleUtilities.PSConsoleReadLine] to see what other built-in functionality you can modify.

If you want to change the command line in some unimplmented way in your custom key binding, you can use the methods:

    [PSConsoleUtilities.PSConsoleReadLine]::GetBufferState
    [PSConsoleUtilities.PSConsoleReadLine]::SetBufferState
S
Description
Automated archival mirror of github.com/PowerShell/PSReadLine
Readme
5.3 MiB
Languages
C# 95.4%
PowerShell 4.6%