{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"PSConfigFile Description Creates a Config file with Commands , Variables , PSDrives , Aliases\\Shortcuts and Default Start locations . You can then execute this default config when your profile is loaded, or when a specific module is imported, or you can run it manually. This way you can quickly and easily switch between environment setups with these default values Function Synopsis Add-AliasToPSConfigFile Creates Shortcuts (Aliases) to commands or script blocks Add-CommandToPSConfigFile Adds a command or script block to the config file, to be executed every time the invoke function is called. Add-LocationToPSConfigFile Adds default location to the config file. Add-PSDriveToPSConfigFile Add PSDrive to the config file. Add-VariableToPSConfigFile Adds variable to the config file. Invoke-PSConfigFile Executes the config from the json file. New-PSConfigFile Creates a new config file Set-PSConfigFileExecution Adds functionality to add the execution to your profile or a PowerShell module Show-PSConfigFile Display what's configured in the config file.","title":"PSConfigFile"},{"location":"#psconfigfile","text":"","title":"PSConfigFile"},{"location":"#description","text":"Creates a Config file with Commands , Variables , PSDrives , Aliases\\Shortcuts and Default Start locations . You can then execute this default config when your profile is loaded, or when a specific module is imported, or you can run it manually. This way you can quickly and easily switch between environment setups with these default values","title":"Description"},{"location":"#function-synopsis","text":"","title":"Function Synopsis"},{"location":"#add-aliastopsconfigfile","text":"Creates Shortcuts (Aliases) to commands or script blocks","title":"Add-AliasToPSConfigFile"},{"location":"#add-commandtopsconfigfile","text":"Adds a command or script block to the config file, to be executed every time the invoke function is called.","title":"Add-CommandToPSConfigFile"},{"location":"#add-locationtopsconfigfile","text":"Adds default location to the config file.","title":"Add-LocationToPSConfigFile"},{"location":"#add-psdrivetopsconfigfile","text":"Add PSDrive to the config file.","title":"Add-PSDriveToPSConfigFile"},{"location":"#add-variabletopsconfigfile","text":"Adds variable to the config file.","title":"Add-VariableToPSConfigFile"},{"location":"#invoke-psconfigfile","text":"Executes the config from the json file.","title":"Invoke-PSConfigFile"},{"location":"#new-psconfigfile","text":"Creates a new config file","title":"New-PSConfigFile"},{"location":"#set-psconfigfileexecution","text":"Adds functionality to add the execution to your profile or a PowerShell module","title":"Set-PSConfigFileExecution"},{"location":"#show-psconfigfile","text":"Display what's configured in the config file.","title":"Show-PSConfigFile"},{"location":"Add-AliasToPSConfigFile/","text":"Add-AliasToPSConfigFile SYNOPSIS Creates Shortcuts (Aliases) to commands or script blocks SYNTAX Add-AliasToPSConfigFile [[-ConfigFile] <FileInfo>] [[-AliasName] <String>] [[-CommandToRun] <String>] [<CommonParameters>] DESCRIPTION Creates Shortcuts (Aliases) to commands or script blocks EXAMPLES EXAMPLE 1 Add-AliasToPSConfigFile -ConfigFile $PSConfigFile -AliasName psml -CommandToRun \"import-module .\\*.psm1 -force -verbose\" PARAMETERS -AliasName Name to use for the command Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -CommandToRun Command to run in a string format Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 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 NOTES RELATED LINKS","title":"Add-AliasToPSConfigFile"},{"location":"Add-AliasToPSConfigFile/#add-aliastopsconfigfile","text":"","title":"Add-AliasToPSConfigFile"},{"location":"Add-AliasToPSConfigFile/#synopsis","text":"Creates Shortcuts (Aliases) to commands or script blocks","title":"SYNOPSIS"},{"location":"Add-AliasToPSConfigFile/#syntax","text":"Add-AliasToPSConfigFile [[-ConfigFile] <FileInfo>] [[-AliasName] <String>] [[-CommandToRun] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Add-AliasToPSConfigFile/#description","text":"Creates Shortcuts (Aliases) to commands or script blocks","title":"DESCRIPTION"},{"location":"Add-AliasToPSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"Add-AliasToPSConfigFile/#example-1","text":"Add-AliasToPSConfigFile -ConfigFile $PSConfigFile -AliasName psml -CommandToRun \"import-module .\\*.psm1 -force -verbose\"","title":"EXAMPLE 1"},{"location":"Add-AliasToPSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Add-AliasToPSConfigFile/#-aliasname","text":"Name to use for the command Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-AliasName"},{"location":"Add-AliasToPSConfigFile/#-commandtorun","text":"Command to run in a string format Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-CommandToRun"},{"location":"Add-AliasToPSConfigFile/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Add-AliasToPSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Add-AliasToPSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"Add-AliasToPSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Add-AliasToPSConfigFile/#notes","text":"","title":"NOTES"},{"location":"Add-AliasToPSConfigFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"Add-CommandToPSConfigFile/","text":"Add-CommandToPSConfigFile SYNOPSIS Adds a command or script block to the config file, to be executed every time the invoke function is called. SYNTAX Add-CommandToPSConfigFile [[-ConfigFile] <FileInfo>] [[-ScriptBlockName] <String>] [[-ScriptBlock] <String>] [<CommonParameters>] DESCRIPTION Adds a command or script block to the config file, to be executed every time the invoke function is called. EXAMPLES EXAMPLE 1 Add-CommandToPSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -ScriptBlockName DriveC -ScriptBlock \"get-childitem c:\\\" PARAMETERS -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -ScriptBlock The commands to be executed Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -ScriptBlockName Name for the script block Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 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 NOTES RELATED LINKS","title":"Add-CommandToPSConfigFile"},{"location":"Add-CommandToPSConfigFile/#add-commandtopsconfigfile","text":"","title":"Add-CommandToPSConfigFile"},{"location":"Add-CommandToPSConfigFile/#synopsis","text":"Adds a command or script block to the config file, to be executed every time the invoke function is called.","title":"SYNOPSIS"},{"location":"Add-CommandToPSConfigFile/#syntax","text":"Add-CommandToPSConfigFile [[-ConfigFile] <FileInfo>] [[-ScriptBlockName] <String>] [[-ScriptBlock] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Add-CommandToPSConfigFile/#description","text":"Adds a command or script block to the config file, to be executed every time the invoke function is called.","title":"DESCRIPTION"},{"location":"Add-CommandToPSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"Add-CommandToPSConfigFile/#example-1","text":"Add-CommandToPSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -ScriptBlockName DriveC -ScriptBlock \"get-childitem c:\\\"","title":"EXAMPLE 1"},{"location":"Add-CommandToPSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Add-CommandToPSConfigFile/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Add-CommandToPSConfigFile/#-scriptblock","text":"The commands to be executed Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ScriptBlock"},{"location":"Add-CommandToPSConfigFile/#-scriptblockname","text":"Name for the script block Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ScriptBlockName"},{"location":"Add-CommandToPSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Add-CommandToPSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"Add-CommandToPSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Add-CommandToPSConfigFile/#notes","text":"","title":"NOTES"},{"location":"Add-CommandToPSConfigFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"Add-LocationToPSConfigFile/","text":"Add-LocationToPSConfigFile SYNOPSIS Adds default location to the config file. SYNTAX Add-LocationToPSConfigFile [[-ConfigFile] <FileInfo>] [[-Path] <DirectoryInfo>] [<CommonParameters>] DESCRIPTION Adds default location to the config file. EXAMPLES EXAMPLE 1 Add-LocationToPSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -Path c:\\temp PARAMETERS -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Path Path to be set. Type: DirectoryInfo Parameter Sets: (All) Aliases: Required: False Position: 2 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 NOTES RELATED LINKS","title":"Add-LocationToPSConfigFile"},{"location":"Add-LocationToPSConfigFile/#add-locationtopsconfigfile","text":"","title":"Add-LocationToPSConfigFile"},{"location":"Add-LocationToPSConfigFile/#synopsis","text":"Adds default location to the config file.","title":"SYNOPSIS"},{"location":"Add-LocationToPSConfigFile/#syntax","text":"Add-LocationToPSConfigFile [[-ConfigFile] <FileInfo>] [[-Path] <DirectoryInfo>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Add-LocationToPSConfigFile/#description","text":"Adds default location to the config file.","title":"DESCRIPTION"},{"location":"Add-LocationToPSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"Add-LocationToPSConfigFile/#example-1","text":"Add-LocationToPSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -Path c:\\temp","title":"EXAMPLE 1"},{"location":"Add-LocationToPSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Add-LocationToPSConfigFile/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Add-LocationToPSConfigFile/#-path","text":"Path to be set. Type: DirectoryInfo Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Path"},{"location":"Add-LocationToPSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Add-LocationToPSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"Add-LocationToPSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Add-LocationToPSConfigFile/#notes","text":"","title":"NOTES"},{"location":"Add-LocationToPSConfigFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"Add-PSDriveToPSConfigFile/","text":"Add-PSDriveToPSConfigFile SYNOPSIS Add PSDrive to the config file. SYNTAX Add-PSDriveToPSConfigFile [[-ConfigFile] <FileInfo>] [[-DriveName] <String>] [<CommonParameters>] DESCRIPTION Add PSDrive to the config file. EXAMPLES EXAMPLE 1 Add-PSDriveToPSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -DriveName TempDrive PARAMETERS -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -DriveName Name of the PSDrive (PSDrive needs to be created first with New-PSDrive) Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 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 NOTES RELATED LINKS","title":"Add-PSDriveToPSConfigFile"},{"location":"Add-PSDriveToPSConfigFile/#add-psdrivetopsconfigfile","text":"","title":"Add-PSDriveToPSConfigFile"},{"location":"Add-PSDriveToPSConfigFile/#synopsis","text":"Add PSDrive to the config file.","title":"SYNOPSIS"},{"location":"Add-PSDriveToPSConfigFile/#syntax","text":"Add-PSDriveToPSConfigFile [[-ConfigFile] <FileInfo>] [[-DriveName] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Add-PSDriveToPSConfigFile/#description","text":"Add PSDrive to the config file.","title":"DESCRIPTION"},{"location":"Add-PSDriveToPSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"Add-PSDriveToPSConfigFile/#example-1","text":"Add-PSDriveToPSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -DriveName TempDrive","title":"EXAMPLE 1"},{"location":"Add-PSDriveToPSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Add-PSDriveToPSConfigFile/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Add-PSDriveToPSConfigFile/#-drivename","text":"Name of the PSDrive (PSDrive needs to be created first with New-PSDrive) Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-DriveName"},{"location":"Add-PSDriveToPSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Add-PSDriveToPSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"Add-PSDriveToPSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Add-PSDriveToPSConfigFile/#notes","text":"","title":"NOTES"},{"location":"Add-PSDriveToPSConfigFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"Add-VariableToPSConfigFile/","text":"Add-VariableToPSConfigFile SYNOPSIS Adds variable to the config file. SYNTAX Add-VariableToPSConfigFile [[-ConfigFile] <FileInfo>] [[-VariableNames] <String[]>] [<CommonParameters>] DESCRIPTION Adds variable to the config file. EXAMPLES EXAMPLE 1 Add-VariableToPSConfigFile -ConfigFile $PSConfigFile -VariableNames AzureToken PARAMETERS -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -VariableNames The name of the variable. (Needs to exist already) Type: String[] Parameter Sets: (All) Aliases: Required: False Position: 2 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 NOTES RELATED LINKS","title":"Add-VariableToPSConfigFile"},{"location":"Add-VariableToPSConfigFile/#add-variabletopsconfigfile","text":"","title":"Add-VariableToPSConfigFile"},{"location":"Add-VariableToPSConfigFile/#synopsis","text":"Adds variable to the config file.","title":"SYNOPSIS"},{"location":"Add-VariableToPSConfigFile/#syntax","text":"Add-VariableToPSConfigFile [[-ConfigFile] <FileInfo>] [[-VariableNames] <String[]>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Add-VariableToPSConfigFile/#description","text":"Adds variable to the config file.","title":"DESCRIPTION"},{"location":"Add-VariableToPSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"Add-VariableToPSConfigFile/#example-1","text":"Add-VariableToPSConfigFile -ConfigFile $PSConfigFile -VariableNames AzureToken","title":"EXAMPLE 1"},{"location":"Add-VariableToPSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Add-VariableToPSConfigFile/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Add-VariableToPSConfigFile/#-variablenames","text":"The name of the variable. (Needs to exist already) Type: String[] Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-VariableNames"},{"location":"Add-VariableToPSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Add-VariableToPSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"Add-VariableToPSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Add-VariableToPSConfigFile/#notes","text":"","title":"NOTES"},{"location":"Add-VariableToPSConfigFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"Invoke-PSConfigFile/","text":"Invoke-PSConfigFile SYNOPSIS Executes the config from the json file. SYNTAX Invoke-PSConfigFile [-ConfigFile] <FileInfo> [<CommonParameters>] DESCRIPTION Executes the config from the json file. EXAMPLES EXAMPLE 1 Invoke-PSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json PARAMETERS -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: True Position: 1 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 NOTES RELATED LINKS","title":"Invoke-PSConfigFile"},{"location":"Invoke-PSConfigFile/#invoke-psconfigfile","text":"","title":"Invoke-PSConfigFile"},{"location":"Invoke-PSConfigFile/#synopsis","text":"Executes the config from the json file.","title":"SYNOPSIS"},{"location":"Invoke-PSConfigFile/#syntax","text":"Invoke-PSConfigFile [-ConfigFile] <FileInfo> [<CommonParameters>]","title":"SYNTAX"},{"location":"Invoke-PSConfigFile/#description","text":"Executes the config from the json file.","title":"DESCRIPTION"},{"location":"Invoke-PSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"Invoke-PSConfigFile/#example-1","text":"Invoke-PSConfigFile -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json","title":"EXAMPLE 1"},{"location":"Invoke-PSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Invoke-PSConfigFile/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Invoke-PSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Invoke-PSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"Invoke-PSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Invoke-PSConfigFile/#notes","text":"","title":"NOTES"},{"location":"Invoke-PSConfigFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"New-PSConfigFile/","text":"New-PSConfigFile SYNOPSIS Creates a new config file SYNTAX New-PSConfigFile [-ConfigDir] <DirectoryInfo> [-WhatIf] [-Confirm] [<CommonParameters>] DESCRIPTION Creates a new config file. If a config file already exists in that folder, it will be renamed. It will also create a log file in the same directory. Log file will be used on every execution. EXAMPLES EXAMPLE 1 New-PSConfigFile -ConfigDir C:\\Temp\\jdh PARAMETERS -ConfigDir Directory to create config file Type: DirectoryInfo Parameter Sets: (All) Aliases: Required: True Position: 1 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 -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 NOTES RELATED LINKS","title":"New-PSConfigFile"},{"location":"New-PSConfigFile/#new-psconfigfile","text":"","title":"New-PSConfigFile"},{"location":"New-PSConfigFile/#synopsis","text":"Creates a new config file","title":"SYNOPSIS"},{"location":"New-PSConfigFile/#syntax","text":"New-PSConfigFile [-ConfigDir] <DirectoryInfo> [-WhatIf] [-Confirm] [<CommonParameters>]","title":"SYNTAX"},{"location":"New-PSConfigFile/#description","text":"Creates a new config file. If a config file already exists in that folder, it will be renamed. It will also create a log file in the same directory. Log file will be used on every execution.","title":"DESCRIPTION"},{"location":"New-PSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"New-PSConfigFile/#example-1","text":"New-PSConfigFile -ConfigDir C:\\Temp\\jdh","title":"EXAMPLE 1"},{"location":"New-PSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"New-PSConfigFile/#-configdir","text":"Directory to create config file Type: DirectoryInfo Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigDir"},{"location":"New-PSConfigFile/#-confirm","text":"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","title":"-Confirm"},{"location":"New-PSConfigFile/#-whatif","text":"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","title":"-WhatIf"},{"location":"New-PSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"New-PSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"New-PSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"New-PSConfigFile/#notes","text":"","title":"NOTES"},{"location":"New-PSConfigFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"PSConfigFile/","text":"PSConfigFile Module Description Creates a Config file with Commands, Variables, PSDrives, Aliases\\Shortcuts and Default Start locations. You can then execute this default config when your profile is loaded, or when a specific module is imported, or you can run it manually. This way you can quickly and easily switch between environment setups with these default values PSConfigFile Cmdlets Add-AliasToPSConfigFile Creates Shortcuts (Aliases) to commands or script blocks Add-CommandToPSConfigFile Adds a command or script block to the config file, to be executed every time the invoke function is called. Add-LocationToPSConfigFile Adds default location to the config file. Add-PSDriveToPSConfigFile Add PSDrive to the config file. Add-VariableToPSConfigFile Adds variable to the config file. Invoke-PSConfigFile Executes the config from the json file. New-PSConfigFile Creates a new config file Set-PSConfigFileExecution Adds functionality to add the execution to your profile or a PowerShell module Show-PSConfigFile Display what's configured in the config file.","title":"PSConfigFile Module"},{"location":"PSConfigFile/#psconfigfile-module","text":"","title":"PSConfigFile Module"},{"location":"PSConfigFile/#description","text":"Creates a Config file with Commands, Variables, PSDrives, Aliases\\Shortcuts and Default Start locations. You can then execute this default config when your profile is loaded, or when a specific module is imported, or you can run it manually. This way you can quickly and easily switch between environment setups with these default values","title":"Description"},{"location":"PSConfigFile/#psconfigfile-cmdlets","text":"","title":"PSConfigFile Cmdlets"},{"location":"PSConfigFile/#add-aliastopsconfigfile","text":"Creates Shortcuts (Aliases) to commands or script blocks","title":"Add-AliasToPSConfigFile"},{"location":"PSConfigFile/#add-commandtopsconfigfile","text":"Adds a command or script block to the config file, to be executed every time the invoke function is called.","title":"Add-CommandToPSConfigFile"},{"location":"PSConfigFile/#add-locationtopsconfigfile","text":"Adds default location to the config file.","title":"Add-LocationToPSConfigFile"},{"location":"PSConfigFile/#add-psdrivetopsconfigfile","text":"Add PSDrive to the config file.","title":"Add-PSDriveToPSConfigFile"},{"location":"PSConfigFile/#add-variabletopsconfigfile","text":"Adds variable to the config file.","title":"Add-VariableToPSConfigFile"},{"location":"PSConfigFile/#invoke-psconfigfile","text":"Executes the config from the json file.","title":"Invoke-PSConfigFile"},{"location":"PSConfigFile/#new-psconfigfile","text":"Creates a new config file","title":"New-PSConfigFile"},{"location":"PSConfigFile/#set-psconfigfileexecution","text":"Adds functionality to add the execution to your profile or a PowerShell module","title":"Set-PSConfigFileExecution"},{"location":"PSConfigFile/#show-psconfigfile","text":"Display what's configured in the config file.","title":"Show-PSConfigFile"},{"location":"Set-PSConfigFileExecution/","text":"Set-PSConfigFileExecution SYNOPSIS Adds functionality to add the execution to your profile or a PowerShell module SYNTAX Profile (Default) Set-PSConfigFileExecution -ConfigFile <FileInfo> [-PSProfile <String>] [-ExecuteNow] [-WhatIf] [-Confirm] [<CommonParameters>] Module Set-PSConfigFileExecution -ConfigFile <FileInfo> [-PSModule <String>] [-PathToPSM1File <FileInfo>] [-ExecuteNow] [-WhatIf] [-Confirm] [<CommonParameters>] DESCRIPTION Adds functionality to add the execution to your profile or a PowerShell module EXAMPLES EXAMPLE 1 Set-PSConfigFileExecution -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -PSProfile AddScript -PSModule AddScript -PathToPSM1File C:\\Utils\\LabScripts\\LabScripts.psm1 PARAMETERS -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -ExecuteNow Execute the config file, to make sure everything runs as expected. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False -PathToPSM1File Path to the .psm1 file Type: FileInfo Parameter Sets: Module Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -PSModule Enable or disable loading of config when a specific module is loaded. Type: String Parameter Sets: Module Aliases: Required: False Position: Named Default value: Ignore Accept pipeline input: False Accept wildcard characters: False -PSProfile Enable or disable loading of config when your ps profile is loaded. Type: String Parameter Sets: Profile Aliases: Required: False Position: Named Default value: Ignore 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 -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 NOTES RELATED LINKS","title":"Set-PSConfigFileExecution"},{"location":"Set-PSConfigFileExecution/#set-psconfigfileexecution","text":"","title":"Set-PSConfigFileExecution"},{"location":"Set-PSConfigFileExecution/#synopsis","text":"Adds functionality to add the execution to your profile or a PowerShell module","title":"SYNOPSIS"},{"location":"Set-PSConfigFileExecution/#syntax","text":"","title":"SYNTAX"},{"location":"Set-PSConfigFileExecution/#profile-default","text":"Set-PSConfigFileExecution -ConfigFile <FileInfo> [-PSProfile <String>] [-ExecuteNow] [-WhatIf] [-Confirm] [<CommonParameters>]","title":"Profile (Default)"},{"location":"Set-PSConfigFileExecution/#module","text":"Set-PSConfigFileExecution -ConfigFile <FileInfo> [-PSModule <String>] [-PathToPSM1File <FileInfo>] [-ExecuteNow] [-WhatIf] [-Confirm] [<CommonParameters>]","title":"Module"},{"location":"Set-PSConfigFileExecution/#description","text":"Adds functionality to add the execution to your profile or a PowerShell module","title":"DESCRIPTION"},{"location":"Set-PSConfigFileExecution/#examples","text":"","title":"EXAMPLES"},{"location":"Set-PSConfigFileExecution/#example-1","text":"Set-PSConfigFileExecution -ConfigFile C:\\Temp\\jdh\\PSCustomConfig.json -PSProfile AddScript -PSModule AddScript -PathToPSM1File C:\\Utils\\LabScripts\\LabScripts.psm1","title":"EXAMPLE 1"},{"location":"Set-PSConfigFileExecution/#parameters","text":"","title":"PARAMETERS"},{"location":"Set-PSConfigFileExecution/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Set-PSConfigFileExecution/#-executenow","text":"Execute the config file, to make sure everything runs as expected. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-ExecuteNow"},{"location":"Set-PSConfigFileExecution/#-pathtopsm1file","text":"Path to the .psm1 file Type: FileInfo Parameter Sets: Module Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-PathToPSM1File"},{"location":"Set-PSConfigFileExecution/#-psmodule","text":"Enable or disable loading of config when a specific module is loaded. Type: String Parameter Sets: Module Aliases: Required: False Position: Named Default value: Ignore Accept pipeline input: False Accept wildcard characters: False","title":"-PSModule"},{"location":"Set-PSConfigFileExecution/#-psprofile","text":"Enable or disable loading of config when your ps profile is loaded. Type: String Parameter Sets: Profile Aliases: Required: False Position: Named Default value: Ignore Accept pipeline input: False Accept wildcard characters: False","title":"-PSProfile"},{"location":"Set-PSConfigFileExecution/#-confirm","text":"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","title":"-Confirm"},{"location":"Set-PSConfigFileExecution/#-whatif","text":"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","title":"-WhatIf"},{"location":"Set-PSConfigFileExecution/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Set-PSConfigFileExecution/#inputs","text":"","title":"INPUTS"},{"location":"Set-PSConfigFileExecution/#outputs","text":"","title":"OUTPUTS"},{"location":"Set-PSConfigFileExecution/#notes","text":"","title":"NOTES"},{"location":"Set-PSConfigFileExecution/#related-links","text":"","title":"RELATED LINKS"},{"location":"Show-PSConfigFile/","text":"Show-PSConfigFile SYNOPSIS Display what's configured in the config file. SYNTAX Show-PSConfigFile [-ConfigFile] <FileInfo> [<CommonParameters>] DESCRIPTION Display what's configured in the config file. But doesn't execute the commands EXAMPLES EXAMPLE 1 Show-PSConfigFile -ConfigFile $PSConfigFile PARAMETERS -ConfigFile Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: True Position: 1 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 NOTES RELATED LINKS","title":"Show-PSConfigFile"},{"location":"Show-PSConfigFile/#show-psconfigfile","text":"","title":"Show-PSConfigFile"},{"location":"Show-PSConfigFile/#synopsis","text":"Display what's configured in the config file.","title":"SYNOPSIS"},{"location":"Show-PSConfigFile/#syntax","text":"Show-PSConfigFile [-ConfigFile] <FileInfo> [<CommonParameters>]","title":"SYNTAX"},{"location":"Show-PSConfigFile/#description","text":"Display what's configured in the config file. But doesn't execute the commands","title":"DESCRIPTION"},{"location":"Show-PSConfigFile/#examples","text":"","title":"EXAMPLES"},{"location":"Show-PSConfigFile/#example-1","text":"Show-PSConfigFile -ConfigFile $PSConfigFile","title":"EXAMPLE 1"},{"location":"Show-PSConfigFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Show-PSConfigFile/#-configfile","text":"Path to the the config file ($PSConfigfile is a default variable created with the config file) Type: FileInfo Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ConfigFile"},{"location":"Show-PSConfigFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Show-PSConfigFile/#inputs","text":"","title":"INPUTS"},{"location":"Show-PSConfigFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Show-PSConfigFile/#notes","text":"","title":"NOTES"},{"location":"Show-PSConfigFile/#related-links","text":"","title":"RELATED LINKS"}]}
|