PowerShell/docs/update-powershell-profile.md

Script: update-powershell-profile.ps1

This PowerShell script write/overwrites the PowerShell profile for the current user.

Parameters

PS> ./update-powershell-profile.ps1 [[-path] <String>] [<CommonParameters>]

-path <String>
    Specifies the path to the new profile ($PSScriptRoot/my-profile.ps1 by default)
    
    Required?                    false
    Position?                    1
    Default value                "$PSScriptRoot/my-profile.ps1"
    Accept pipeline input?       false
    Accept wildcard characters?  false

[<CommonParameters>]
    This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, 
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.

Example

PS> ./update-powershell-profile.ps1
⏳ (1/2) Query location of PowerShell profile 'CurrentUserCurrentHost'...
⏳ (2/2) Copy my-profile.ps1 to C:\Users\Markus\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1...
✔️ Your PowerShell profile is updated - it get's active on next login.

Notes

Author: Markus Fleschutz | License: CC0

Related Links

https://github.com/fleschutz/PowerShell

Script Content

<#
.SYNOPSIS
	Updates the PowerShell profile
.DESCRIPTION
	This PowerShell script write/overwrites the PowerShell profile for the current user.
.PARAMETER path
	Specifies the path to the new profile ($PSScriptRoot/my-profile.ps1 by default)
.EXAMPLE
	PS> ./update-powershell-profile.ps1
	⏳ (1/2) Query location of PowerShell profile 'CurrentUserCurrentHost'...
	⏳ (2/2) Copy my-profile.ps1 to C:\Users\Markus\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1...
	✔️ Your PowerShell profile is updated - it get's active on next login.
.LINK
	https://github.com/fleschutz/PowerShell
.NOTES
	Author: Markus Fleschutz | License: CC0
#>

param([string]$path = "$PSScriptRoot/my-profile.ps1")

try {
	"⏳ (1/2) Query location of PowerShell profile 'CurrentUserCurrentHost'..."
	$pathToProfile = $PROFILE.CurrentUserCurrentHost

	$filename = (Get-Item "$path").Name
	"⏳ (2/2) Copy $filename to $pathToProfile..."
	$null = New-Item -Path $pathToProfile -ItemType "file" -Force
	Copy-Item "$path" "$pathToProfile" -force

	"✔️ Your PowerShell profile is updated - it get's active on next login."
	exit 0 # success
} catch {
	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
	exit 1
}

(generated by convert-ps2md.ps1 using the comment-based help of update-powershell-profile.ps1 as of 05/19/2024 10:25:27)