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.

Sign up for GitHub

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

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Move PS content out of OneDrive #388

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
828a981
Add initial draft
Apr 3, 2025
9901f90
Fix date
Apr 3, 2025
e9808dc
Reword motivation and specification
Apr 3, 2025
60ee0ab
Edits from first revision
Apr 4, 2025
95798e0
Edits from second revision
Apr 7, 2025
f35150d
Added .md extension
Apr 8, 2025
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
View file
Open in desktop
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\
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sdwheeler Is this directory structure and configurability setup what you mean?

├── Modules (Configurable)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why aren't we allowing the location of the content folder to be changed? I want all my user files in one location, I don't want modules in one place and scripts/profiles in another.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. So only the location of the config file itself is not configurable and all other files is configurable through the config file.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. So only the location of the config file itself is not configurable

Correct. Whether the other locations are configurable is open to discussion. My vision was that we would only allow configuration of the PSContentPath. Everything else would be in that location.

PSContentPath (configurable)
├── Scripts (Not Configurable)
├── Modules (Not Configurable)
├── Help (Not Configurable)
├── profile.ps1 (Not 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
```