Skip to content

Commit a46aad7

Browse files
authored
Update release notes for PSReadLine 2.4.5 (#12860)
1 parent 63176e6 commit a46aad7

File tree

4 files changed

+40
-30
lines changed

4 files changed

+40
-30
lines changed

reference/5.1/PSReadLine/About/about_PSReadLine.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 08/18/2025
4+
ms.date: 03/18/2026
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-5.1&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
88
---
99
# about_PSReadLine
1010

11-
## SHORT DESCRIPTION
11+
## Short description
1212

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

16-
## LONG DESCRIPTION
16+
## Long description
1717

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

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

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

60-
## CUSTOM KEY BINDINGS
64+
## Predictive IntelliSense
65+
66+
Predictive IntelliSense is an addition to the concept of tab completion that
67+
assists the user in successfully completing commands. It enables users to
68+
discover, edit, and execute full commands based on matching predictions from the
69+
user's history and additional domain specific plugins.
70+
71+
### Enable Predictive IntelliSense
72+
73+
Predictive IntelliSense is disabled by default. To enable predictions, just run
74+
the following command:
75+
76+
```powershell
77+
Set-PSReadLineOption -PredictionSource History
78+
```
79+
80+
The **PredictionSource** parameter can also accept plugins for domain specific
81+
and custom requirements.
82+
83+
To disable Predictive IntelliSense, just run:
84+
85+
```powershell
86+
Set-PSReadLineOption -PredictionSource None
87+
```
88+
89+
## Custom key bindings
6190

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

122-
## NOTES
151+
## Notes
123152

124153
### Command History
125154

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

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

228-
## SEE ALSO
257+
## See also
229258

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

reference/7.4/PSReadLine/About/about_PSReadLine.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 08/18/2025
4+
ms.date: 03/18/2026
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.4&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -18,6 +18,7 @@ PowerShell console.
1818
There have been many updates to PSReadLine since the version that ships in
1919
Windows PowerShell 5.1.
2020

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

63-
> [!NOTE]
64-
> Beginning with PowerShell 7.0, PowerShell skips autoloading PSReadLine on
65-
> Windows if a screen reader program is detected. Currently, PSReadLine doesn't
66-
> work well with the screen readers. The default rendering and formatting of
67-
> PowerShell 7.0 on Windows works properly. You can manually load the module if
68-
> necessary.
69-
7064
## Predictive IntelliSense
7165

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

reference/7.5/PSReadLine/About/about_PSReadLine.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 08/18/2025
4+
ms.date: 03/18/2026
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.5&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -18,6 +18,7 @@ PowerShell console.
1818
There have been many updates to PSReadLine since the version that ships in
1919
Windows PowerShell 5.1.
2020

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

63-
> [!NOTE]
64-
> Beginning with PowerShell 7.0, PowerShell skips autoloading PSReadLine on
65-
> Windows if a screen reader program is detected. Currently, PSReadLine doesn't
66-
> work well with the screen readers. The default rendering and formatting of
67-
> PowerShell 7.0 on Windows works properly. You can manually load the module if
68-
> necessary.
69-
7064
## Predictive IntelliSense
7165

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

reference/7.6/PSReadLine/About/about_PSReadLine.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 02/20/2026
4+
ms.date: 03/18/2026
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.6&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -61,13 +61,6 @@ in a supported version of PowerShell run the following command.
6161
Install-Module -Name PSReadLine -AllowClobber -Force
6262
```
6363

64-
> [!NOTE]
65-
> Beginning with PowerShell 7.0, PowerShell skips autoloading PSReadLine on
66-
> Windows if a screen reader program is detected. Currently, PSReadLine doesn't
67-
> work well with the screen readers. The default rendering and formatting of
68-
> PowerShell 7.0 on Windows works properly. You can manually load the module if
69-
> necessary.
70-
7164
## Predictive IntelliSense
7265

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

0 commit comments

Comments
 (0)