{"id":19936,"date":"2023-05-08T07:42:54","date_gmt":"2023-05-08T15:42:54","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/powershell\/?p=19936"},"modified":"2023-05-09T13:00:25","modified_gmt":"2023-05-09T21:00:25","slug":"psreadline-2-3-1-beta1-release","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/psreadline-2-3-1-beta1-release\/","title":{"rendered":"PSReadLine 2.3.1-beta1 Release"},"content":{"rendered":"<p><!-- markdownlint-disable MD041 --><\/p>\n<p>We are pleased to announce another release of <strong>PSReadLine 2.3.1-beta1<\/strong>! We have had various bug fixes\nand minor improvements in this release, as well as a big new feature to <code>ListView<\/code> of Predictors! Let&#8217;s\njump right in!<\/p>\n<h2>Installing PSReadLine 2.3.1-beta1<\/h2>\n<p>How do you install this release? The release is available from the <a href=\"https:\/\/www.powershellgallery.com\/packages\/PSReadLine\/2.3.1-beta1\">PowerShell Gallery<\/a>.<\/p>\n<p>Use the following command to install <strong>PSReadLine<\/strong> using <strong>PowerShellGet<\/strong> v2.x:<\/p>\n<pre><code class=\"language-powershell\">Install-Module -Name PSReadLine -AllowPrerelease -Force<\/code><\/pre>\n<p>If you are using <strong>PowerShellGet<\/strong> v3, you can use the following command:<\/p>\n<pre><code class=\"language-powershell\">Install-PSResource -Name PSReadLine -Prerelease<\/code><\/pre>\n<p>You must include the <strong>Force<\/strong> parameter to install this version side by side with the default\nstable version.<\/p>\n<p><div class=\"alert alert-primary\"><p class=\"alert-divider\"><i class=\"fabric-icon fabric-icon--Info\"><\/i><strong>Note<\/strong><\/p>You must restart your PowerShell session to use the new version of\n<strong>PSReadLine<\/strong>.<\/div><\/p>\n<h2>ListView tool tip view<\/h2>\n<p>In this preview, we enabled a new tooltip view in the <code>ListView<\/code> mode of PSReadLine Predictors.\nTooltips were part of the original design but were never presented to the user until this release.\nTooltips are enabled by default, but you can disable them by running the following command:<\/p>\n<pre><code class=\"language-powershell\">Set-PSReadLineOption -ShowToolTips:$false<\/code><\/pre>\n<p>And then can re-enable by running:<\/p>\n<pre><code class=\"language-powershell\">Set-PSReadLineOption -ShowToolTips<\/code><\/pre>\n<p>The following screenshot shows the <a href=\"https:\/\/www.powershellgallery.com\/packages\/CompletionPredictor\/0.1.0\"><code>CompletionPredictor<\/code><\/a> providing tooltips to show details\nabout each parameter of <code>Write-Host<\/code> and <code>GetChildItem<\/code>.<\/p>\n<p><div class=\"alert alert-primary\"><p class=\"alert-divider\"><i class=\"fabric-icon fabric-icon--Info\"><\/i><strong>Note<\/strong><\/p>You will need the CompletionPredictor installed and imported to have the same experiences shown in this blog.<\/div><\/p>\n<p>&nbsp;<\/p>\n<p><a href=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/ToolTipHighlight.gif\"><img decoding=\"async\" class=\"alignnone wp-image-19941 size-full\" src=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/ToolTipHighlight.gif\" alt=\"Gif showing the tool tip option.\" width=\"2214\" height=\"1190\" \/><\/a><\/p>\n<p>Tooltips are only available for results from plugin predictors. Predictions from History don&#8217;t have\ntooltips. A plugin predictor can populate the tooltip with other descriptions to help provide more\ndetails into what is being predicted. For example, the <a href=\"https:\/\/www.powershellgallery.com\/packages\/Az.Tools.Predictor\/1.1.0\">Az.Tools.Predictor<\/a> module provides\ndetails about what the suggested cmdlet does.<\/p>\n<p><a href=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip.png\"><img decoding=\"async\" class=\"alignnone wp-image-19938 size-full\" src=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip.png\" alt=\"Screenshot showing Az predictor tool tip\" width=\"3438\" height=\"976\" srcset=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip.png 3438w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip-300x85.png 300w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip-1024x291.png 1024w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip-768x218.png 768w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip-1536x436.png 1536w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/AzPredictorToolTip-2048x581.png 2048w\" sizes=\"(max-width: 3438px) 100vw, 3438px\" \/><\/a><\/p>\n<p>It&#8217;s also helpful when working with .NET objects:<\/p>\n<p><a href=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip.png\"><img decoding=\"async\" class=\"alignnone size-full wp-image-19939\" src=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip.png\" alt=\"Screenshot showing the .NET object tool tip completion\" width=\"2210\" height=\"562\" srcset=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip.png 2210w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip-300x76.png 300w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip-1024x260.png 1024w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip-768x195.png 768w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip-1536x391.png 1536w, https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/dotnetobjectToolTip-2048x521.png 2048w\" sizes=\"(max-width: 2210px) 100vw, 2210px\" \/><\/a><\/p>\n<p>For long tooltips, <code>ListView<\/code> shows up to four lines of the tooltip. You can get more information\nfor the selected item by pressing the <kbd>F4<\/kbd> key.<\/p>\n<p><a href=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/f4ToolTip.gif\"><img decoding=\"async\" class=\"alignnone size-full wp-image-19940\" src=\"https:\/\/devblogs.microsoft.com\/powershell\/wp-content\/uploads\/sites\/30\/2023\/05\/f4ToolTip.gif\" alt=\"GIF showing the F4 capabilities to expand a tooltip\" width=\"2208\" height=\"1236\" \/><\/a><\/p>\n<p>See our <a href=\"https:\/\/github.com\/PowerShell\/PSReadLine\/releases\/tag\/v2.3.1-beta1\">changelog<\/a> for a complete list of bug fixes and changes.<\/p>\n<h2>Feedback<\/h2>\n<p>As usual, we love getting your feedback! Since this is a beta release, designs and features are\nsubject to change. Please submit bugs, feature requests, or questions to the <a href=\"https:\/\/github.com\/PowerShell\/PSReadLine\/issues\">repository<\/a>. Your\nfeedback is greatly appreciated!<\/p>\n<p>Steven Bucher and Dongbo Wang<\/p>\n<p>PSReadLine Maintainers<\/p>\n<p><!-- Link references --><\/p>\n","protected":false},"excerpt":{"rendered":"<p>We are very excited to annouce the release of PSReadLine 2.3.1-beta1 is now available on the PowerShell Gallery! We have added a brand new tool tip feature to help give more descriptions to predictor results.<\/p>\n","protected":false},"author":98569,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[248,3168],"class_list":["post-19936","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-powershell","tag-psreadline"],"acf":[],"blog_post_summary":"<p>We are very excited to annouce the release of PSReadLine 2.3.1-beta1 is now available on the PowerShell Gallery! We have added a brand new tool tip feature to help give more descriptions to predictor results.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/19936","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/98569"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=19936"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/19936\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=19936"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=19936"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=19936"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}