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

custom environment variables in settings.json map #17833

New Issue
Closed
opened 2026-01-31 05:55:50 +00:00 by claunia · 4 comments
claunia commented 2026-01-31 05:55:50 +00:00
Owner
Copy Link

Originally created by @WanderLanz on GitHub (Jun 30, 2022).

Description of the new feature/enhancement

Adding a new settings.json mapping for extra environment variables injected by conpty initialization,
allowing for user-set environment variables to be handled directly by WindowsTerminal and passed to children as WT_SESSION and WT_PROFILE_ID are.

As it stands, using SETX to load custom environment variables into every terminal child invites cloberring of vars like WSLENV, since WindowsTerminal manually appends and prepends WT_SESSION and WT_PROIFLE_ID to WSLENV.

...
This stems from #7130 and modules wishing to find the equivalent of "$env:WT_SETTINGS". I could not find a similar request, but I apologize in advance if this is a superfluous suggestion.

Proposed technical implementation details (optional)

Using internal "_environment" in ConptyConnection.cpp as external settings.json map "environment", if possible, since "_environment" seems to already handle injecting arbitrary* environment variables.

Originally created by @WanderLanz on GitHub (Jun 30, 2022). <!-- 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING: 1. If I delete this entire template and go my own path, the core team may close my issue without further explanation or engagement. 2. If I list multiple bugs/concerns in this one issue, the core team may close my issue without further explanation or engagement. 3. If I write an issue that has many duplicates, the core team may close my issue without further explanation or engagement (and without necessarily spending time to find the exact duplicate ID number). 4. If I leave the title incomplete when filing the issue, the core team may close my issue without further explanation or engagement. 5. If I file something completely blank in the body, the core team may close my issue without further explanation or engagement. All good? Then proceed! --> # Description of the new feature/enhancement <!-- A clear and concise description of what the problem is that the new feature would solve. Describe why and how a user would use this new functionality (if applicable). --> Adding a new settings.json mapping for extra environment variables injected by conpty initialization, allowing for user-set environment variables to be handled directly by WindowsTerminal and passed to children as WT_SESSION and WT_PROFILE_ID are. As it stands, using SETX to load custom environment variables into every terminal child invites cloberring of vars like WSLENV, since WindowsTerminal manually appends and prepends WT_SESSION and WT_PROIFLE_ID to WSLENV. ... This stems from #7130 and modules wishing to find the equivalent of "$env:WT_SETTINGS". I could not find a similar request, but I apologize in advance if this is a superfluous suggestion. # Proposed technical implementation details (optional) <!-- A clear and concise description of what you want to happen. --> Using internal "_environment" in ConptyConnection.cpp as external settings.json map "environment", if possible, since "_environment" seems to already handle injecting arbitrary* environment variables.
claunia added the Issue-FeatureNeeds-TriageNeeds-Tag-Fix labels 2026-01-31 05:55:50 +00:00
claunia commented 2026-01-31 05:55:51 +00:00
Author
Owner
Copy Link

@j4james commented on GitHub (Jul 2, 2022):

If I've understood you correctly, I think this may be a duplicate of #2785.

@j4james commented on GitHub (Jul 2, 2022): If I've understood you correctly, I think this may be a duplicate of #2785.
claunia commented 2026-01-31 05:55:51 +00:00
Author
Owner
Copy Link

@WanderLanz commented on GitHub (Jul 3, 2022):

@j4james Yes it would seem I might have done something unnecessary!

My suggestion is specifically referring to global environment variables for every profile rather than profile-by-profile, because the way ConptyConnection.cpp adds both WT_SESSION and WT_PROFILE_ID made it seem like it would be easier.

I feel like I should leave this open for now unless #9287 also implements a global "environment" or the profile-by-profile solution is as far as custom environments directly from settings.json will go.

Feel free to close this if you feel it is a duplicate, this is by no means a first-class priority.

@WanderLanz commented on GitHub (Jul 3, 2022): @j4james Yes it would seem I might have done something unnecessary! My suggestion is specifically referring to global environment variables for every profile rather than profile-by-profile, because the way ConptyConnection.cpp adds both WT_SESSION and WT_PROFILE_ID made it seem like it would be easier. I feel like I should leave this open for now unless #9287 also implements a global "environment" or the profile-by-profile solution is as far as custom environments directly from settings.json will go. Feel free to close this if you feel it is a duplicate, this is by no means a first-class priority.
claunia commented 2026-01-31 05:55:51 +00:00
Author
Owner
Copy Link

@j4james commented on GitHub (Jul 3, 2022):

I haven't looked at PR #9287 in detail, but I think your use-case should be covered by the "Defaults" profile. If you set an environment variable in "Defaults", I assume that would be the equivalent of a "global" environment variable that would apply to all profiles. That's the way other profile settings work.

@j4james commented on GitHub (Jul 3, 2022): I haven't looked at PR #9287 in detail, but I think your use-case should be covered by the "Defaults" profile. If you set an environment variable in "Defaults", I assume that would be the equivalent of a "global" environment variable that would apply to all profiles. That's the way other profile settings work.
claunia commented 2026-01-31 05:55:51 +00:00
Author
Owner
Copy Link

@WanderLanz commented on GitHub (Jul 4, 2022):

@j4james Thank you for the clarification, I'll go ahead and close this.

@WanderLanz commented on GitHub (Jul 4, 2022): @j4james Thank you for the clarification, I'll go ahead and close this.
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-Feature Needs-Tag-Fix Needs-Triage
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#17833
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?