Skip to content

Move PS content out of OneDrive #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions Draft-Accepted/RFC0066-PowerShell-User-Content-Location
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ This RFC proposes moving the current PowerShell user content location out of One
- Changing the default location would align PowerShell with other developer tools and improve usability.

As a user,
I can customize the location of where PowerShell user content is installed,
so that I can choose to sync with OneDrive.
I can customize the location where PowerShell user content is installed,
so that I can avoid problems created by file sunc solutions like OneDrive.

## User Experience

Expand All @@ -32,9 +32,10 @@ This RFC proposes moving the current PowerShell user content location out of One

## Specification

- This change will only apply to PowerShell on Windows.
- The content folder location change will only apply to PowerShell on Windows.
- Configurability of the content folder will apply to all systems.
- This will be an experimental feature.
- The PowerShell user content folder will be located in the AppData.
- The PowerShell user content folder will be located in the `$env:LOCALAPPDATA\Microsoft\PowerShell`.
- A configuration file in the PowerShell user content folder will determine the location of the user scoped PSModulePath.
- The user will be responsible for specifying thier desired install location using PSResourceGet.
- The location of Modules is configurable
Expand All @@ -43,24 +44,29 @@ This RFC proposes moving the current PowerShell user content location out of One

C:\Users\UserName\AppData\Local\PowerShell\
├── Modules (Configurable)
├── Scripts (Not Configurable)
├── Profiles (Not Configurable)
├── Scripts (Configurable)
├── profile.ps1 (Configurable)
└── PSModulePathConfig.json (Not Configurable)

- The configuration file:

{
"PSModulePath" : "C:\\Users\\chungjustin\\PowerShell"
}
```json
{
"UserPSContentPath" : "C:\\Users\\User\\PowerShell"
}
```

## Alternate Proposals and Considerations

- The following functionalities will be affected:
- Secret Management.
- SecretManagement
- SecretManagement extension vaults are registered for the current user context in:
`$env:LOCALAPPDATA\Microsoft\PowerShell\secretmanagement\secretvaultregistry\`
When an extension vault is registered, SecretManagement stores the full path to the extension module in the registry. Moving the PowerShell content to a new location will break the vault registrations.
- Use the following script to relocate the PowerShell contents folder:

```pwsh
$newPath = "C:\Custom\PowerShell\Modules"
$currentUserModulePath = [System.Environment]::GetFolderPath('MyDocuments') + "\PowerShell\Modules"
Move-Item -Path $currentUserModulePath -Destination $newPath -Force
```
```pwsh
$newPath = "C:\Custom\PowerShell\Modules"
$currentUserModulePath = [System.Environment]::GetFolderPath('MyDocuments') + "\PowerShell\Modules"
Move-Item -Path $currentUserModulePath -Destination $newPath -Force
```