| external help file | Module Name | online version | schema |
|---|---|---|---|
PSKoans-help.xml |
PSKoans |
2.0.0 |
Reflect on your progress and check your answers.
Show-Karma [-Topic <String[]>] [-ClearScreen] [-Detailed] [<CommonParameters>]Show-Karma [-Topic <String[]>] -IncludeModule <String[]> [-Contemplate] [-ClearScreen] [<CommonParameters>]Show-Karma [-Topic <String[]>] -Module <String[]> [-Contemplate] [-ClearScreen] [<CommonParameters>]Show-Karma [-Topic <String[]>] [-Contemplate] [-ClearScreen] [<CommonParameters>]Show-Karma [-Topic <String[]>] -IncludeModule <String[]> [-ClearScreen] [-Detailed] [<CommonParameters>]Show-Karma [-Topic <String[]>] -Module <String[]> [-ClearScreen] [-Detailed] [<CommonParameters>]Show-Karma [-Topic <String[]>] -IncludeModule <String[]> [-List] [-ClearScreen] [<CommonParameters>]Show-Karma [-Topic <String[]>] -Module <String[]> [-List] [-ClearScreen] [<CommonParameters>]Show-Karma [-Topic <String[]>] [-List] [-ClearScreen] [<CommonParameters>]Show-Karma [-Library] [-ClearScreen] [<CommonParameters>]Show-Karma executes Pester against the koans to evaluate if you have made the necessary corrections for success. The default output mode is to the information stream, with decorated flavour text and progress information.
If you want a more data-oriented results report, use Get-Karma instead.
Show-KarmaAssesses the koan lessons, and displays the meditation prompt with the results.
Show-Karma -ContemplateOpens the current koan file in the editor specified by the Editor setting.
Use Set-PSKoanSetting to change the editor used.
If a known editor (code, code-insiders, codium, or atom) is used, PSKoans will pass along line information as well.
Show-Karma -Contemplate -Topic AboutComparisonOpens the specified AboutComparison topic file in the preferred editor.
Clears the console host before displaying the meditation prompt.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOpens your local koans library. If VS Code is installed, it will start VS Code in the folder. Otherwise, the folder is simply opened in a file explorer.
If you have VS Code Insiders installed, you can set $env:PSKoans_EditorPreference = "code-insiders" to indicate VS Code Insiders should be opened instead.
Type: SwitchParameter
Parameter Sets: OpenFile-IncludeModule, OpenFile-ModuleOnly, OpenFile
Aliases: Meditate
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAdds a summarized view of the current topic file to the meditation prompt. The summary will contain a full list of all koans in the file, and indicate their current status.
Type: SwitchParameter
Parameter Sets: Default, IncludeModule, ModuleOnly
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow Karma for the default PowerShell Koans as well as Koans for the specified module. Wildcards are supported.
Type: String[]
Parameter Sets: OpenFile-IncludeModule, IncludeModule, ListKoans-IncludeModule
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueOpens the current KoanLocation folder in the preferred editor.
To set the preferred editor, use Set-PSKoanSetting.
If the preferred editor cannot be found or the setting is cleared, the folder will be opened in the default handler. This should be Windows Explorer on Windows, Finder on Mac, etc.
Type: SwitchParameter
Parameter Sets: OpenFolder
Aliases: OpenFolder
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOutput a complete list of available koan topics.
Type: SwitchParameter
Parameter Sets: ListKoans-IncludeModule, ListKoans-ModuleOnly, ListKoans
Aliases: ListKoans, ListTopics
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow Karma for Koans in the specified module only. Wildcards are supported.
Type: String[]
Parameter Sets: OpenFile-ModuleOnly, ModuleOnly, ListKoans-ModuleOnly
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueExecute koans only from the selected Topic(s).
Wildcard patterns are permitted.
When provided along with -Contemplate, the targeted topic will be respected.
Type: String[]
Parameter Sets: Default, OpenFile-IncludeModule, OpenFile-ModuleOnly, OpenFile, IncludeModule, ModuleOnly, ListKoans-IncludeModule, ListKoans-ModuleOnly, ListKoans
Aliases: Koan, File
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.
Author: Joel Sallow (@vexx32)