Get-PSKoanSetting.md

external help file	Module Name	online version	schema
PSKoans-help.xml	PSKoans	https://github.com/vexx32/PSKoans/tree/main/docs/Get-PSKoanSetting.md	2.0.0

Get-PSKoanSetting

SYNOPSIS

Retrieves the configuration settings for PSKoans.

SYNTAX

Get-PSKoanSetting [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

Retrieves configuration data from the locally stored json file in $HOME/.config/PSKoans.

EXAMPLES

EXAMPLE 1

Get-PSKoanSetting

Retrieves all module settings.

EXAMPLE 2

Get-PSKoanSetting -Name LibraryFolder

Retrieves the library folder location (also retrievable with Get-PSKoanLocation).

EXAMPLE 3

Get-PSKoanSetting -Name Editor

Retrieves the text editor that PSKoans will use for Show-Karma -Contemplate.

PARAMETERS

-Name

Specifies which setting value to retrieve.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
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.String

When a specific setting is requested, returns only the value of that setting, which will usually be a string.

System.Management.Automation.PSObject

When all settings are requested, returns an object with properties representing each setting.

NOTES

Author: Joel Sallow (@vexx32)

RELATED LINKS

Set-PSKoanSetting

PSKoans