en-us/PSKoans-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Blank</command:name> <command:verb>Get</command:verb> <command:noun>Blank</command:noun> <maml:description> <maml:para>Gets a blank item that does not equal anything.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a blank object that is never equal to anything, including itself. This function exists to permit blank spaces such as `__` to be used without quotation marks where it is situationally appropriate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Blank</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Blank</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Blank</dev:code> <dev:remarks> <maml:para>Returns a blank object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>__</dev:code> <dev:remarks> <maml:para>Returns a blank object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans/tree/master/docs/Get-Blank.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/vexx32/PSKoans</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PSKoanLocation</command:name> <command:verb>Get</command:verb> <command:noun>PSKoanLocation</command:noun> <maml:description> <maml:para>Gets the folder location where the current user's copy of the PSKoans lessons are stored.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the current value of the PSKoans working library path. This value defaults to `$HOME\PSKoans` but can be changed as you prefer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSKoanLocation</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-PSKoanLocation C:\Users\Timmy\PSKoans</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans/tree/master/docs/Get-PSKoanLocation.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/vexx32/PSKoans</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Measure-Karma</command:name> <command:verb>Measure</command:verb> <command:noun>Karma</command:noun> <maml:description> <maml:para>Reflect on your progress and check your answers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Measure-Karma executes Pester against the koans to evaluate if you have made the necessary corrections for success.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Measure-Karma</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClearScreen</maml:name> <maml:Description> <maml:para>Clears the console host before displaying the meditation prompt.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Meditate"> <maml:name>Contemplate</maml:name> <maml:Description> <maml:para>Opens 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.</maml:para> <maml:para>If you have VS Code Insiders installed, you can set `$env:PSKoans_EditorPreference = "code-insiders"` to indicate VS Code Insiders should be opened instead.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts for confirmation before making any changes. Use with -Reset to always be prompted before any changes are made.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>When used with -Reset, displays what will be reset without actually resetting anything.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Measure-Karma</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClearScreen</maml:name> <maml:Description> <maml:para>Clears the console host before displaying the meditation prompt.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ListKoans"> <maml:name>ListTopics</maml:name> <maml:Description> <maml:para>Output a complete list of available koan topics.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts for confirmation before making any changes. Use with -Reset to always be prompted before any changes are made.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>When used with -Reset, displays what will be reset without actually resetting anything.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Measure-Karma</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClearScreen</maml:name> <maml:Description> <maml:para>Clears the console host before displaying the meditation prompt.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Reset</maml:name> <maml:Description> <maml:para>Resets everything in your local koan folder to the initial state. Use with caution. This can be used after using `Set-PSKoanLocation` to a new directory to get started.</maml:para> <maml:para>If combined with `-Topic`, resets only the specified topics.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Koan, File"> <maml:name>Topic</maml:name> <maml:Description> <maml:para>Execute koans only from the selected Topic(s). Regex patterns are permitted.</maml:para> <maml:para>If combined with `-Reset`, the specified topics are reset to their initial states.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts for confirmation before making any changes. Use with -Reset to always be prompted before any changes are made.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>When used with -Reset, displays what will be reset without actually resetting anything.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Measure-Karma</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClearScreen</maml:name> <maml:Description> <maml:para>Clears the console host before displaying the meditation prompt.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Koan, File"> <maml:name>Topic</maml:name> <maml:Description> <maml:para>Execute koans only from the selected Topic(s). Regex patterns are permitted.</maml:para> <maml:para>If combined with `-Reset`, the specified topics are reset to their initial states.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts for confirmation before making any changes. Use with -Reset to always be prompted before any changes are made.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>When used with -Reset, displays what will be reset without actually resetting anything.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClearScreen</maml:name> <maml:Description> <maml:para>Clears the console host before displaying the meditation prompt.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Meditate"> <maml:name>Contemplate</maml:name> <maml:Description> <maml:para>Opens 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.</maml:para> <maml:para>If you have VS Code Insiders installed, you can set `$env:PSKoans_EditorPreference = "code-insiders"` to indicate VS Code Insiders should be opened instead.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ListKoans"> <maml:name>ListTopics</maml:name> <maml:Description> <maml:para>Output a complete list of available koan topics.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Reset</maml:name> <maml:Description> <maml:para>Resets everything in your local koan folder to the initial state. Use with caution. This can be used after using `Set-PSKoanLocation` to a new directory to get started.</maml:para> <maml:para>If combined with `-Topic`, resets only the specified topics.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Koan, File"> <maml:name>Topic</maml:name> <maml:Description> <maml:para>Execute koans only from the selected Topic(s). Regex patterns are permitted.</maml:para> <maml:para>If combined with `-Reset`, the specified topics are reset to their initial states.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts for confirmation before making any changes. Use with -Reset to always be prompted before any changes are made.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>When used with -Reset, displays what will be reset without actually resetting anything.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Measure-Karma</dev:code> <dev:remarks> <maml:para>Assesses the koan lessons, and displays the meditation prompt with the results.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Measure-Karma -Contemplate</dev:code> <dev:remarks> <maml:para>Opens the user's koans folder, housed in `home\PSKoans`. If VS Code is in `$env:Path`, opens VS Code to the workspace location. Otherwise, the folder is opened in a file explorer.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Measure-Karma -Reset</dev:code> <dev:remarks> <maml:para>Prompts for confirmation before wiping out the user's koans folder and restoring it back to its initial state. This can be used to completely reset the koan files whenever needed, or to populate a new location with fresh koans after using `Set-PSKoanLocation`.</maml:para> <maml:para>When used with -Topic, only the specified topics are reset.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans/tree/master/docs/Measure-Karma.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/vexx32/PSKoans</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-Advice</command:name> <command:verb>Register</command:verb> <command:noun>Advice</command:noun> <maml:description> <maml:para>Causes powershell to write a random piece of advice on each start.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Causes powershell to write a random piece of advice on each start. This is done by creating / modifying the powershell profile to call `Show-Advice` on each session start.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-Advice</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TargetProfile</maml:name> <maml:Description> <maml:para>Specify a named profile to modify. Valid values are:</maml:para> <maml:para>- CurrentUserCurrentHost (Default)</maml:para> <maml:para>- CurrentUserAllHosts</maml:para> <maml:para>- AllUsersCurrentHost</maml:para> <maml:para>- AllUsersAllHosts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CurrentUserCurrentHost</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before modifying your profile.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TargetProfile</maml:name> <maml:Description> <maml:para>Specify a named profile to modify. Valid values are:</maml:para> <maml:para>- CurrentUserCurrentHost (Default)</maml:para> <maml:para>- CurrentUserAllHosts</maml:para> <maml:para>- AllUsersCurrentHost</maml:para> <maml:para>- AllUsersAllHosts</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>CurrentUserCurrentHost</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before modifying your profile.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Register-Advice</dev:code> <dev:remarks> <maml:para>Causes powershell to write a random piece of advice on each start.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans/tree/master/docs/Register-Advice.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/vexx32/PSKoans</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-PSKoanLocation</command:name> <command:verb>Set</command:verb> <command:noun>PSKoanLocation</command:noun> <maml:description> <maml:para>Sets the PSKoans folder location where koan lesson files will be stored and retrieved.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the module-scoped PSKoanLocation variable in order to modify where the module looks for and stores its koans lesson files.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PSKoanLocation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="PSPath, Folder"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specify the path to set the koan location to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts for confirmation before changing the koan location.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="PSPath, Folder"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Specify the path to set the koan location to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts for confirmation before changing the koan location.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The PSKoans folder specified will become the location to look for koans files. If this location is empty or nonexistent, it will be created and populated with a pristine copy of the koans library when Measure-Karma is run next.</maml:para> <maml:para>You can optionally populate it yourself by running `Measure-Karma -Reset` following use of this cmdlet.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-PSKoanLocation -Path C:\PSKoans Measure-Karma</dev:code> <dev:remarks> <maml:para>Sets the koan folder location to 'C:\PSKoans' and then invokes Measure-Karma to examine that location for koan files.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans/tree/master/docs/Set-PSKoanLocation.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/vexx32/PSKoans</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-Advice</command:name> <command:verb>Show</command:verb> <command:noun>Advice</command:noun> <maml:description> <maml:para>Prints a piece of advice to the screen.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Prints a piece of advice to the screen. Advice snippets are stored in a small library file in the module folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-Advice</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The title or name of the specific advice snippet to display.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The title or name of the specific advice snippet to display.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Advice</dev:code> <dev:remarks> <maml:para>Print a random piece of advice to the screen.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans/tree/master/docs/Show-Advice.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/vexx32/PSKoans</maml:linkText> <maml:uri>https://github.com/vexx32/PSKoans</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |