PowerShell/docs/update-powershell-profile.md

84 lines
2.5 KiB
Markdown
Raw Normal View History

2024-11-08 12:38:20 +01:00
The *update-powershell-profile.ps1* Script
===========================
2024-05-19 10:25:56 +02:00
2024-08-15 09:51:46 +02:00
This PowerShell script write/overwrites the PowerShell profile of the current user.
2024-05-19 10:25:56 +02:00
Parameters
----------
```powershell
2024-11-08 12:35:11 +01:00
/home/markus/Repos/PowerShell/scripts/update-powershell-profile.ps1 [[-path] <String>] [<CommonParameters>]
2024-05-19 10:25:56 +02:00
-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
2024-08-15 09:51:46 +02:00
⏳ (1/2) Querying path to PowerShell profile 'CurrentUserCurrentHost'...
⏳ (2/2) Copying my-profile.ps1 to /home/Markus/.config/powershell/Microsoft.PowerShell_profile.ps1...
2024-11-08 12:35:11 +01:00
✅ Updated your PowerShell profile, it get's active on next login.
2024-05-19 10:25:56 +02:00
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
2024-08-15 09:51:46 +02:00
Updates the user's PowerShell profile
2024-05-19 10:25:56 +02:00
.DESCRIPTION
2024-08-15 09:51:46 +02:00
This PowerShell script write/overwrites the PowerShell profile of the current user.
2024-05-19 10:25:56 +02:00
.PARAMETER path
Specifies the path to the new profile ($PSScriptRoot/my-profile.ps1 by default)
.EXAMPLE
PS> ./update-powershell-profile.ps1
2024-08-15 09:51:46 +02:00
⏳ (1/2) Querying path to PowerShell profile 'CurrentUserCurrentHost'...
⏳ (2/2) Copying my-profile.ps1 to /home/Markus/.config/powershell/Microsoft.PowerShell_profile.ps1...
2024-11-08 12:35:11 +01:00
✅ Updated your PowerShell profile, it get's active on next login.
2024-05-19 10:25:56 +02:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$path = "$PSScriptRoot/my-profile.ps1")
try {
2024-08-15 09:51:46 +02:00
"⏳ (1/2) Querying path to PowerShell profile 'CurrentUserCurrentHost'..."
2024-05-19 10:25:56 +02:00
$pathToProfile = $PROFILE.CurrentUserCurrentHost
$filename = (Get-Item "$path").Name
2024-08-15 09:51:46 +02:00
"⏳ (2/2) Copying $filename to $pathToProfile..."
2024-05-19 10:25:56 +02:00
$null = New-Item -Path $pathToProfile -ItemType "file" -Force
Copy-Item "$path" "$pathToProfile" -force
2024-11-08 12:35:11 +01:00
"✅ Updated your PowerShell profile, it get's active on next login."
2024-05-19 10:25:56 +02:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
2024-11-20 11:52:20 +01:00
*(generated by convert-ps2md.ps1 as of 11/20/2024 11:52:01)*