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

Add an action to "Open in File Explorer" #17189

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

Originally created by @zadjii-msft on GitHub (Apr 8, 2022).

Kinda the opposite of the context menu. Open the CWD in file explorer. Trick here, shell needs to have been configured for path integration.

Maybe there's a way to make the action do nothing if the active Terminal hasn't set one?

Also relevant: #3337, #5916

Other thoughts: What if the user has a path selected? Check if that text is a path, that path exists, and if so, then open that path in explorer maybe?

Originally created by @zadjii-msft on GitHub (Apr 8, 2022). Kinda the opposite of the context menu. Open the CWD in file explorer. Trick here, shell needs to have been configured for path integration. Maybe there's a way to make the action do nothing if the active Terminal hasn't set one? Also relevant: #3337, #5916 Other thoughts: What if the user has a path selected? Check if that text is a path, that path exists, and if so, then open _that_ path in explorer maybe?
claunia commented 2026-01-31 05:34:51 +00:00
Author
Owner
Copy Link

@vefatica commented on GitHub (Apr 8, 2022):

It seems like this ought to be a feature of the shell. START . works in CMD, PowerShell, and TCC. In TCC I can assign it to a keystroke.

shell needs to have been configured for path integration

What does that mean? Does it refer to some mechanism that already exists?

@vefatica commented on GitHub (Apr 8, 2022): It seems like this ought to be a feature of the shell. `START .` works in CMD, PowerShell, and TCC. In TCC I can assign it to a keystroke. > shell needs to have been configured for path integration What does that mean? Does it refer to some mechanism that already exists?
claunia commented 2026-01-31 05:34:51 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Apr 8, 2022):

I mean, theoretically, yea. This is super doable in the shell. I'm more tracking this as a sub-task of the right-click context menu, or as a trigger. We need an action internally to hook up the context menu entry.

What does that mean? Does it refer to some mechanism that already exists

Yea I'm talking about the OSC9;9 shell integration, as described in https://docs.microsoft.com/en-us/windows/terminal/tutorials/new-tab-same-directory

@zadjii-msft commented on GitHub (Apr 8, 2022): I mean, theoretically, yea. This is super doable in the shell. I'm more tracking this as a sub-task of the right-click context menu, or as a trigger. We need an action internally to hook up the context menu entry. > What does that mean? Does it refer to some mechanism that already exists Yea I'm talking about the `OSC9;9` shell integration, as described in https://docs.microsoft.com/en-us/windows/terminal/tutorials/new-tab-same-directory
claunia commented 2026-01-31 05:34:51 +00:00
Author
Owner
Copy Link

@vefatica commented on GitHub (Apr 9, 2022):

Yea I'm talking about the OSC9;9 shell integration

That's pretty neat and works as advertized (along with Ctrl+Shift+d). It's the sort of thing I don't often want to do. Most likely, by the next time I want to duplicate a tab, I'll have forgotten about the keystroke (and this thread).

Are there other benefits that could come from a shell using OSC9;9 to send a string to WT?

Is OSC9;9 documented anywhere other then the tutorial you mentioned? I didn't find it in https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences.

@vefatica commented on GitHub (Apr 9, 2022): > Yea I'm talking about the OSC9;9 shell integration That's pretty neat and works as advertized (along with Ctrl+Shift+d). It's the sort of thing I don't often want to do. Most likely, by the next time I want to duplicate a tab, I'll have forgotten about the keystroke (and this thread). Are there other benefits that could come from a shell using OSC9;9 to send a string to WT? Is OSC9;9 documented anywhere other then the tutorial you mentioned? I didn't find it in https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences.
claunia commented 2026-01-31 05:34:51 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Apr 11, 2022):

Are there other benefits that could come from a shell using OSC9;9 to send a string to WT?

At the moment not really, but who knows what we might do with it in the future. Like, maybe #12863.

OSC9;9 was originally authored by ConEmu so they've got slightly better docs https://conemu.github.io/en/ShellWorkDir.html

@zadjii-msft commented on GitHub (Apr 11, 2022): > Are there other benefits that could come from a shell using OSC9;9 to send a string to WT? At the moment not really, but who knows what we might do with it in the future. Like, maybe #12863. OSC9;9 was originally authored by ConEmu so they've got slightly better docs https://conemu.github.io/en/ShellWorkDir.html
claunia commented 2026-01-31 05:34:52 +00:00
Author
Owner
Copy Link

@vefatica commented on GitHub (Apr 11, 2022):

Like, maybe https://github.com/microsoft/terminal/issues/12863

