Skip to content

Latest commit

 

History

History
210 lines (145 loc) · 3.98 KB

Get-PSKoan.md

File metadata and controls

210 lines (145 loc) · 3.98 KB
Raw
external help file Module Name online version schema
PSKoans-help.xml
PSKoans
2.0.0

Get-PSKoan

SYNOPSIS

Gets koan topic metadata for each topic.

SYNTAX

IncludeModule (Default)

Get-PSKoan [-Topic <String[]>] [-IncludeModule <String[]>] [-Scope <String>] [-SkipAttributeParsing]
 [<CommonParameters>]

ModuleOnly

Get-PSKoan [-Topic <String[]>] [-Module <String[]>] [-Scope <String>] [-SkipAttributeParsing]
 [<CommonParameters>]

ListModules

Get-PSKoan [-Topic <String[]>] [-Scope <String>] [-SkipAttributeParsing] [-ListModules] [<CommonParameters>]

DESCRIPTION

Get-PSKoan finds Koans in either the Module or User locations. Koan information includes position and module information, as well as topic name.

EXAMPLES

Example 1

PS C:\> Get-PSKoan

Get all Koans in the PSKoans module, excluding koans for individual modules.

Example 2

PS C:\> Get-PSKoan -IncludeModule *

Get all Koans in the PSKoans module, include all koans for individual PowerShell modules.

Example 3

PS C:\> Get-PSKoan -Topic AboutArrays

Get information about the AboutArrays koans.

Example 4

PS C:\> Get-PSKoan -Module ActiveDirectory

Get koans from the ActiveDirectory module only.

Example 5

PS C:\> Get-PSKoan -Scope User

Get all Koans in the User location, excluding koans for individual modules.

PARAMETERS

-IncludeModule

Get default PowerShell Koans as well as Koans for the specified module. Wildcards are supported.

Type: String[]
Parameter Sets: IncludeModule
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ListModules

List the modules included with PSKoans.

Type: SwitchParameter
Parameter Sets: ListModules
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Module

Get Koans for the specified module only. Wildcards are supported.

Type: String[]
Parameter Sets: ModuleOnly
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Scope

Get koans from the specified scope. The default scope is Module. User scope gets Koan information from the location used by Get-PSKoanLocation.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: User, Module

Required: False
Position: Named
Default value: Module
Accept pipeline input: False
Accept wildcard characters: False

-SkipAttributeParsing

By default, Get-PSKoan attempts to retrieve the Position and Module information from the Koan attribute in each file. This process may be skipped by using this parameter.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Topic

Reset the specified topic or topics. Wildcards are supported.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

PSKoans.KoanInfo

A simple object noting the topic name, koan topic position, and module the topic belongs to.

NOTES

Author: Chris Dent (@indented-automation)

RELATED LINKS

Get-PSKoan

PSKoans