Set-PSKoanSetting
February 28, 2021 ยท View on GitHub
SYNOPSIS
Modifies the configuration settings for PSKoans.
SYNTAX
Single (Default)
Set-PSKoanSetting [-Name] <String> [-Value] <Object> [-WhatIf] [-Confirm] [<CommonParameters>]
Multiple
Set-PSKoanSetting [-Settings] <Hashtable> [-WhatIf] [-Confirm] [<CommonParameters>]
Reset
Set-PSKoanSetting [-Reset] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Sets module configuration data in a JSON file in the user's $HOME directory.
EXAMPLES
EXAMPLE 1
Set-PSKoanSetting -Name LibraryFolder -Value "./PSKoans"
Sets the library folder location to the PSKoans folder in the current directory.
EXAMPLE 2
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.
PARAMETERS
-Confirm
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
-Name
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
-Reset
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
-Settings
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
-Value
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
-WhatIf
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
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
OUTPUTS
System.Void
NOTES
Author: Joel Sallow (@vexx32)