shresht7/psfavorite

Favorite PowerShell commands to get as PSReadLine Predictions

PSFavorite

This module allows you to mark commands as favorites. Your favorite commands will appear as suggestions in the PSReadLine Predictor Views.

Favorites do not replace history, they complement it. The history tracks everything you've done, and favorites track the things that you've deemed important.

---

📘 Usage

Write a command and press Ctrl + Shift + * to mark it as favorite.

Note: Add a helpful comment to describe the command for future reference.

Alternatively, use the Add-Favorite cmdlet

PS C:\> "Get-Command | Get-Random | Get-Help    # Get help about a random command" | Add-Favorite

Note: Remember to wrap the expressions in quotes!

Your favorite commands will start appearing as suggestions in the PSReadLine Predictor View.

---

📄 Requirements

• PowerShell v7.2.0 or higher
• PSReadLine v2.2.2 or higher

PSReadLine must allow plugins as a -PredictionSource. (i.e. Plugin or HistoryAndPlugin)

Set-PSReadLineOption -PredictionSource HistoryAndPlugin

To enable the List view:

Set-PSReadLineOption -PredictionViewStyle ListView

📦 Installation

1. Install the Module

Install-Module -Name PSFavorite

2. Import the Module

Import-Module -Name PSFavorite

Add this to your $PROFILE if you wish to enable this for every session.

🪓 Uninstallation

1. Close all PowerShell instances
2. Launch a PowerShell session with no profile. pwsh -NoProfile
3. Uninstall the Module. Uninstall-Module -Name PSFavorite -Force
4. Close PowerShell

---

💽 Development

📜 Scripts

• Build.ps1 - Builds the PowerShell module

🧪 Testing

This module uses Pester for testing. Run the following command to test the PowerShell module.

Invoke-Pester

📕 Reference

• https://learn.microsoft.com/en-us/powershell/scripting/dev-cross-plat/create-cmdline-predictor?view=powershell-7.3

---

📃 License

This project is licensed under the MIT License. Please read the LICENSE for more details.

psfavorite's Issues

Something wiped out the Favorites.txt file

Implement Fuzzy Search

Allow fuzzy matching so that the input only has to approximately match the favorited commands.

Bug: `Get-PSFavorites` errors out if a favorite doesn't have comment

PSFavorite/Module/Public/Get-PSFavorites.ps1

Lines 22 to 23 in 1348671

	$Command, $Description = $Favorite -split "\s*#\s*"
	[PSCustomObject]@{

Normally, a favorite is accompanied by a comment describing the command

git status # Shows the git status

This line expects that the favorites be in that format and crashes if something like this is given

git status

Path to the `Favorites.txt` file

PSFavorite/Predictor/PSFavoritePredictor.cs

Line 38 in 4fc5377

private static string _FavoritesFilePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), "PowerShell", "Modules", "PSFavorite", "Favorites.txt");

The path to the favorites file is hardcoded here, it will be better if this was somehow configurable? (maybe environment variables).

Even if the file is supposed to co-exist within the module folder, this path is only valid for Windows.

Maybe ~/.config/PSFavorites/Favorites.txt should be the standard path.