Terminal: Expose the profile GUID to the environment (WT_PROFILE, WT_PROFILE_GUID?)

[JustinGrote]

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

[Jaykul]

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

[oising]

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.

[JustinGrote]

@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):

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

[Jaykul]

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_?

[DHowett-MSFT]

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.

[JustinGrote]

@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

[oising]

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

[Jaykul]

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.

[oising]

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]

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

[Jaykul]

Thanks @oising!

[msftbot[bot]]

: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
• Store Download