https://github.com/PowerShell/PSReadLine Skip to content Sign up * Product + Features + Mobile + Actions + Codespaces + Packages + Security + Code review + Issues + Integrations + GitHub Sponsors + Customer stories * Team * Enterprise * Explore + Explore GitHub + Learn and contribute + Topics + Collections + Trending + Learning Lab + Open source guides + Connect with others + The ReadME Project + Events + Community forum + GitHub Education + GitHub Stars program * Marketplace * Pricing + Plans + Compare plans + Contact Sales + Education [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} PowerShell / PSReadLine Public * Notifications * Fork 246 * Star 2.5k A bash inspired readline implementation for PowerShell BSD-2-Clause License 2.5k stars 246 forks Star Notifications * Code * Issues 176 * Pull requests 5 * Discussions * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 1 branch 30 tags Code Latest commit @daxian-dbw daxian-dbw Update comment message to use 2.2.2 as the latest version (#3218) ... 38395ad Feb 22, 2022 Update comment message to use `2.2.2` as the latest version (#3218) 38395ad Git stats * 948 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github Trigger the GitHub action by issue-open event (#3041) Nov 16, 2021 .vscode Enable building with dotnet cli for non-Windows (#692) Sep 30, 2018 .vsts-ci Update build agent again to use PSMMS2019-Secure (#3187) Jan 27, 2022 MockPSConsole Update the version of PowerShell nuget packages to 7.2.0 (#3170) Jan 18, 2022 PSReadLine Prepare for the 2.2.2 release of PSReadLine (#3217) Feb 22, 2022 Polyfill Update the version of PowerShell nuget packages to 7.2.0 (#3170) Jan 18, 2022 test Update the version of PowerShell nuget packages to 7.2.0 (#3170) Jan 18, 2022 tools Update comment message to use 2.2.2 as the latest version (#3218) Feb 22, 2022 .gitignore Correct the default foreground/background colors (#1435) Mar 30, 2020 License.txt Remove MIT License, move License.txt to root and update build script (#... Apr 20, 2020 PSReadLine.build.ps1 Add private contract delegate for PSES to handle idle (#1679) Oct 27, 2021 README.md Minor update to the README.md to better organize the resources abou... Jan 12, 2022 appveyor.yml Update build as we move help content to PowerShell-Docs (#1537) May 19, 2020 build.ps1 Update PSReadLine corresponding to the prediction interface update (# ... Feb 23, 2021 nuget.config Update nuget.config based on guidance (#2003) Dec 1, 2020 View code [ ] PSReadLine Installation Install from PowerShellGallery (preferred) Install from GitHub (deprecated) Post Installation Upgrading Usage Developing and Contributing Building Change Log Licensing Code of Conduct README.md appveyor-build-status PSReadLine This module replaces the command line editing experience of PowerShell for versions 3 and up. 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 users - there should be no need to learn any new key strokes. Some good resources about PSReadLine: * Keith Hill wrote a great introduction (2013) to PSReadLine. * Ed Wilson (Scripting Guy) wrote a series (2014-2015) on PSReadLine. * John Savill has a video (2021) covering installation, configuration, and tailoring PSReadLine to your liking. Installation There are multiple ways to install PSReadLine. Install from PowerShellGallery (preferred) You will need the 1.6.0 or a higher version of PowerShellGet to install the latest prerelease version of PSReadLine. Windows PowerShell 5.1 ships an older version of PowerShellGet which doesn't support installing prerelease modules, so Windows PowerShell users need to install the latest PowerShellGet (if not yet) by running the following commands from an elevated Windows PowerShell session: Install-Module -Name PowerShellGet -Force Exit After installing PowerShellGet, you can get the latest prerelease version of PSReadLine by running Install-Module PSReadLine -AllowPrerelease -Force If you only want to get the latest stable version, run: Install-Module PSReadLine [!NOTE] Prerelease versions will have newer features and bug fixes, but may also introduce new issues. If you are using Windows PowerShell on Windows 10 or using PowerShell 6+, PSReadLine is already installed. Windows PowerShell on the latest Windows 10 has version 2.0.0-beta2 of PSReadLine. PowerShell 6+ versions have the newer prerelease versions of PSReadLine. Install from GitHub (deprecated) With the preview release of PowerShellGet for PowerShell V3/V4, downloads from GitHub are deprecated. We don't intend to update releases on GitHub, and may remove the release entirely from GitHub at some point. Post Installation If you are using Windows PowerShell V5 or V5.1 versions, or using PowerShell 6+ versions, you are good to go and can skip this section. Otherwise, you need to edit your profile to import the module. There are two 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 When running one of the suggested commands below, be sure to exit all instances of powershell.exe, pwsh.exe or pwsh, including those opened in VSCode terminals. Then, to make sure PSReadLine isn't loaded: * if you are on Windows, run the suggested command below from cmd.exe, powershell_ise.exe, or via the Win+R shortcut; * if you are on Linux/macOS, run the suggested command below from the default terminal (like bash or zsh). If you are using the version of PSReadLine that ships with Windows PowerShell, you need to run: powershell -noprofile -command "Install-Module PSReadLine -Force -SkipPublisherCheck -AllowPrerelease". Note: you will need to make sure PowershellGet is updated before running this command. If you are using the version of PSReadLine that ships with PowerShell 6+ versions, you need to run: -noprofile -command "Install-Module PSReadLine -Force -SkipPublisherCheck -AllowPrerelease". If you've installed PSReadLine yourself from the PowerShell Gallery, you can simply run: powershell -noprofile -command "Update-Module PSReadLine -AllowPrerelease" or -noprofile -command "Update-Module PSReadLine -AllowPrerelease", depending on the version of PowerShell you are using. If you get an error like: Remove-Item : Cannot remove item C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\Microsoft.PowerShell.PSReadLine.dll: Access to the path 'C:\Users\{yourName}\Documents\WindowsPowerShell\Modules\PSReadLine\Microsoft.PowerShell.PSReadLine.dll' is denied. or a warning like: WARNING: The version '2.0.0' of module 'PSReadLine' is currently in use. Retry the operation after closing the applications. Then you didn't kill all the processes that loaded 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 [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$line, [ref]$cursor) if ($line[$cursor] -eq $key.KeyChar) { # Just move the cursor [Microsoft.PowerShell.PSConsoleReadLine]::SetCursorPosition($cursor + 1) } else { # Insert matching quotes, move cursor to be in between the quotes [Microsoft.PowerShell.PSConsoleReadLine]::Insert("$($key.KeyChar)" * 2) [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$line, [ref]$cursor) [Microsoft.PowerShell.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 [Microsoft.PowerShell.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: [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState [Microsoft.PowerShell.PSConsoleReadLine]::Insert [Microsoft.PowerShell.PSConsoleReadLine]::Replace [Microsoft.PowerShell.PSConsoleReadLine]::SetCursorPosition Developing and Contributing Please see the Contribution Guide for how to develop and contribute. Building To build PSReadLine on Windows, Linux, or macOS, you must have the following installed: * .NET Core SDK 2.1.802 or a newer version * The PowerShell modules InvokeBuild and platyPS The build script build.ps1 can be used to bootstrap, build and test the project. * Bootstrap: ./build.ps1 -Bootstrap * Build: + Targeting .NET 4.6.1 (Windows only): ./build.ps1 -Configuration Debug -Framework net461 + Targeting .NET Core: ./build.ps1 -Configuration Debug -Framework netcoreapp2.1 * Test: + Targeting .NET 4.6.1 (Windows only): ./build.ps1 -Test -Configuration Debug -Framework net461 + Targeting .NET Core: ./build.ps1 -Test -Configuration Debug -Framework netcoreapp2.1 After build, the produced artifacts can be found at /bin/Debug. Change Log The change log is available here. Licensing PSReadLine is licensed under the 2-Clause BSD License. Code of Conduct This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. About A bash inspired readline implementation for PowerShell Resources Readme License BSD-2-Clause License Stars 2.5k stars Watchers 73 watching Forks 246 forks Releases 26 PSReadLine v2.2.2 GA Release Latest Feb 22, 2022 + 25 releases Packages 0 No packages published Contributors 52 * @lzybkr * @daxian-dbw * @srdubya * @springcomp * @SteveL-MSFT * @msftrncs * @jazzdelightsme * @cbadke * @TylerLeonhardt * @parkovski * @theaquamarine + 41 contributors Languages * C# 94.7% * PowerShell 5.3% * (c) 2022 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.