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

Expose the profile GUID to the environment (WT_PROFILE, WT_PROFILE_GUID?) #5019

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

Originally created by @JustinGrote on GitHub (Nov 15, 2019).

Originally assigned to: @oising on GitHub.

Description of the new feature/enhancement

We need a way to detect within a running terminal what profile instantiated it, so that we can make on-the-fly changes to the config (like change the background or font). The MSTerminalSetting is an example of that method.

Proposed technical implementation details (optional)

Provide the steps/api to PInvoke to get the profile guid based on the session guid. OR expose the session's profile guid to an environment variable like WT_PROFILE

Originally created by @JustinGrote on GitHub (Nov 15, 2019). Originally assigned to: @oising on GitHub. <!-- 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 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 We need a way to detect within a running terminal what profile instantiated it, so that we can make on-the-fly changes to the config (like change the background or font). The MSTerminalSetting is an example of that method. <!-- 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). --> # Proposed technical implementation details (optional) Provide the steps/api to PInvoke to get the profile guid based on the session guid. OR expose the session's profile guid to an environment variable like WT_PROFILE <!-- A clear and concise description of what you want to happen. -->
claunia commented 2026-01-31 00:03:06 +00:00
Author
Owner
Copy Link

@Jaykul commented on GitHub (Feb 15, 2020):

I'd settle for setting WT_SESSION to the profile GUID instead of the seemingly pointless session GUID...

@Jaykul commented on GitHub (Feb 15, 2020): I'd settle for setting WT_SESSION to the profile GUID instead of the seemingly pointless session GUID...
claunia commented 2026-01-31 00:03:07 +00:00
Author
Owner
Copy Link

@oising commented on GitHub (Mar 10, 2020):

I'd settle for setting WT_SESSION to the profile GUID instead of the seemingly pointless session GUID...

It's possible to have the profile open in multiple places though, with different "sessions" -- I think this guid is keyed to the conpty connection itself, so it kinda needs to be unique globally.

@oising commented on GitHub (Mar 10, 2020): > I'd settle for setting WT_SESSION to the profile GUID instead of the seemingly pointless session GUID... It's possible to have the profile open in multiple places though, with different "sessions" -- I think this guid is keyed to the conpty connection itself, so it kinda needs to be unique globally.
claunia commented 2026-01-31 00:03:07 +00:00
Author
Owner
Copy Link

@JustinGrote commented on GitHub (Mar 10, 2020):

@oising The main goal would be for a program running inside of windows terminal to be able to "find" what profile it is currently using, so that it can customize the settings.json for that profile in real-time.

As far as I understand there is no API to determine that using the WT_SESSION variable, unless you can enlighten me.

Invoke-TerminalGif as an example (currently I have to do a nasty workaround to make it work):
image

It doesn't have to replace WT_SESSION, it could instead be WT_PROFILE_GUID as mentioned.

