starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

How to safely update Terminal's config file with PSWinTerminal? #9962

New Issue
Closed
opened 2026-01-31 02:08:36 +00:00 by claunia · 3 comments
claunia commented 2026-01-31 02:08:36 +00:00
Owner
Copy Link

Originally created by @sassdawe on GitHub (Aug 1, 2020).

Description of the new feature/enhancement

What is the safest way to update Terminal's config file from a command line running inside the Terminal?

I'd like to avoid colliding with your future feature updates.

Proposed technical implementation details (optional)

I published PSWinTerminal into PowerShell Gallery, which implements Get-WTTheme, Show-WTTheme, and Set-WTTheme.

And I'm planning to implement Import-WTTheme / New-WTTheme to extend the available themes.

How should I approach these cmdlets without risking breaking the configuration? Thanks!

Originally created by @sassdawe on GitHub (Aug 1, 2020). # Description of the new feature/enhancement What is the safest way to update Terminal's config file from a command line running inside the Terminal? **I'd like to avoid colliding with your future feature updates.** # Proposed technical implementation details (optional) I published [PSWinTerminal](https://www.powershellgallery.com/packages/PSWinTerminal/) into PowerShell Gallery, which implements Get-WTTheme, Show-WTTheme, and Set-WTTheme. And I'm planning to implement Import-WTTheme / New-WTTheme to extend the available themes. How should I approach these cmdlets without risking breaking the configuration? Thanks!
claunia added the Issue-QuestionNeeds-Tag-FixResolution-Answered labels 2026-01-31 02:08:36 +00:00
claunia commented 2026-01-31 02:08:37 +00:00
Author
Owner
Copy Link

@sassdawe commented on GitHub (Aug 1, 2020):

You can see my implementation of PSWinTerminal here

I used the available environment variables, and I have some ideas for new variables. Should I open an other issues to cover those?

@sassdawe commented on GitHub (Aug 1, 2020): You can see my implementation of [PSWinTerminal here](https://github.com/sassdawe/PSWinTerminal/blob/main/PSWinTerminal.psm1) I used the available environment variables, and I have some ideas for new variables. Should I open an other issues to cover those?
claunia commented 2026-01-31 02:08:37 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Aug 21, 2020):

@sassdawe Sorry to let this issue languish on our repo for so long. As somebody building on top of Terminal you almost certainly deserve better than that!

So, here's the deal.

Detecting where the settings are

Right now, we're leaving this largely up to chance. The user's settings will be in one of three (or four, if they're a terminal developer) places, and figuring out exactly which one is active is hard. We had a proposal, #4566, that would get us there. We need to have out the discussion in that one on whether we really do think it a good idea.

Editing settings safely

There's another project, MSTerminalSettings, that now uses C# code automatically generated from our settings schema. If it's possible for you to follow our schema in a similar way--I'm not sure what powershell offers in terms of JSON schema support--that would make certain that you're not breaking anything.

Otherwise, it's entirely safe to edit the user's settings and re-save them. It's a minor pain because we're "mostly JSON" with the addition of trailing commas and comments... much to the ire of some of the more steadfast JSON supporters in our community.

future

We're actively working to separate our settings model -- serializers and deserializers and all -- out into a separate component library that can operate independent of Terminal. One of our goals is to make it easier for people to edit our settings through a programmatic interface. You can follow the progress of that one in #885/#7141

@DHowett commented on GitHub (Aug 21, 2020): @sassdawe Sorry to let this issue languish on our repo for so long. As somebody building on top of Terminal you almost certainly deserve better than that! So, here's the deal. ### Detecting where the settings are Right now, we're leaving this largely up to chance. The user's settings will be in one of three (or four, if they're a terminal developer) places, and figuring out exactly which one is active is _hard_. We had a proposal, #4566, that would get us there. We need to have out the discussion in that one on whether we really do think it a good idea. ### Editing settings safely There's another project, MSTerminalSettings, that now uses C# code automatically generated from our [settings schema](https://aka.ms/terminal-profiles-schema). If it's possible for you to follow our schema in a similar way--I'm not sure what powershell offers in terms of JSON schema support--that would make certain that you're not breaking anything. Otherwise, it's **entirely safe** to edit the user's settings and re-save them. It's a minor pain because we're "mostly JSON" with the addition of trailing commas and comments... much to the ire of some of the more steadfast JSON supporters in our community. ### future We're actively working to separate our settings model -- serializers and deserializers and all -- out into a separate component library that can operate independent of Terminal. One of our goals is to make it easier for people to edit our settings through a programmatic interface. You can follow the progress of that one in #885/#7141
claunia commented 2026-01-31 02:08:37 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Aug 21, 2020):

By the way, it's really nice to see folks writing modules that support all the weird stuff we do here. You're very much appreciated 😄

@DHowett commented on GitHub (Aug 21, 2020): By the way, it's really nice to see folks writing modules that support all the weird stuff we do here. You're very much appreciated :smile:
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Issue-Question Needs-Tag-Fix Resolution-Answered
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#9962
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?