| external help file | PSScriptTools-help.xml |
|---|---|
| Module Name | PSScriptTools |
| online version | https://jdhitsolutions.com/yourls/71e8ba |
| schema | 2.0.0 |
Get a summary of module commands.
Get-ModuleCommand [-Name] <String> [-CommandName <String>] [-ListAvailable]
[<CommonParameters>]This is an alternative to Get-Command to make it easier to see at a glance what commands are contained within a module and what they can do. By default, Get-ModuleCommand looks for loaded modules. Use -ListAvailable to see commands in the module but not currently loaded. Note that if the help file is malformed or missing, you might get oddly formatted results. If the help file does not define a synopsis, you will see the command's syntax.
PS C:\> Get-ModuleCommand PSCalendar
ModuleName: PSCalendar [v2.10.1]
Name Alias Synopsis
---- ----- --------
Export-PSCalendarConfiguration Save-PSCalendarConfiguration Save the current calendar configuration
settings to a file.
Get-Calendar cal Displays a visual representation of a
calendar.
Get-MonthName mon Get the list of month names.
Get-NCalendar ncal Display a Linux-style ncal calendar.
Get-PSCalendarConfiguration Get the current PSCalendar ANSI
configuration.
Set-PSCalendarConfiguration Modify the PSCalendar ANSI
configuration.
Show-Calendar scal Display a colorized calendar month in
the console.
Show-GuiCalendar gcal Display a WPF-based calendar.
Show-PSCalendarHelp Display a help PDF file for the
PSCalendar module.Get module commands using the default formatted view. You can install the PSCalendar module from the PowerShell Gallery.
PS C:\> Get-ModuleCommand SmbShare -ListAvailable | Format-List
ModuleName : SmbShare
Name : Block-SmbShareAccess
Alias : blsmba
Synopsis : Adds a deny ACE for a trustee to the security descriptor of the SMB share.
ModuleName : SmbShare
Name : Close-SmbOpenFile
Alias : cssmbo
Synopsis : Closes a file that is open by one of the clients of the SMB server.
ModuleName : SmbShare
Name : Close-SmbSession
Alias : cssmbse
Synopsis : Ends forcibly the SMB session.
...Using the default list view.
PS C:\> Get-ModuleCommand PSScriptTools | Format-Table -view verb
Verb: Add
Name Alias Type Synopsis
---- ----- ---- --------
Add-Border Function Create a text border around a string.
Verb: Compare
Name Alias Type Synopsis
---- ----- ---- --------
Compare-Module cmo Function Compare PowerShell module versions.
...Display commands using a custom table view called 'Verb'.
PS C:\ Get-ModuleCommand PSScriptTools | Format-Table -view version
ModuleName: PSScriptTools [v3.1.0]
Name Alias Compatible PSVersion
---- ----- ---------- ---------
Add-Border ab {Desktop, Core} 5.1
Compare-Module cmo {Desktop, Core} 5.1
Compare-Script csc {Desktop, Core} 5.1
...Using the custom table view 'version'.
Indicates that this cmdlet gets all installed modules. Get-Module finds modules in paths listed in the PSModulePath environment variable. Without this parameter, Get-ModuleCommand gets only the modules that are both listed in the PSModulePath environment variable, and that are loaded in the current session.
ListAvailable does not return information about modules that are not found in the PSModulePath environment variable, even if those modules are loaded in the current session.
If you have multiple versions of the module, you might get duplicated entries.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of an installed module.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: TrueCommand name to search for
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Learn more about PowerShell: https://jdhitsolutions.com/yourls/newsletter