That I already have in TCC (popup history and dirhistory). New TCCs use GUI windows for this by default and that doesn't work very well with WT because TCC has no clue where the command line interface window IS. So I use the older option to create the popups in the console screen buffer.

I'm aware of another thread that deals with console apps creating windows. I'm in favor of any improvements on that front, in particular, getting such "popup" windows to have a position which is based on the position of WT's tab. As it is, can WT convey such information to conhost and, if so, can a console app get it?

@vefatica commented on GitHub (Apr 11, 2022): > Like, maybe https://github.com/microsoft/terminal/issues/12863 That I already have in TCC (popup history and dirhistory). New TCCs use GUI windows for this by default and that doesn't work very well with WT because TCC has no clue where the command line interface window _IS_. So I use the older option to create the popups in the console screen buffer. I'm aware of another thread that deals with console apps creating windows. I'm in favor of any improvements on that front, in particular, getting such "popup" windows to have a position which is based on the position of WT's tab. As it is, can WT convey such information to conhost and, if so, can a console app get it?
claunia commented 2026-01-31 05:34:52 +00:00
Author
Owner
Copy Link

@bfahrenfort commented on GitHub (Apr 23, 2022):

in particular, getting such "popup" windows to have a position which is based on the position of WT's tab

I'm interested in this as well. We can get the WT position with GetWindowRect (winuser.h) on TerminalPage::_hostingHwnd, then it's just a question of starting the explorer window in a secure way.

Any suggestions? I'm considering CreateProcess from processthreadsapi.h.

Here's what a potential handler in AppActionHandlers could look like (albeit untested), I used the current implementation of #8330 's code for retrieving the CWD:

void TerminalPage::_HandleOpenInFileExplorer(const IInspectable& /* sender */,
                                             const ActionEventArgs& actionArgs)
{
    const auto focusedTab{ _GetFocusedTabImpl() };
    if (focusedTab)
    {
        const auto workingDirectory = focusedTab->GetActiveTerminalControl().WorkingDirectory();
        const auto validWorkingDirectory = !workingDirectory.empty();
        if (validWorkingDirectory && _hostingHwnd.has_value())
        {
            LPRECT lpRect;
            GetWindowRect(TerminalPage::_hostingHwnd.value(), lpRect);

            // Spawn Explorer
        }
    }
}

Quick update: spawning Explorer with ShellExecuteW is trivial. However, obtaining the HWND to call MoveWindow is not. I'm open to suggestions on how to proceed, I really don't want to do the established solution of "wait for new process to idle -> enumerate windows -> get window by pid" because that little stutter (which could be a big stutter on weaker systems) followed by an enumeration drops performance shockingly quickly.

I'm also lost on trying to add my handler to the Command Palette. It's registered as an action in the X-macros and I've been testing it through a Command in defaults-universal.json as well as a tab flyout context menu item which looks quite nifty:
image
However, I do think it needs to be in Command Palette for ease of use. Could someone please point me in the right direction? Thanks!

@bfahrenfort commented on GitHub (Apr 23, 2022): >in particular, getting such "popup" windows to have a position which is based on the position of WT's tab I'm interested in this as well. We can get the WT position with `GetWindowRect` (`winuser.h`) on `TerminalPage::_hostingHwnd`, then it's just a question of starting the explorer window in a secure way. Any suggestions? I'm considering `CreateProcess` from `processthreadsapi.h`. Here's what a potential handler in `AppActionHandlers` could look like (albeit untested), I used the current implementation of #8330 's code for retrieving the CWD: ```c++ void TerminalPage::_HandleOpenInFileExplorer(const IInspectable& /* sender */, const ActionEventArgs& actionArgs) { const auto focusedTab{ _GetFocusedTabImpl() }; if (focusedTab) { const auto workingDirectory = focusedTab->GetActiveTerminalControl().WorkingDirectory(); const auto validWorkingDirectory = !workingDirectory.empty(); if (validWorkingDirectory && _hostingHwnd.has_value()) { LPRECT lpRect; GetWindowRect(TerminalPage::_hostingHwnd.value(), lpRect); // Spawn Explorer } } } ``` Quick update: spawning Explorer with `ShellExecuteW` is trivial. However, obtaining the `HWND` to call `MoveWindow` is not. I'm open to suggestions on how to proceed, I really don't want to do the established solution of "wait for new process to idle -> enumerate windows -> get window by pid" because that little stutter (which could be a big stutter on weaker systems) followed by an enumeration drops performance shockingly quickly. I'm also lost on trying to add my handler to the Command Palette. It's registered as an action in the X-macros and I've been testing it through a Command in `defaults-universal.json` as well as a tab flyout context menu item which looks quite nifty: ![image](https://user-images.githubusercontent.com/59982409/164954539-9df8b130-b159-4214-9168-257c8f642ec4.png) However, I do think it needs to be in Command Palette for ease of use. Could someone please point me in the right direction? Thanks!
claunia commented 2026-01-31 05:34:52 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Apr 26, 2022):

