PowerShell/docs/update-powershell-profile.md
2024-08-15 09:51:46 +02:00

84 lines
2.5 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Script: *update-powershell-profile.ps1*
========================
This PowerShell script write/overwrites the PowerShell profile of the current user.
Parameters
----------
```powershell
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
-------
```powershell
PS> ./update-powershell-profile.ps1
(1/2) Querying path to PowerShell profile 'CurrentUserCurrentHost'...
(2/2) Copying my-profile.ps1 to /home/Markus/.config/powershell/Microsoft.PowerShell_profile.ps1...
PowerShell profile updated - it get's active on next login.
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Updates the user's PowerShell profile
.DESCRIPTION
This PowerShell script write/overwrites the PowerShell profile of 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) Querying path to PowerShell profile 'CurrentUserCurrentHost'...
⏳ (2/2) Copying my-profile.ps1 to /home/Markus/.config/powershell/Microsoft.PowerShell_profile.ps1...
✔️ PowerShell profile 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) Querying path to PowerShell profile 'CurrentUserCurrentHost'..."
$pathToProfile = $PROFILE.CurrentUserCurrentHost
$filename = (Get-Item "$path").Name
"⏳ (2/2) Copying $filename to $pathToProfile..."
$null = New-Item -Path $pathToProfile -ItemType "file" -Force
Copy-Item "$path" "$pathToProfile" -force
"✔️ PowerShell profile 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 08/15/2024 09:50:55)*