Skip to content

techthoughts2/PSGalleryExplorer

Repository files navigation

PSGalleryExplorer

Minimum Supported PowerShell Version PowerShell Gallery Cross Platform License Documentation Status

PSGalleryExplorer Logo

Branch Windows Windows pwsh MacOS Linux
main M-W-Build Status M-W-pwsh-Build Status M-Mac-Build status M-L-Build Status
Enhancements E-W-Build Status E-W-pwsh-Build Status E-Mac-Build status E-L-Build Status

Synopsis

PSGalleryExplorer is a PowerShell module that extends the search functionality of the PowerShell Gallery by providing additional project information about modules. This enables you to search, explore, and discover PowerShell Gallery modules based on additional criteria.

PSGalleryExplorer Gif Demo

Description

PSGalleryExplorer is a PowerShell module that extends the search functionality of the PowerShell Gallery by providing additional project information about modules. It enables users to search, explore, and discover PowerShell Gallery modules based on additional criteria that are not available via Find-Module. The module provides various features such as filtering results based on download counts, stars, forks, and repository health metrics like open issues, license, and last updated date. With PSGalleryExplorer, users can easily identify trending and actively developed modules, and explore module repositories directly from the console.

With Find-ModuleByCommand, PSGalleryExplorer now provides even more value to users by enabling them to quickly locate modules that contain specific commands. This enables you to search for modules by function name, even if you do not have the module locally installed.

Features

  • Fully cross-platform and can be run on Windows, Linux, and macOS
  • Discover modules based on various criteria such as number of downloads, stars, forks, and more
  • Get insights into the community health of a module's repository, including information about open issues, license, and last updated date
  • Identify modules that are actively being developed by filtering based on their most recent repository update date.
  • Compliments existing tools like Find-Module to provide another way to explore modules on the PowerShell Gallery.
  • Identify up-and-coming or trending modules by comparing search results including and excluding popular and corporate modules
  • PSGalleryExplorer provides a detailed, informative output of module results to help you quickly identify prime candidates for further exploration.
  • Find-ModuleByCommand allows users to search for modules based on a specific command name, even if the module is not installed locally, providing a quick and easy way to locate modules containing the desired functionality.

Getting Started

Documentation

Documentation for PSGalleryExplorer is available at: https://psgalleryexplorer.readthedocs.io

Installation

# Install PSGalleryExplorer from the PowerShell Gallery
Install-Module -Name "PSGalleryExplorer" -Repository PSGallery -Scope CurrentUser

Quick start

#------------------------------------------------------------------------------------------------
# import the PSGalleryExplorer module
Import-Module -Name "PSGalleryExplorer"
#------------------------------------------------------------------------------------------------
# discover module info by tag
Find-PSGModule -ByTag Telegram
#------------------------------------------------------------------------------------------------
# discover PowerShell modules by # of Gallery Downloads
Find-PSGModule -ByDownloads
#------------------------------------------------------------------------------------------------
# discover the most recently updated modules on repo
Find-PSGModule -ByRecentUpdate RepoUpdate
#------------------------------------------------------------------------------------------------
# discover the most recently updated modules on the PowerShell Gallery
Find-PSGModule -ByRecentUpdate GalleryUpdate
#------------------------------------------------------------------------------------------------
# discover PowerShell modules by # of Gallery Downloads
# include corporate modules and common/popular modules in results
# return top 50
Find-PSGModule -ByDownloads -IncludeCorps -IncludeRegulars -NumberToReturn 50
#------------------------------------------------------------------------------------------------
# discover PowerShell modules by # of repo project stars
Find-PSGModule -ByRepoInfo StarCount
#------------------------------------------------------------------------------------------------
# discover PowerShell modules that could possibly use some help
Find-PSGModule -ByRepoInfo Issues
#------------------------------------------------------------------------------------------------
# discover PowerShell modules by # of repo project subscribers
Find-PSGModule -ByRepoInfo Subscribers
#------------------------------------------------------------------------------------------------
# discover a set of random modules
Find-PSGModule -ByRandom
#------------------------------------------------------------------------------------------------
# discover module info by name
Find-PSGModule -ByName 'PoshGram'
#------------------------------------------------------------------------------------------------
# Returns a list of modules that contain the command Send-TelegramTextMessage
Find-ModuleByCommand -CommandName 'Send-TelegramTextMessage'
#------------------------------------------------------------------------------------------------

Notes

This PowerShell project was created with Catesta.

Contributing

If you'd like to contribute to PSGalleryExplorer, please see the contribution guidelines.

License

This project is licensed under the MIT License.