However, obtaining the HWND to call MoveWindow is not

Wait hold up why do we need to do that at all? I think it's perfectly fine to just ShellExecute({the path}) and let explorer just do it's thing. At least for a first version of the feature, yea?

a Command in defaults-universal.json

Whoops, we should probably just delete that file - it's not actually used anymore 😅 defaults.json is the file you're looking for, that one should have many, MANY more actions.

@zadjii-msft commented on GitHub (Apr 26, 2022): > However, obtaining the `HWND` to call `MoveWindow` is not Wait hold up why do we need to do that at all? I think it's perfectly fine to just `ShellExecute({the path})` and let explorer just do it's thing. At least for a first version of the feature, yea? > a Command in `defaults-universal.json` Whoops, we should probably just delete that file - it's not actually used anymore 😅 `defaults.json` is the file you're looking for, that one should have many, MANY more actions.
claunia commented 2026-01-31 05:34:52 +00:00
Author
Owner
Copy Link

@bfahrenfort commented on GitHub (Apr 27, 2022):

we should probably just delete that file - it's not actually used anymore 😅 defaults.json is the file you're looking for

Hmm. I definitely put it in defaults.json as well. Here's what I used:

{ "command": "openInFileExplorer", "keys": "ctrl+shift+alt+e" },

The keyboard shortcut works, but it still doesn't show up in command palette. Do I have to add it to another place?

Side note, someone should really make a tutorial for registering an action to command palette. I'll open an issue for it when I finish figuring this one out. Thanks!

@bfahrenfort commented on GitHub (Apr 27, 2022): >we should probably just delete that file - it's not actually used anymore 😅 `defaults.json` is the file you're looking for Hmm. I definitely put it in `defaults.json` as well. Here's what I used: `{ "command": "openInFileExplorer", "keys": "ctrl+shift+alt+e" },` The keyboard shortcut works, but it still doesn't show up in command palette. Do I have to add it to another place? Side note, someone should really make a tutorial for registering an action to command palette. I'll open an issue for it when I finish figuring this one out. Thanks!
claunia commented 2026-01-31 05:34:53 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Apr 27, 2022):

Do I have to add it to another place?

Ah, probably. There's a pile of places you need to add this stuff, though, fewer than there used to be. I bet you're missing an entry in ActionAndArgs::GenerateName. That's what generates the names for actions in the command palette.

Side note, someone should really make a tutorial for registering an action to command palette

You know, there actually is a guide, but it's pretty out of date: https://github.com/microsoft/terminal/blob/main/doc/cascadia/AddASetting.md#adding-an-action. We've since added some x-macros to the project that take care of a LOT of the boilerplate, but clearly not all of it.

I might have you also refer to #12097 - looks like that was the most recent merged PR to add an action. That one also needed action args, which I don't think we need in this case, so that should simplify things a bit.

