diff --git a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml index eb1724dbf472..080f20ac9378 100644 --- a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml +++ b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml @@ -1,5 +1,4 @@ name: "📄 Feedback control template" -title: "Feedback" description: >- ⛔ This template is intended for use by the feedback control on the bottom of every page on the live site. If you aren't using the feedback control, choose one of the other templates.⛔ diff --git a/reference/5.1/PSReadLine/About/about_PSReadLine.md b/reference/5.1/PSReadLine/About/about_PSReadLine.md index 43ec4957441c..65dd4e228213 100644 --- a/reference/5.1/PSReadLine/About/about_PSReadLine.md +++ b/reference/5.1/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 09/17/2024 +ms.date: 03/03/2025 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 @@ -16,6 +16,7 @@ PowerShell console. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.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 - v2.2.6 first shipped in PowerShell 7.3.0 diff --git a/reference/5.1/PSReadLine/About/about_PSReadLine_Functions.md b/reference/5.1/PSReadLine/About/about_PSReadLine_Functions.md index 47266ccbda8d..bea3d0136c6c 100644 --- a/reference/5.1/PSReadLine/About/about_PSReadLine_Functions.md +++ b/reference/5.1/PSReadLine/About/about_PSReadLine_Functions.md @@ -18,11 +18,11 @@ PowerShell console. ## Long Description PowerShell 5.1 ships with PSReadLine 2.0.0. The current version is PSReadLine -2.3.4. The current version of PSReadLine can be installed and used on Windows +2.3.6. The current version of PSReadLine can be installed and used on Windows PowerShell 5.1 and newer. For some features, you need to be running PowerShell 7.2 or higher. -This article documents the functions provided by PSReadLine. These functions +This article documents the functions provided by PSReadLine 2.0.0. These functions can be bound to keystrokes for easy access and invocation. ## Using the Microsoft.PowerShell.PSConsoleReadLine class diff --git a/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md index d37bc376d74c..5f3abf84b842 100644 --- a/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 01/23/2025 +ms.date: 03/03/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta0 +- Current preview: v2.4.0-beta1 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,13 @@ Windows PowerShell 5.1. ## Release Notes +### v2.4.0-beta1 - 2025-02-28 + +- Avoid querying for cursor position when it's not necessary +- Handle buffer changes made by an event handler +- Update SelectCommandArgument to properly handle POSIX style options for CLI + commands + ### v2.4.0-beta0 - 2024-03-01 - Fix copying text to system clipboard on Linux using `xclip` @@ -75,7 +82,8 @@ enhancements: - Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned console-attached process that may mess up reading from Console input - De-duplicate prediction results with the history results -- Make tab completion show results whose `ListItemText` are different by case only +- Make tab completion show results whose `ListItemText` are different by case + only - Add support for upcasing, downcasing, and capitalizing word - Handle multi-line description for parameter help content @@ -143,9 +151,11 @@ release: logical line - Rename `PredictionColor` to `InlinePredictionColor` - Allow `MaximumHistoryCount` to be set from user's profile -- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History` +- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the + options `None` and `History` - Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable -- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives +- Relax the sensitive words we filter by changing `key` to `apikey` to reduce + false positives - Make `ViForwardChar` able to accept suggestions - Expose `ViBackwardChar` and `ViForwardChar` as bindable functions diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md index 096a0a40b5f6..2ea8197699ce 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md @@ -1,7 +1,7 @@ --- description: Describes the built-in functions in PowerShell. Locale: en-US -ms.date: 08/14/2024 +ms.date: 03/01/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_built-in_functions?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_Built-in_Functions @@ -84,6 +84,15 @@ This function provides a short hand way to run `New-Item -Type Directory` with your parameters. This function is only defined for Windows systems. Linux and macOS system use the native `mkdir` command. +## `exec` + +Some native Unix commands shell out to run something (like ssh) and use the +built-in bash command `exec` to spawn a new process that replaces the current +one. PowerShell 7.3.1 adds the `exec` function to wrap the +[Switch-Process](xref:Microsoft.PowerShell.Core.Switch-Process) cmdlet. +`Switch-Process` calls the native Unix `execv()` function to provide similar +behavior as POSIX shells. + ## Windows drive letter functions In Windows, drive mount points are associated with a drive letter like `C:`. diff --git a/reference/7.4/PSReadLine/About/about_PSReadLine.md b/reference/7.4/PSReadLine/About/about_PSReadLine.md index e890ccaf678b..448fea8c14f4 100644 --- a/reference/7.4/PSReadLine/About/about_PSReadLine.md +++ b/reference/7.4/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 09/17/2024 +ms.date: 03/03/2025 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 @@ -16,6 +16,7 @@ PowerShell console. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.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 - v2.2.6 first shipped in PowerShell 7.3.0 diff --git a/reference/7.4/PSReadLine/About/about_PSReadLine_Functions.md b/reference/7.4/PSReadLine/About/about_PSReadLine_Functions.md index 9f0dc6bd21cc..7dade66cae15 100644 --- a/reference/7.4/PSReadLine/About/about_PSReadLine_Functions.md +++ b/reference/7.4/PSReadLine/About/about_PSReadLine_Functions.md @@ -3,7 +3,7 @@ description: > This article documents the functions provided by PSReadLine. These functions can be bound to keystrokes for easy access and invocation. Locale: en-US -ms.date: 10/16/2023 +ms.date: 03/03/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_functions?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Functions @@ -18,11 +18,11 @@ PowerShell console. ## Long Description PowerShell 7.3 ships with PSReadLine 2.2.6. The current version is PSReadLine -2.3.4. The current version of PSReadLine can be installed and used on Windows +2.3.6. The current version of PSReadLine can be installed and used on Windows PowerShell 5.1 and newer. For some features, you need to be running PowerShell 7.2 or higher. -This article documents the functions provided by PSReadLine 2.3.4. These +This article documents the functions provided by PSReadLine 2.3.6. These functions can be bound to keystrokes for easy access and invocation. ## Using the Microsoft.PowerShell.PSConsoleReadLine class diff --git a/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md index e9235380eb84..699a6e7d68a6 100644 --- a/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 01/23/2025 +ms.date: 03/03/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta0 +- Current preview: v2.4.0-beta1 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,13 @@ Windows PowerShell 5.1. ## Release Notes +### v2.4.0-beta1 - 2025-02-28 + +- Avoid querying for cursor position when it's not necessary +- Handle buffer changes made by an event handler +- Update SelectCommandArgument to properly handle POSIX style options for CLI + commands + ### v2.4.0-beta0 - 2024-03-01 - Fix copying text to system clipboard on Linux using `xclip` @@ -75,7 +82,8 @@ enhancements: - Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned console-attached process that may mess up reading from Console input - De-duplicate prediction results with the history results -- Make tab completion show results whose `ListItemText` are different by case only +- Make tab completion show results whose `ListItemText` are different by case + only - Add support for upcasing, downcasing, and capitalizing word - Handle multi-line description for parameter help content @@ -143,9 +151,11 @@ release: logical line - Rename `PredictionColor` to `InlinePredictionColor` - Allow `MaximumHistoryCount` to be set from user's profile -- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History` +- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the + options `None` and `History` - Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable -- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives +- Relax the sensitive words we filter by changing `key` to `apikey` to reduce + false positives - Make `ViForwardChar` able to accept suggestions - Expose `ViBackwardChar` and `ViForwardChar` as bindable functions diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md index ff9ab9f36f44..3b7307c379dc 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md @@ -1,7 +1,7 @@ --- description: Describes the built-in functions in PowerShell. Locale: en-US -ms.date: 08/14/2024 +ms.date: 03/01/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_built-in_functions?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_Built-in_Functions @@ -84,6 +84,15 @@ This function provides a short hand way to run `New-Item -Type Directory` with your parameters. This function is only defined for Windows systems. Linux and macOS system use the native `mkdir` command. +## `exec` + +Some native Unix commands shell out to run something (like ssh) and use the +built-in bash command `exec` to spawn a new process that replaces the current +one. PowerShell 7.3.1 adds the `exec` function to wrap the +[Switch-Process](xref:Microsoft.PowerShell.Core.Switch-Process) cmdlet. +`Switch-Process` calls the native Unix `execv()` function to provide similar +behavior as POSIX shells. + ## Windows drive letter functions In Windows, drive mount points are associated with a drive letter like `C:`. diff --git a/reference/7.5/PSReadLine/About/about_PSReadLine.md b/reference/7.5/PSReadLine/About/about_PSReadLine.md index 9f28f3b61945..df8f9fd10b68 100644 --- a/reference/7.5/PSReadLine/About/about_PSReadLine.md +++ b/reference/7.5/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 09/17/2024 +ms.date: 03/03/2025 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 @@ -16,6 +16,7 @@ PowerShell console. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.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 - v2.2.6 first shipped in PowerShell 7.3.0 diff --git a/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md b/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md index f40b4bcb7e5f..16db20471d43 100644 --- a/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md +++ b/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md @@ -3,7 +3,7 @@ description: > This article documents the functions provided by PSReadLine. These functions can be bound to keystrokes for easy access and invocation. Locale: en-US -ms.date: 10/16/2023 +ms.date: 03/03/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_functions?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Functions @@ -18,11 +18,11 @@ PowerShell console. ## Long Description PowerShell 7.3 ships with PSReadLine 2.2.6. The current version is PSReadLine -2.3.4. The current version of PSReadLine can be installed and used on Windows +2.3.6. The current version of PSReadLine can be installed and used on Windows PowerShell 5.1 and newer. For some features, you need to be running PowerShell 7.2 or higher. -This article documents the functions provided by PSReadLine 2.3.4. These +This article documents the functions provided by PSReadLine 2.3.6. These functions can be bound to keystrokes for easy access and invocation. ## Using the Microsoft.PowerShell.PSConsoleReadLine class @@ -557,7 +557,7 @@ Deletes backwards until given character. - Vi command mode: `` -### ViInsertAtBeginning +### ViInsertAtBegining Switch to Insert mode and position the cursor at the beginning of the line. diff --git a/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md index 4edd66b68354..f06eb761e4f5 100644 --- a/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 01/23/2025 +ms.date: 03/03/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta0 +- Current preview: v2.4.0-beta1 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,13 @@ Windows PowerShell 5.1. ## Release Notes +### v2.4.0-beta1 - 2025-02-28 + +- Avoid querying for cursor position when it's not necessary +- Handle buffer changes made by an event handler +- Update SelectCommandArgument to properly handle POSIX style options for CLI + commands + ### v2.4.0-beta0 - 2024-03-01 - Fix copying text to system clipboard on Linux using `xclip` @@ -75,7 +82,8 @@ enhancements: - Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned console-attached process that may mess up reading from Console input - De-duplicate prediction results with the history results -- Make tab completion show results whose `ListItemText` are different by case only +- Make tab completion show results whose `ListItemText` are different by case + only - Add support for upcasing, downcasing, and capitalizing word - Handle multi-line description for parameter help content @@ -143,9 +151,11 @@ release: logical line - Rename `PredictionColor` to `InlinePredictionColor` - Allow `MaximumHistoryCount` to be set from user's profile -- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History` +- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the + options `None` and `History` - Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable -- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives +- Relax the sensitive words we filter by changing `key` to `apikey` to reduce + false positives - Make `ViForwardChar` able to accept suggestions - Expose `ViBackwardChar` and `ViForwardChar` as bindable functions diff --git a/reference/7.6/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md b/reference/7.6/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md index 45dac7852da8..52da12171120 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md +++ b/reference/7.6/Microsoft.PowerShell.Core/About/about_Built-in_Functions.md @@ -1,7 +1,7 @@ --- description: Describes the built-in functions in PowerShell. Locale: en-US -ms.date: 08/14/2024 +ms.date: 03/01/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_built-in_functions?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_Built-in_Functions @@ -84,6 +84,15 @@ This function provides a short hand way to run `New-Item -Type Directory` with your parameters. This function is only defined for Windows systems. Linux and macOS system use the native `mkdir` command. +## `exec` + +Some native Unix commands shell out to run something (like ssh) and use the +built-in bash command `exec` to spawn a new process that replaces the current +one. PowerShell 7.3.1 adds the `exec` function to wrap the +[Switch-Process](xref:Microsoft.PowerShell.Core.Switch-Process) cmdlet. +`Switch-Process` calls the native Unix `execv()` function to provide similar +behavior as POSIX shells. + ## Windows drive letter functions In Windows, drive mount points are associated with a drive letter like `C:`. diff --git a/reference/7.6/PSReadLine/About/about_PSReadLine.md b/reference/7.6/PSReadLine/About/about_PSReadLine.md index f946aa96adf2..d19472d382b8 100644 --- a/reference/7.6/PSReadLine/About/about_PSReadLine.md +++ b/reference/7.6/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 09/17/2024 +ms.date: 03/03/2025 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 @@ -16,6 +16,7 @@ PowerShell console. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.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 - v2.2.6 first shipped in PowerShell 7.3.0 diff --git a/reference/7.6/PSReadLine/About/about_PSReadLine_Functions.md b/reference/7.6/PSReadLine/About/about_PSReadLine_Functions.md index 4ac686c1ae28..3d288d097d0c 100644 --- a/reference/7.6/PSReadLine/About/about_PSReadLine_Functions.md +++ b/reference/7.6/PSReadLine/About/about_PSReadLine_Functions.md @@ -3,7 +3,7 @@ description: > This article documents the functions provided by PSReadLine. These functions can be bound to keystrokes for easy access and invocation. Locale: en-US -ms.date: 10/16/2023 +ms.date: 03/03/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_functions?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Functions @@ -18,11 +18,11 @@ PowerShell console. ## Long Description PowerShell 7.3 ships with PSReadLine 2.2.6. The current version is PSReadLine -2.3.4. The current version of PSReadLine can be installed and used on Windows +2.3.6. The current version of PSReadLine can be installed and used on Windows PowerShell 5.1 and newer. For some features, you need to be running PowerShell 7.2 or higher. -This article documents the functions provided by PSReadLine 2.3.4. These +This article documents the functions provided by PSReadLine 2.3.6. These functions can be bound to keystrokes for easy access and invocation. ## Using the Microsoft.PowerShell.PSConsoleReadLine class @@ -557,7 +557,7 @@ Deletes backwards until given character. - Vi command mode: `` -### ViInsertAtBeginning +### ViInsertAtBegining Switch to Insert mode and position the cursor at the beginning of the line. diff --git a/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md index 4b7d2d44d751..b4148f749a3a 100644 --- a/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 01/23/2025 +ms.date: 03/03/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes This is a summary of changes to the **PSReadLine** module. For a full list of changes, see the **PSReadLine** [ChangeLog][01]. -- Current preview: v2.4.0-beta0 +- Current preview: v2.4.0-beta1 - Current stable release: v2.3.6 ## PSReadLine release history @@ -29,6 +29,13 @@ Windows PowerShell 5.1. ## Release Notes +### v2.4.0-beta1 - 2025-02-28 + +- Avoid querying for cursor position when it's not necessary +- Handle buffer changes made by an event handler +- Update SelectCommandArgument to properly handle POSIX style options for CLI + commands + ### v2.4.0-beta0 - 2024-03-01 - Fix copying text to system clipboard on Linux using `xclip` @@ -75,7 +82,8 @@ enhancements: - Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned console-attached process that may mess up reading from Console input - De-duplicate prediction results with the history results -- Make tab completion show results whose `ListItemText` are different by case only +- Make tab completion show results whose `ListItemText` are different by case + only - Add support for upcasing, downcasing, and capitalizing word - Handle multi-line description for parameter help content @@ -143,9 +151,11 @@ release: logical line - Rename `PredictionColor` to `InlinePredictionColor` - Allow `MaximumHistoryCount` to be set from user's profile -- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History` +- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the + options `None` and `History` - Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable -- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives +- Relax the sensitive words we filter by changing `key` to `apikey` to reduce + false positives - Make `ViForwardChar` able to accept suggestions - Expose `ViBackwardChar` and `ViForwardChar` as bindable functions diff --git a/reference/docs-conceptual/how-to-use-docs.md b/reference/docs-conceptual/how-to-use-docs.md index 86f44cfa2d00..1562a99d772b 100644 --- a/reference/docs-conceptual/how-to-use-docs.md +++ b/reference/docs-conceptual/how-to-use-docs.md @@ -46,7 +46,7 @@ The version selector doesn't affect conceptual documentation. The conceptual doc the **Reference** node in the TOC. The same conceptual articles appear for every version selected. If there are version-specific differences, the documentation makes note of those differences. -![Animation showing how to use the version selector.][04] +![Animation showing how to use the version selector.][06] You can verify the version of PowerShell you are using by inspecting the `$PSVersionTable.PSVersion` value. The following example shows the output for Windows PowerShell 5.1. @@ -96,7 +96,7 @@ To download the documentation as a PDF, click the **Download PDF** button at the Documentation for older versions of PowerShell is archived in our [Previous Versions][01] site. You can choose **Previous Versions** from the version selector. -![Screenshot of the Previous Versions option.](media/how-to-use-docs/previous-versions.gif) +![Screenshot of the Previous Versions option.][04] The previous versions site contains documentation for the following topics: @@ -115,5 +115,6 @@ The previous versions site contains documentation for the following topics: [01]: https://aka.ms/PSLegacyDocs [02]: media/how-to-use-docs/how-to-use.gif [03]: media/how-to-use-docs/pdf-button.gif -[04]: media/how-to-use-docs/version-search.gif +[04]: media/how-to-use-docs/previous-versions.gif [05]: media/how-to-use-docs/search-scope.gif +[06]: media/how-to-use-docs/version-search.gif diff --git a/reference/docs-conceptual/learn/shell/using-predictors.md b/reference/docs-conceptual/learn/shell/using-predictors.md index 6a940a5ede85..e3b8601345f0 100644 --- a/reference/docs-conceptual/learn/shell/using-predictors.md +++ b/reference/docs-conceptual/learn/shell/using-predictors.md @@ -18,7 +18,7 @@ the user's cursor. The suggestions from Predictive IntelliSense help new and exp PowerShell discover, edit, and execute full commands based on matching predictions. Suggestions can come from the user's history and additional domain specific plugins. -![Inline view of a prediction](media/using-predictors/predictor-inline-1.png) +![Inline view of a prediction][07] The previous images shows the default `InlineView` of the suggestion. Pressing RightArrow key accepts an inline suggestion. After accepting the suggestion, you can edit the command line @@ -26,7 +26,7 @@ before hitting Enter to run the command. **PSReadLine** also offers a `ListView` presentation of the suggestions. -![List view of predictions](media/using-predictors/predictor-listview-1.png) +![List view of predictions][08] When in the list view, you can use the arrow keys to scroll through the available suggestions. List view also shows the source of the prediction. @@ -46,7 +46,7 @@ To install **PSReadLine** using **PowerShellGet**: Install-Module -Name PSReadLine ``` -Or install using the new [PowerShellGet v3][PSGetv3] module: +Or install using the new [PowerShellGet v3][05] module: ```powershell Install-PSResource -Name PSReadLine @@ -82,7 +82,7 @@ You can change the prediction source using the `Set-PSReadLineOption` cmdlet wit > [!NOTE] > History-based predictions come from the history maintained by **PSReadLine**. That history is more > comprehensive than the session-based history you can see using `Get-History`. For more -> information, see **Command history** section of [about_PSReadLine][psr-history]. +> information, see **Command history** section of [about_PSReadLine][01]. ### Setting the prediction color @@ -102,7 +102,7 @@ Set-PSReadLineOption -Colors @{ InlinePrediction = "`e[38;5;238m" } ``` For more information about setting prediction color and other PSReadLine settings, see -[Set-PSReadLineOption][Set-PSReadLineOption]. +[Set-PSReadLineOption][09]. ### Changing keybindings @@ -136,14 +136,14 @@ Set-PSReadLineKeyHandler -Chord "RightArrow" -Function ForwardWord The **Az.Tools.Predictor** module was the first plug-in for Predictive IntelliSense. It uses Machine Learning to predict what Azure PowerShell command you want to run and the parameters you want to use. For more information and installation instructions, see -[Announcing General Availability of Az.Tools.Predictor][azpredictor]. +[Announcing General Availability of Az.Tools.Predictor][03]. The **CompletionPredictor** module adds an IntelliSense experience for anything that can be tab-completed in PowerShell. With **PSReadLine** set to `InlineView`, you get the normal tab completion experience. When you switch to `ListView`, you get the IntelliSense experience. You can -install the [CompletionPredictor][CompletionPredictor] module from the PowerShell Gallery. +install the [CompletionPredictor][04] module from the PowerShell Gallery. -![PowerShell IntelliSense using the CompletionPredictor](media/using-predictors/completion-predictor.gif) +![PowerShell IntelliSense using the CompletionPredictor][06] As previously noted, `ListView` shows you the source of the prediction. If you have multiple plug-ins installed the predictions are grouped by source with **History** listed first followed by @@ -155,12 +155,15 @@ You can write your own predictor using C# to create a compiled PowerShell module implement the **System.Management.Automation.Subsystem.Prediction.ICommandPredictor** interface. This interface declares the methods used to query for prediction results and provide feedback. -For more information, see [How to create a command-line predictor][custom-predictor]. +For more information, see [How to create a command-line predictor][02]. -[azpredictor]: https://techcommunity.microsoft.com/t5/azure-tools-blog/announcing-general-availability-of-az-tools-predictor/ba-p/3297956 -[Set-PSReadLineOption]: xref:PSReadLine.Set-PSReadLineOption -[PSGetv3]: https://www.powershellgallery.com/packages/PowerShellGet/3.0.14-beta14 -[CompletionPredictor]: https://www.powershellgallery.com/packages/CompletionPredictor -[psr-history]: /powershell/module/psreadline/about/about_psreadline#command-history -[custom-predictor]: /powershell/scripting/dev-cross-plat/create-cmdline-predictor +[01]: /powershell/module/psreadline/about/about_psreadline#command-history +[02]: /powershell/scripting/dev-cross-plat/create-cmdline-predictor +[03]: https://techcommunity.microsoft.com/t5/azure-tools-blog/announcing-general-availability-of-az-tools-predictor/ba-p/3297956 +[04]: https://www.powershellgallery.com/packages/CompletionPredictor +[05]: https://www.powershellgallery.com/packages/PowerShellGet/3.0.14-beta14 +[06]: media/using-predictors/completion-predictor.gif +[07]: media/using-predictors/predictor-inline-1.png +[08]: media/using-predictors/predictor-listview-1.png +[09]: xref:PSReadLine.Set-PSReadLineOption diff --git a/reference/docs-conceptual/media/overview/linux-desktop-660.gif b/reference/docs-conceptual/media/overview/linux-desktop-660.gif deleted file mode 100644 index cdd305a30a6e..000000000000 Binary files a/reference/docs-conceptual/media/overview/linux-desktop-660.gif and /dev/null differ diff --git a/reference/docs-conceptual/media/overview/macos-desktop-660.gif b/reference/docs-conceptual/media/overview/macos-desktop-660.gif deleted file mode 100644 index 75cb564c713b..000000000000 Binary files a/reference/docs-conceptual/media/overview/macos-desktop-660.gif and /dev/null differ diff --git a/reference/docs-conceptual/media/overview/macos-desktop.gif b/reference/docs-conceptual/media/overview/macos-desktop.gif deleted file mode 100644 index cd8e03b74a53..000000000000 Binary files a/reference/docs-conceptual/media/overview/macos-desktop.gif and /dev/null differ diff --git a/reference/docs-conceptual/media/overview/windows-desktop-660.gif b/reference/docs-conceptual/media/overview/windows-desktop-660.gif deleted file mode 100644 index ae5304912b42..000000000000 Binary files a/reference/docs-conceptual/media/overview/windows-desktop-660.gif and /dev/null differ diff --git a/reference/docs-conceptual/media/overview/windows-desktop.gif b/reference/docs-conceptual/media/overview/windows-desktop.gif deleted file mode 100644 index c841706bf16a..000000000000 Binary files a/reference/docs-conceptual/media/overview/windows-desktop.gif and /dev/null differ diff --git a/reference/media/index/av_colors_128.svg b/reference/media/index/av_colors_128.svg deleted file mode 100644 index ab2963937199..000000000000 --- a/reference/media/index/av_colors_128.svg +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - diff --git a/reference/media/index/powershell_128.svg b/reference/media/index/powershell_128.svg deleted file mode 100644 index 7ac89fbba989..000000000000 --- a/reference/media/index/powershell_128.svg +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - - - - - - -