Skip to content

Update release notes for PSReadLine 2.4.5 #12860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sdwheeler merged 1 commit into from
Mar 18, 2026
Merged

Update release notes for PSReadLine 2.4.5 #12860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions reference/5.1/PSReadLine/About/about_PSReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
---
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
Locale: en-US
ms.date: 08/18/2025
ms.date: 03/18/2026
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_PSReadLine
---
# about_PSReadLine

## SHORT DESCRIPTION
## Short description

PSReadLine provides an improved command-line editing experience in the
PowerShell console.

## LONG DESCRIPTION
## Long description

There have been many updates to PSReadLine since the version that ships in
Windows PowerShell 5.1.

- v2.4.5 first shipped in PowerShell 7.6.0-rc.1
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
Expand Down Expand Up @@ -45,6 +46,9 @@ PowerShell console. It provides:
- Bash style completion (optional in Cmd mode, default in Emacs mode)
- Emacs yank/kill-ring
- PowerShell token based "word" movement and deletion
- Predictive IntelliSense
- Dynamic display of Help in the console without losing your place on the
command line

PSReadLine requires PowerShell 5.1, or newer. PSReadLine works with the default
Windows console host, Windows Terminal, and Visual Studio Code. It doesn't work
Expand All @@ -57,7 +61,32 @@ in a supported version of PowerShell run the following command.
Install-Module -Name PSReadLine -AllowClobber -Force
```

## CUSTOM KEY BINDINGS
## Predictive IntelliSense

Predictive IntelliSense is an addition to the concept of tab completion that
assists the user in successfully completing commands. It enables users to
discover, edit, and execute full commands based on matching predictions from the
user's history and additional domain specific plugins.

### Enable Predictive IntelliSense

Predictive IntelliSense is disabled by default. To enable predictions, just run
the following command:

```powershell
Set-PSReadLineOption -PredictionSource History
```

The **PredictionSource** parameter can also accept plugins for domain specific
and custom requirements.

To disable Predictive IntelliSense, just run:

```powershell
Set-PSReadLineOption -PredictionSource None
```

## Custom key bindings

PSReadLine supports custom key bindings using the `Set-PSReadLineKeyHandler`
cmdlet. Most custom key bindings call one of the [bindable functions][02], for
Expand Down Expand Up @@ -119,7 +148,7 @@ is installed in the **PSReadLine** module folder.
Most key bindings use some helper functions for editing the command line. Those
APIs are documented in [about_PSReadLine_Functions][02].

## NOTES
## Notes

### Command History

Expand Down Expand Up @@ -225,7 +254,7 @@ $Env:PGPASS = gcloud auth print-access-token

Feel free to submit a pull request or submit feedback on the GitHub page.

## SEE ALSO
## See also

- PSReadLine is heavily influenced by the GNU [readline][04] library.

Expand Down
10 changes: 2 additions & 8 deletions reference/7.4/PSReadLine/About/about_PSReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
Locale: en-US
ms.date: 08/18/2025
ms.date: 03/18/2026
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_PSReadLine
Expand All @@ -18,6 +18,7 @@ PowerShell console.
There have been many updates to PSReadLine since the version that ships in
Windows PowerShell 5.1.

- v2.4.5 first shipped in PowerShell 7.6.0-rc.1
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
Expand Down Expand Up @@ -60,13 +61,6 @@ in a supported version of PowerShell run the following command.
Install-Module -Name PSReadLine -AllowClobber -Force
```

> [!NOTE]
> Beginning with PowerShell 7.0, PowerShell skips autoloading PSReadLine on
> Windows if a screen reader program is detected. Currently, PSReadLine doesn't
> work well with the screen readers. The default rendering and formatting of
> PowerShell 7.0 on Windows works properly. You can manually load the module if
> necessary.

## Predictive IntelliSense

Predictive IntelliSense is an addition to the concept of tab completion that
Expand Down
10 changes: 2 additions & 8 deletions reference/7.5/PSReadLine/About/about_PSReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
Locale: en-US
ms.date: 08/18/2025
ms.date: 03/18/2026
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.5&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_PSReadLine
Expand All @@ -18,6 +18,7 @@ PowerShell console.
There have been many updates to PSReadLine since the version that ships in
Windows PowerShell 5.1.

- v2.4.5 first shipped in PowerShell 7.6.0-rc.1
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
Expand Down Expand Up @@ -60,13 +61,6 @@ in a supported version of PowerShell run the following command.
Install-Module -Name PSReadLine -AllowClobber -Force
```

> [!NOTE]
> Beginning with PowerShell 7.0, PowerShell skips autoloading PSReadLine on
> Windows if a screen reader program is detected. Currently, PSReadLine doesn't
> work well with the screen readers. The default rendering and formatting of
> PowerShell 7.0 on Windows works properly. You can manually load the module if
> necessary.

## Predictive IntelliSense

Predictive IntelliSense is an addition to the concept of tab completion that
Expand Down
9 changes: 1 addition & 8 deletions reference/7.6/PSReadLine/About/about_PSReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
Locale: en-US
ms.date: 02/20/2026
ms.date: 03/18/2026
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.6&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_PSReadLine
Expand Down Expand Up @@ -61,13 +61,6 @@ in a supported version of PowerShell run the following command.
Install-Module -Name PSReadLine -AllowClobber -Force
```

> [!NOTE]
> Beginning with PowerShell 7.0, PowerShell skips autoloading PSReadLine on
> Windows if a screen reader program is detected. Currently, PSReadLine doesn't
> work well with the screen readers. The default rendering and formatting of
> PowerShell 7.0 on Windows works properly. You can manually load the module if
> necessary.

## Predictive IntelliSense

Predictive IntelliSense is an addition to the concept of tab completion that
Expand Down