@JustinGrote commented on GitHub (Mar 10, 2020): @oising The main goal would be for a program running inside of windows terminal to be able to "find" what profile it is currently using, so that it can customize the settings.json for that profile in real-time. As far as I understand there is no API to determine that using the WT_SESSION variable, unless you can enlighten me. Invoke-TerminalGif as an example (currently I have to do a nasty workaround to make it work): ![image](https://user-images.githubusercontent.com/15258962/76343232-0a567280-62bd-11ea-8bed-4c5c44ac5034.png) It doesn't have to replace WT_SESSION, it could instead be WT_PROFILE_GUID as mentioned.
claunia commented 2026-01-31 00:03:07 +00:00
Author
Owner
Copy Link

@Jaykul commented on GitHub (Mar 10, 2020):

I'd settle for setting WT_SESSION to the profile GUID instead of the seemingly pointless session GUID...

It's possible to have the profile open in multiple places though, with different "sessions" -- I think this guid is keyed to the conpty connection itself, so it kinda needs to be unique globally.

It "needs" to be unique for what? What can we use a session guid for?

@Jaykul commented on GitHub (Mar 10, 2020): > > I'd settle for setting WT_SESSION to the profile GUID instead of the seemingly pointless session GUID... > > It's possible to have the profile open in multiple places though, with different "sessions" -- I think this guid is keyed to the conpty connection itself, so it kinda needs to be unique globally. It "needs" to be unique for what? What can we _use_ a **session** guid _for_?
claunia commented 2026-01-31 00:03:07 +00:00
Author
Owner
Copy Link

@DHowett-MSFT commented on GitHub (Mar 10, 2020):

unique

WT_SESSION is an integral part of #766 and #961 that allows shells to cache and recover state as part of overall session restoration. It's analogous to TERMINAL_SESSION_ID on OS X.

@DHowett-MSFT commented on GitHub (Mar 10, 2020): > unique `WT_SESSION` is an integral part of #766 and #961 that allows shells to cache and recover state as part of overall session restoration. It's analogous to `TERMINAL_SESSION_ID` on OS X.
claunia commented 2026-01-31 00:03:07 +00:00
Author
Owner
Copy Link

@JustinGrote commented on GitHub (Mar 10, 2020):

@oising As the OP of this issue, the proposal you have here https://github.com/microsoft/terminal/pull/4852#issuecomment-597230418 would satisfy my requirement and this can be closed once merged

@JustinGrote commented on GitHub (Mar 10, 2020): @oising As the OP of this issue, the proposal you have here https://github.com/microsoft/terminal/pull/4852#issuecomment-597230418 would satisfy my requirement and this can be closed once merged
claunia commented 2026-01-31 00:03:07 +00:00
Author
Owner
Copy Link

@oising commented on GitHub (Mar 10, 2020):

@JustinGrote It's in the PR now as WT_PROFILE_ID and is in review. Will close when merged.

@oising commented on GitHub (Mar 10, 2020): @JustinGrote It's in the PR now as `WT_PROFILE_ID` and is in review. Will close when merged.
claunia commented 2026-01-31 00:03:08 +00:00
Author
Owner
Copy Link

@Jaykul commented on GitHub (Apr 12, 2020):

But we won't get it until some time after 1.0 - so the idea of using it in a script is basically DOA for months.

@Jaykul commented on GitHub (Apr 12, 2020): But we won't get it until some time _after_ 1.0 - so the idea of using it in a script is basically DOA for months.
claunia commented 2026-01-31 00:03:08 +00:00
Author
Owner
Copy Link

@oising commented on GitHub (Apr 12, 2020):

But we won't get it until some time after 1.0 - so the idea of using it in a script is basically DOA for months.

I tried :/

@oising commented on GitHub (Apr 12, 2020): > But we won't get it until some time _after_ 1.0 - so the idea of using it in a script is basically DOA for months. I tried :/
claunia commented 2026-01-31 00:03:08 +00:00
Author
Owner
Copy Link

@oising commented on GitHub (Apr 17, 2020):

It got merged after all - just had to remove the file path env vars for the moment :) /cc @Jaykul

@oising commented on GitHub (Apr 17, 2020): It got merged after all - just had to remove the file path env vars for the moment :) /cc @Jaykul
claunia commented 2026-01-31 00:03:08 +00:00
Author
Owner
Copy Link

@Jaykul commented on GitHub (Apr 18, 2020):

Thanks @oising!

@Jaykul commented on GitHub (Apr 18, 2020): Thanks @oising!
claunia commented 2026-01-31 00:03:08 +00:00
Author
Owner
Copy Link

@ghost commented on GitHub (Apr 22, 2020):

:tada:This issue was addressed in #4852, which has now been successfully released as Windows Terminal Preview v0.11.1121.0.🎉

Handy links:

@ghost commented on GitHub (Apr 22, 2020): :tada:This issue was addressed in #4852, which has now been successfully released as `Windows Terminal Preview v0.11.1121.0`.:tada: Handy links: * [Release Notes](https://github.com/microsoft/terminal/releases/tag/v0.11.1121.0) * [Store Download](https://www.microsoft.com/store/apps/9n0dx20hk701?cid=storebadge&ocid=badge)
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 Area-TerminalConnection Issue-Task Product-Terminal Resolution-Fix-Committed
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#5019
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?