Functions/Get-ModuleHelp.ps1
|
Function Get-ModuleHelp { <# .Synopsis Get commands from specific module(s) or a list of modules .DESCRIPTION Retreive all module names or commands filtered by name and/or command name. .PARAMETER Name Use module name filter option to limit help information to specific module(s). Supports wildcards .PARAMETER CommandName Retreive comnmand information from all modules or from specifc module(s). Supports wildcards .PARAMETER ListAvailable Expand scope to include available modules (not only imported) .NOTES Author: Jack Olsson (Inspired by Jeff Hicks - Get-ModuleCommand) .EXAMPLE Get-ModuleHelp -Name PSJumpStart List all exported commands for the 'PSJumpStart' module .EXAMPLE Get-ModuleHelp -CommandName "*address*" Get all commands containing 'address' from imported modules .EXAMPLE Get-ModuleHelp -ListAvailable -CommandName "*clip*" | Select-Object Name,Synopsis,ModulePath | Format-Table| Form List all available modules with commands containing the string 'clip' and where they are. .EXAMPLE Get-ModuleHelp -Name "*PowerShell*" -ListAvailible List all modules containing the name 'PowerShell' .EXAMPLE Get-ModuleHelp List imported modules #> [cmdletbinding(DefaultParameterSetName = "name")] [Alias("gmh")] [OutputType("ModuleHelp")] Param( [Parameter( Position = 0, HelpMessage = "The name of an installed/available module", ValueFromPipelineByPropertyName )] [SupportsWildcards()] [string]$Name, [Parameter( HelpMessage = "Command name to search for" )] [SupportsWildcards()] [string]$CommandName, [switch]$ListAvailable ) Begin { Write-Verbose "Starting $($MyInvocation.MyCommand)" $PSBoundParameters.Add("ErrorAction", "stop") #region local functions function getModuleInfo { [cmdletbinding()] param( $module, $CommandName ) Write-Verbose "Using version $($module.version)" $cmds = @() Write-Verbose "Getting exported functions" $cmds += $module.Exportedfunctions.keys | Where-Object { $_ -like "$CommandName" } | Get-Command Write-Verbose "Getting exported cmdlets" $cmds += $module.Exportedcmdlets.keys | Where-Object { $_ -like "$CommandName" } | Get-Command Write-Verbose "Found $($cmds.count) functions and/or cmdlets" $out = foreach ($cmd in $cmds) { Write-Verbose "Processing $($cmd.name)" #get aliases, ignoring errors for those commands without one $alias = (Get-Alias -Definition $cmd.Name -ErrorAction SilentlyContinue).name #it is assumed you have updated help [PSCustomObject]@{ PSTypeName = "ModuleHelp" Name = $cmd.name Alias = $alias Verb = $cmd.verb Noun = $cmd.noun Synopsis = (Get-Help $cmd.name -ShowWindow:$false).synopsis.trim() Type = $cmd.CommandType Version = $cmd.version Help = $cmd.HelpUri ModuleName = $module.name ModulePath = $module.Path Compatible = $module.CompatiblePSEditions PSVersion = $module.PowerShellVersion } } #foreach cmd $out } #endregion } Process { If ([string]::IsNullOrEmpty($Name) -and [string]::IsNullOrEmpty($CommandName)) { if ($ListAvailable) { $out = Get-Module -ListAvailable | ForEach-Object { [PSCustomObject]@{ PSTypeName = "ModuleHelp" Name = $_.name Alias = "" Verb = "" Noun = "" Synopsis = $_.Description Type = $null Version = $_.version Help = $_.HelpInfoUri ModuleName = "Available Modules" ModulePath = $_.Path Compatible = $_.CompatiblePSEditions PSVersion = $_.PowerShellVersion } } } else { $out = Get-InstalledModule | ForEach-Object { [PSCustomObject]@{ PSTypeName = "ModuleHelp" Name = $_.name Alias = "" Verb = "" Noun = "" Synopsis = $_.Description Type = $null Version = $_.version Help = $_.HelpInfoUri ModuleName = "Installed Modules" ModulePath = $_.Path Compatible = $_.CompatiblePSEditions PSVersion = $_.PowerShellVersion } } } } else { if ([string]::IsNullOrEmpty($CommandName)) { $CommandName = "*" } if ([string]::IsNullOrEmpty($Name)) { $Name = "*" } if ($ListAvailable) { $out = Get-Module -Name $Name -ListAvailable | ForEach-Object { #We need to rebind to object (reason unknown!!) getModuleInfo -module $_ -CommandName $CommandName } } else { $out = Get-Module -Name $Name | ForEach-Object { getModuleInfo -module $_ -CommandName $CommandName } } } #display results sorted by name for better formatting $out | Sort-Object -Property ModuleName, Name } End { Write-Verbose "Ending $($MyInvocation.MyCommand)" } } #close function |