alexinslc / PSReadLine

A bash inspired readline implementation for PowerShell

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

#PSReadLine

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

  • Syntax coloring
  • Simple syntax error notification
  • A good 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)
  • Bash/zsh style interactive history search (CTRL-R)
  • Emacs yank/kill ring
  • PowerShell token based "word" movement and kill
  • Undo/redo
  • Automatic saving of history, including sharing history across live sessions
  • "Menu" completion (somewhat like Intellisense, select completion with arrows) via Ctrl+Space

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.

Keith Hill wrote a great introduction to PSReadline here

Ed Wilson (Scripting Guy) wrote a series on PSReadline, starting here

##Installation

PSReadline builds are available in two places, GitHub and the PowerShell Gallery. The most recent builds will be published to the PowerShell Gallery until they are considered stable and then will be published on GitHub.

To install from the PowerShell Gallery, you will need a recent build of WMF5. If you have WMF5 already, you can just run Install-Module PSReadline.

To install the build from GitHub, you can install using PsGet (very easy to install), and run Install-Module PSReadline. Note that Install-Module from PsGet is different than Install-Module with WMF5.

Alternatively, download the file PSReadline.zip and extract the contents into your C:\Users\[User]\Documents\WindowsPowerShell\modules\PSReadline folder. (You may have to create these directories if they don't exist.)

Next edit your profile to import the module. There are two common profile files commonly used and the instructions are slightly different for each.

The file C:\Users\[User]\Documents\WindowsPowerShell\profile.ps1 is used for all hosts (e.g. the ISE and powershell.exe). If you already have this file, then you should add the following:

if ($host.Name -eq 'ConsoleHost')
{
    Import-Module PSReadline
}

Alternatively, the file C:\Users\[User]\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 is for powershell.exe only. Using this file, you can simply add:

Import-Module PSReadLine  

In either case, you can create the appropriate file if you don't already have one.

##Upgrading

If you installed with PSGet or WMF5, you can run Update-Module PSReadLine.

If you've added it to your $PROFILE, when you run Update-Module PSReadLine you will get the following error

Remove-Item : Cannot remove item
C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\PSReadline.dll: Access to the path
'C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\PSReadline.dll' is denied.
At C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PsGet\PsGet.psm1:1009 char:52
  1. Run cmd.exe
  2. powershell -noprofile
  3. Update-Module PSReadLine

##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 -Function HistorySearchBackward
Set-PSReadlineKeyHandler -Key DownArrow -Function 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 -Function Complete

Here is a more interesting example of what is possible:

Set-PSReadlineKeyHandler -Chord 'Oem7','Shift+Oem7' `
                         -BriefDescription SmartInsertQuote `
                         -LongDescription "Insert paired quotes if not already on a quote" `
                         -ScriptBlock {
    param($key, $arg)

    $line = $null
    $cursor = $null
    [PSConsoleUtilities.PSConsoleReadline]::GetBufferState([ref]$line, [ref]$cursor)

    if ($line[$cursor] -eq $key.KeyChar) {
        # Just move the cursor
        [PSConsoleUtilities.PSConsoleReadline]::SetCursorPosition($cursor + 1)
    }
    else {
        # Insert matching quotes, move cursor to be in between the quotes
        [PSConsoleUtilities.PSConsoleReadline]::Insert("$($key.KeyChar)" * 2)
        [PSConsoleUtilities.PSConsoleReadline]::GetBufferState([ref]$line, [ref]$cursor)
        [PSConsoleUtilities.PSConsoleReadline]::SetCursorPosition($cursor - 1)
    }
}

In this example, when you type a single quote or double quote, there are two things that can happen. If the character following the cursor is not the quote typed, then a matched pair of quotes is inserted and the cursor is placed inside the the matched quotes. If the character following the cursor is the quote typed, the cursor is simply moved past the quote without inserting anything. If you use Resharper or another smart editor, this experience will be familiar.

Note that with the handler written this way, it correctly handles Undo - both quotes will be undone with one undo.

The sample profile file has a bunch of great examples to check out. This file is included when PSReadline is installed.

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]::Insert
    [PSConsoleUtilities.PSConsoleReadLine]::Replace
    [PSConsoleUtilities.PSConsoleReadLine]::SetCursorPosition

##Change Log

The change log is available here.

##License

The license is available here.

ezoic increase your site revenue

About

A bash inspired readline implementation for PowerShell

License:BSD 2-Clause "Simplified" License


Languages

Language:C# 94.0%Language:PowerShell 6.0%