@zadjii-msft commented on GitHub (Apr 27, 2022): > Do I have to add it to another place? Ah, probably. There's a pile of places you need to add this stuff, though, fewer than there used to be. I bet you're missing an entry in [`ActionAndArgs::GenerateName`](https://github.com/microsoft/terminal/blob/main/src/cascadia/TerminalSettingsModel/ActionAndArgs.cpp#L317). That's what generates the names for actions in the command palette. > Side note, someone should really make a tutorial for registering an action to command palette You know, there actually is a guide, but it's pretty out of date: https://github.com/microsoft/terminal/blob/main/doc/cascadia/AddASetting.md#adding-an-action. We've since added some x-macros to the project that take care of a LOT of the boilerplate, but clearly not all of it. I might have you also refer to #12097 - looks like that was the most recent merged PR to add an action. That one also needed action args, which I don't think we need in this case, so that should simplify things a bit.
claunia commented 2026-01-31 05:34:53 +00:00
Author
Owner
Copy Link

@Lee-Carre commented on GitHub (Aug 25, 2023):

If I'm understanding the OP correctly, then the following command will open a file manager at the current CLI working directory:

explorer .

that is; launch explorer with the first argument matching (expanded to) the current path (. = current directory, compare .. = parent directory).

Been using this for years (decades?), to great effect.

I'm not sure what the equivalent for PowerShell syntax is.

@Lee-Carre commented on GitHub (Aug 25, 2023): If I'm understanding the OP correctly, then the following command will open a file manager at the current CLI working directory: explorer . that is; launch `explorer` with the first argument matching (expanded to) the current path (`.` = current directory, compare `..` = parent directory). Been using this for years (decades?), to great effect. I'm not sure what the equivalent for PowerShell syntax is.
claunia commented 2026-01-31 05:34:53 +00:00
Author
Owner
Copy Link

@i-zanis commented on GitHub (Oct 22, 2023):

There's an actual shortcut which is ii (invoke-item).

@i-zanis commented on GitHub (Oct 22, 2023): There's an actual shortcut which is ii (invoke-item).
claunia commented 2026-01-31 05:34:54 +00:00
Author
Owner
Copy Link

@KieranDevvs commented on GitHub (Aug 16, 2024):

What about instead of having a hidden away menu button, we detect file paths and turning them into hyperlinks?
image
image
image

It would then also work with not just the current working directory, but any path from any output.
Lets say you run a compiler and it spits out a log containing multiple paths, it would be handy to be able to ctrl+click on them to go right to the URI:

Microsoft Windows [Version 10.0.19045.4717]
(c) Microsoft Corporation. All rights reserved.

C:\Users\Kieran Devlin> compiler.exe run
Compiling 28 source files...
Binary generated in C:\Users\Kieran Devlin\sources\app1\dist\bin\my-bin.exe
Full output log: C:\Users\Kieran Devlin\sources\app1\logs\compiler\2024-08-16 12-01-56.txt
@KieranDevvs commented on GitHub (Aug 16, 2024): What about instead of having a hidden away menu button, we detect file paths and turning them into hyperlinks? ![image](https://github.com/user-attachments/assets/d3540c12-af7d-4b9a-9a11-5c83ecc40972) ![image](https://github.com/user-attachments/assets/04b02770-80d7-4fcf-9f67-f04f3e006edb) ![image](https://github.com/user-attachments/assets/ef7e8519-b4a9-4bab-967a-51912116b466) It would then also work with not just the current working directory, but any path from any output. Lets say you run a compiler and it spits out a log containing multiple paths, it would be handy to be able to ctrl+click on them to go right to the URI: ``` Microsoft Windows [Version 10.0.19045.4717] (c) Microsoft Corporation. All rights reserved. C:\Users\Kieran Devlin> compiler.exe run Compiling 28 source files... Binary generated in C:\Users\Kieran Devlin\sources\app1\dist\bin\my-bin.exe Full output log: C:\Users\Kieran Devlin\sources\app1\logs\compiler\2024-08-16 12-01-56.txt ```
claunia commented 2026-01-31 05:34:54 +00:00
Author
Owner
Copy Link

@michaeljsXu commented on GitHub (Oct 8, 2024):

I made a commit 07ab3d945e to add this as an action, but I don't see it in the command palette. It works when I attach it to the right click fly out menu though. What am I missing?

@michaeljsXu commented on GitHub (Oct 8, 2024): I made a commit 07ab3d945e4576f8b5c8289eff356298b1a4164b to add this as an action, but I don't see it in the command palette. It works when I attach it to the right click fly out menu though. What am I missing?
claunia commented 2026-01-31 05:34:54 +00:00
Author
Owner
Copy Link

@lhecker commented on GitHub (Oct 8, 2024):

I believe it could be because you're missing an "id" in the defaults.json. DecreaseFontSize for instance doesn't really have anything else on top of your changes.

@lhecker commented on GitHub (Oct 8, 2024): I believe it could be because you're missing an `"id"` in the `defaults.json`. `DecreaseFontSize` for instance doesn't really have anything else on top of your changes.
claunia commented 2026-01-31 05:34:55 +00:00
Author
Owner
Copy Link

@michaeljsXu commented on GitHub (Oct 8, 2024):

Thank you that fixed the problem. I made a PR.

I saw in https://github.com/microsoft/terminal/pull/13526 that the team believes actions related to CWD don't have too much value at the moment since most people don't path integration set up. Is there value in working on an action to open a highlighted directory instead?

@michaeljsXu commented on GitHub (Oct 8, 2024): Thank you that fixed the problem. I made a PR. I saw in https://github.com/microsoft/terminal/pull/13526 that the team believes actions related to CWD don't have too much value at the moment since most people don't path integration set up. Is there value in working on an action to open a highlighted directory instead?
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-Settings good first issue Help Wanted In-PR Issue-Task Needs-Tag-Fix Product-Terminal
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#17189
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?