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

[PR #18697] Allow users to specify a base settings path, enabling multiple local state and multi-instance scenarios. #31592

New Issue
Open
opened 2026-01-31 09:48:16 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:48:16 +00:00
Owner
Copy Link

Original Pull Request: https://github.com/microsoft/terminal/pull/18697

State: closed
Merged: No

Description of the new feature

Multi local state and settings and multi instance with --localstate command-line argument

Summary

Introduce a new command-line option -L or --localstate to allow users to specify a custom local state directory for Windows Terminal, enabling multiple local states, settings and multi-instance scenarios.

Enhancements:

  • Modify command-line argument parsing to support the new local state option
  • Update environment variable handling to use the new local state path

Proposed technical implementation details

Reviewer Guide

Introducing the ability to run multiple instances of Windows Terminal with separate settings and state by using the --localstate command-line argument. Modify parsing to support the new local state option. The changes modify the settings path retrieval logic and window class name generation to incorporate the environment variable, allowing for isolated settings for each instance.

This pull request adds support for a new command-line argument -L or --localstate to allow users to specify a custom local state directory for Windows Terminal. The implementation involves modifying command-line argument parsing, updating environment variable handling, and updating file utilities to use the new local state path.

Sequence diagram for handling the new localstate argument

sequenceDiagram
    participant User
    participant Command Line
    participant AppCommandlineArgs
    participant WindowEmperor
    participant FileUtils

    User->>Command Line: wt --localstate <path>
    Command Line->>AppCommandlineArgs: Parse arguments
    AppCommandlineArgs->>AppCommandlineArgs: Store local state path
    AppCommandlineArgs->>WindowEmperor: Launch Terminal
    WindowEmperor->>WindowEmperor: Handle Commandline Args
    WindowEmperor->>AppCommandlineArgs: Get Local State
    WindowEmperor->>FileUtils: Set ENV_WT_BASE_SETTINGS_PATH to local state path
    FileUtils->>FileUtils: Create directories at local state path

Updated class diagram for AppCommandlineArgs

classDiagram
  class AppCommandlineArgs {
    -std::wregex _commandDelimiterRegex
    -std::vector<std::wstring> _args
    -bool _hasParseError
    -bool _shouldExitEarly
    -bool _isHandoffListener
    -int _loadPersistedLayoutIdx
    -std::string _windowTarget
    -std::string _localState
    +FullResetState()
    +GetTargetWindow() string_view
    +GetLocalState() string_view
    -_getNewTerminalArgs(NewTerminalSubcommand& subcommand) NewTerminalArgs
  }

File-Level Changes

Change Details Files
Introduced a new command-line argument -L or --localstate to allow users to specify a custom local state directory for Windows Terminal.
  • Added _localState field to AppCommandlineArgs class to store the local state path.
  • Added -L,--localstate option to the command-line argument parser.
  • Implemented GetLocalState() method in AppCommandlineArgs to retrieve the local state path.
  • Added LocalState() property to the CommandlineArgs class in Remoting.idl and implemented it in Remoting.cpp.
  • Modified WindowEmperor::HandleCommandlineArgs to retrieve the settings path from the command line arguments.
  • Updated FileUtils::GetBaseSettingsPath to retrieve the settings path from the environment variables.
 src/cascadia/WindowsTerminal/WindowEmperor.cpp
src/cascadia/TerminalSettingsModel/FileUtils.cpp
src/cascadia/TerminalApp/AppCommandlineArgs.cpp
src/cascadia/TerminalApp/Remoting.cpp
src/cascadia/TerminalApp/AppCommandlineArgs.h
src/cascadia/TerminalApp/Remoting.h
src/cascadia/CascadiaPackage/Package-Dev.appxmanifest
src/cascadia/TerminalApp/Remoting.idl
src/cascadia/TerminalApp/Resources/en-US/Resources.resw

PR Checklist

Motivation

I created Windows Terminal Layout Manager application. Which is an advanced yet user-friendly application designed to simplify and streamline the management of your Windows Terminal sessions. Effortlessly save, restore, and dynamically manage multiple terminal layouts and settings, ensuring a smooth and consistent workflow.
WTLayoutManager

Image

Image

**Original Pull Request:** https://github.com/microsoft/terminal/pull/18697 **State:** closed **Merged:** No --- ### Description of the new feature Multi local state and settings and multi instance with `--localstate` command-line argument ## Summary Introduce a new command-line option `-L` or `--localstate` to allow users to specify a custom local state directory for Windows Terminal, enabling multiple local states, settings and multi-instance scenarios. Enhancements: - Modify command-line argument parsing to support the new local state option - Update environment variable handling to use the new local state path ### Proposed technical implementation details ## Reviewer Guide Introducing the ability to run multiple instances of Windows Terminal with separate settings and state by using the `--localstate` command-line argument. Modify parsing to support the new local state option. The changes modify the settings path retrieval logic and window class name generation to incorporate the environment variable, allowing for isolated settings for each instance. This pull request adds support for a new command-line argument `-L` or `--localstate` to allow users to specify a custom local state directory for Windows Terminal. The implementation involves modifying command-line argument parsing, updating environment variable handling, and updating file utilities to use the new local state path. #### Sequence diagram for handling the new localstate argument ```mermaid sequenceDiagram participant User participant Command Line participant AppCommandlineArgs participant WindowEmperor participant FileUtils User->>Command Line: wt --localstate <path> Command Line->>AppCommandlineArgs: Parse arguments AppCommandlineArgs->>AppCommandlineArgs: Store local state path AppCommandlineArgs->>WindowEmperor: Launch Terminal WindowEmperor->>WindowEmperor: Handle Commandline Args WindowEmperor->>AppCommandlineArgs: Get Local State WindowEmperor->>FileUtils: Set ENV_WT_BASE_SETTINGS_PATH to local state path FileUtils->>FileUtils: Create directories at local state path ``` #### Updated class diagram for AppCommandlineArgs ```mermaid classDiagram class AppCommandlineArgs { -std::wregex _commandDelimiterRegex -std::vector<std::wstring> _args -bool _hasParseError -bool _shouldExitEarly -bool _isHandoffListener -int _loadPersistedLayoutIdx -std::string _windowTarget -std::string _localState +FullResetState() +GetTargetWindow() string_view +GetLocalState() string_view -_getNewTerminalArgs(NewTerminalSubcommand& subcommand) NewTerminalArgs } ``` ### File-Level Changes | Change | Details | Files | | ------ | ------- | ----- | | Introduced a new command-line argument `-L` or `--localstate` to allow users to specify a custom local state directory for Windows Terminal. | <ul><li>Added `_localState` field to `AppCommandlineArgs` class to store the local state path.</li><li>Added `-L,--localstate` option to the command-line argument parser.</li><li>Implemented `GetLocalState()` method in `AppCommandlineArgs` to retrieve the local state path.</li><li>Added `LocalState()` property to the `CommandlineArgs` class in `Remoting.idl` and implemented it in `Remoting.cpp`.</li><li>Modified `WindowEmperor::HandleCommandlineArgs` to retrieve the settings path from the command line arguments.</li><li>Updated `FileUtils::GetBaseSettingsPath` to retrieve the settings path from the environment variables.</li></ul> | `src/cascadia/WindowsTerminal/WindowEmperor.cpp`<br/>`src/cascadia/TerminalSettingsModel/FileUtils.cpp`<br/>`src/cascadia/TerminalApp/AppCommandlineArgs.cpp`<br/>`src/cascadia/TerminalApp/Remoting.cpp`<br/>`src/cascadia/TerminalApp/AppCommandlineArgs.h`<br/>`src/cascadia/TerminalApp/Remoting.h`<br/>`src/cascadia/CascadiaPackage/Package-Dev.appxmanifest`<br/>`src/cascadia/TerminalApp/Remoting.idl`<br/>`src/cascadia/TerminalApp/Resources/en-US/Resources.resw` | --- ## PR Checklist - [x] Closes #18696 - [x] New feature ## Motivation I created Windows Terminal Layout Manager application. Which is an advanced yet user-friendly application designed to simplify and streamline the management of your Windows Terminal sessions. Effortlessly save, restore, and dynamically manage multiple terminal layouts and settings, ensuring a smooth and consistent workflow. [WTLayoutManager](https://github.com/dmitrykok/WTLayoutManager) ![Image](https://github.com/user-attachments/assets/944ca59c-75be-4b5e-8df9-af04b4a23ced) ![Image](https://github.com/user-attachments/assets/94b9b7ca-49a8-4dc4-83d8-0d28ce0f775b)
claunia added the pull-request label 2026-01-31 09:48:16 +00:00
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 pull-request
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#31592
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?