external help file | Module Name | online version | schema |
---|---|---|---|
PSKoans-help.xml |
PSKoans |
2.0.0 |
Modifies the configuration settings for PSKoans.
Set-PSKoanSetting [-Name] <String> [-Value] <Object> [-WhatIf] [-Confirm] [<CommonParameters>]
Set-PSKoanSetting [-Settings] <Hashtable> [-WhatIf] [-Confirm] [<CommonParameters>]
Set-PSKoanSetting [-Reset] [-WhatIf] [-Confirm] [<CommonParameters>]
Sets module configuration data in a JSON file in the user's $HOME directory.
Set-PSKoanSetting -Name LibraryFolder -Value "./PSKoans"
Sets the library folder location to the PSKoans
folder in the current directory.
Set-PSKoanSetting -Name Editor -Value "atom"
Sets the text editor used for Show-Karma -Contemplate
to GitHub Atom. For a
list of text editors known to PSKoans, see Example 2 in the documentation for
Show-Karma -Contemplate.
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies which setting value to modify.
Type: String
Parameter Sets: Single
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Resets the user's settings to the default values.
Type: SwitchParameter
Parameter Sets: Reset
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
A hashtable containing one or more settings to modify and their values.
Type: Hashtable
Parameter Sets: Multiple
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Provides a value to apply to the target setting.
Type: Object
Parameter Sets: Single
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This 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)