PowerShell/Docs/set-profile.md

62 lines
1.5 KiB
Markdown
Raw Normal View History

2022-11-18 17:02:20 +01:00
## The *set-profile.ps1* PowerShell Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script sets the PowerShell profile for the current user.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2021-12-09 16:19:09 +01:00
set-profile.ps1 [<CommonParameters>]
2021-11-08 21:36:42 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./set-profile
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Sets the user's PowerShell profile
.DESCRIPTION
This PowerShell script sets the PowerShell profile for the current user.
.EXAMPLE
PS> ./set-profile
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
"⏳ Step 1/3 - Querying path to PowerShell profile 'CurrentUserCurrentHost'..."
$PathToProfile = $PROFILE.CurrentUserCurrentHost
"$PathToProfile"
"⏳ Step 2/3 - Creating the profile (if non-existent)..."
$Null = New-Item -Path $profile -ItemType "file" -Force
"⏳ Step 3/3 - Copying my-profile.ps1..."
$PathToRepo = "$PSScriptRoot/.."
Copy-Item "$PathToRepo/Scripts/my-profile.ps1" "$PathToProfile" -force
"✔️ updated PowerShell profile by my-profile.ps1 - it gets active on next login"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of set-profile.ps1*