New-PSScriptBuilderConfiguration¶
SYNOPSIS¶
Creates a new PSScriptBuilder configuration file with default values.
SYNTAX¶
New-PSScriptBuilderConfiguration [[-Path] <String>] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION¶
The New-PSScriptBuilderConfiguration cmdlet creates a new psscriptbuilder.config.json file with default values in the specified or currently set project root directory.
If no -ProjectRoot is specified, the cmdlet uses the project root set via Set-PSScriptBuilderProjectRoot. If neither is set, the current working directory is used.
If the configuration file already exists, the cmdlet fails with an error. Use -Force to overwrite an existing file.
The cmdlet supports PowerShell's -WhatIf and -Confirm parameters for safe preview and confirmation.
EXAMPLES¶
EXAMPLE 1¶
EXAMPLE 2¶
EXAMPLE 3¶
PARAMETERS¶
-Path¶
The directory in which to create the configuration file. If not specified, the currently set project root or the current working directory is used.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force¶
Overwrites the configuration file if it already exists.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
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
-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
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.