-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Frequently Asked Questions (FAQ)
This page serves as a list of some of the more commonly encountered issues while using the Terminal.
In addition to this FAQ, please make sure to refer to the official docs. There you can find more detailed info on features of the Terminal, the available settings and how they work, and various tips and tricks for using the Terminal.
The settings file can be found in the following location:
- Windows Terminal (Stable):
%localappdata%\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\settings.json
- Windows Terminal (Preview):
%localappdata%\Packages\Microsoft.WindowsTerminalPreview_8wekyb3d8bbwe\LocalState\settings.json
Additionally in that directory is the state.json
file, which contains additional state that the Terminal generates at runtime.
This unfortunately happens every release. We're using a ring-based rollout system for the Terminal. We need to be more cautious with the stable build, given how many users it could potentially impact if something were to be wrong with it. For example, our CI absolutely blew up ALL localization in the first 1.12 release. That's not the kind of thing you want to roll out immediately to everyone using the Terminal 😅. If you install the .msixbundle
off our Releases page, then it'll stay linked to the Store version and still auto-update in the future, if you manually want to hop to the next version without waiting for the Store.
Sorry for the inconvenience, and thanks for your enthusiasm for staying on the latest version!
First, make sure you've actually configured your shell to tell the Terminal what the CWD is.
Refer to: Opening a tab or pane in the same directory in Windows Terminal
There is a bug in the application deployment platform on recent versions of Windows that results in the Cascadia Mono font (the default font) being unreadable.
Unfortunately, that means that through no fault of your own, you'll get a dialog that says we can't find Cascadia Mono or Cascadia Code.
KNOWN SOLUTIONS:
- Either reboot or
- choose to "Repair" the Terminal application in the "All apps" list in Settings.
FORTUNATELY, we think we've got a fix for this issue finally nailed down in #12904
Before filing a bug, please check your settings file to see if you have "closeOnExit": "always"
set. It's possible that the Terminal window is closing when the shell application closed immediately, or it's possible that the commandline failed to launch entirely. "closeOnExit": "graceful"
will help debug if that's the case.
Unfortunately no, and we have no plans to make the Terminal available on operating systems below version 1903. There are some important operating system features we depend on. Namely:
- XAML Islands is the technology we use to host our XAML UI in a Win32 process. Without that, we'd be unable to display anything. Since XAML Islands is only complete as of 1903, there's nothing we can do about it.
- 1903 Also added support for side-by-side WinRT component activation, something deep in the COM stack that lets us find our DLLs when they're right next to our EXE.
These are unfortunately features that aren't going to be back-ported to earlier versions of Windows, so we won't be able to bring the Terminal to those versions either.
The answer is actually basically the same as the above. Windows Terminal requires a good number of Windows-specific technologies. We unfortunately won't be supporting it on Mac or anywhere else any time soon. There are some really good terminals on OS X, including iTerm and Hyper, and an uncountable number of good terminals on Linux.
This message is printed by the Terminal whenever the client application closes with a non-zero exit code. Notably, exit
in cmd.exe
will also return the exit code of the command that was previously run. So if you happen to type something like
> foo
'foo' is not recognized as an internal or external command,
operable program or batch file.
> exit
[process exited with code 9009]
You'll see this message, because cmd
returned the 9009
from the original failure to find foo
.
This behavior exists to stop an error message printed out by a program from disappearing instantly when it exits. There is a class of applications for which that is extremely important. This is a behavior that's highly conserved across multiple shells and terminal emulators on most mainstream operating systems. We're following this behavior because it is the right behavior to follow, and because you can turn it off with a config option very easily!
If you'd rather it just exit every time, you can set "closeOnExit": "always"
. For more information, please check out the docs for this setting. In the Settings UI, this setting can be found here:
See also: #4223 (comment).
This is something that can happen intermittently whenever the Terminal is updated. Something in the upgrade process causes the execution alias to stop working correctly. You might get an error message like:
Windows cannot find 'C:\Users\username\AppData\Local\Microsoft\WindowsApps\wt.exe'. Make sure you've typed the name correctly, then try again.
Most of the time, you can resolve this by toggling the App Execution Alias for WT off then on the screen at https://stackoverflow.com/a/66539884/1743
If you try typing wt
at the explorer address bar, you'll notice that the Terminal doesn't open at that path, it instead uses your startingDirectory
. This is unlike cmd
or pwsh
, which will inherit the current path of explorer correctly. Unfortunately, this is a complicated situation - there's no good way to determine that the Terminal was launched in this way. There are more details in this comment. Fortunately, there is an easy workaround. Simply type
wt -d .
instead. That -d .
will tell the Terminal to use explorer's CWD as the startingDirectory
instead!
This can happen often if you're running the Terminal from a user profile that is not an administrator, AND the Terminal isn't installed for your Admin account on this machine. You might see an error message like:
This happens because packaged applications need to be installed for the Admin account to be able to be run elevated. To fix this: install the Terminal for your Admin account as well. There are more details in #7806. We're working with the platform team to try and fix this issue, and get the fix brought to downlevel Windows versions. We'll update this if this issue is resolved.
Yes you can! It just requires a second right click. Right click on the taskbar entry, then right click on the app name (Windows Terminal), to reveal the "run as administrator" option.
If you have a window that looks like:
The Terminal launched into "Focus Mode". Focus mode is a special mode where the tabs and caption button are removed, for less visual noise. We very rarely get
- To temporarily turn focus mode off (or on!), press Ctrl+Shift+P or choose "Command Palette" from the menu and then search for "focus".
- Ctrl+, should open the settings UI, where you can change "Launch Mode".
- You can edit the
settings.json
file manually to remove"launchMode":"focus"
.
Every couple of weeks (time permitting), one of our team members merges the changes from this repository's main
branch into an internal mirror's inbox
branch. Once that happens, another tool called git2git
migrates the tree from that internal mirror into a directory on our team's branch in the Windows OS git repository. Some weeks later, that branch's content has made its way to main
, which is approximately where Insider builds come from. The time it takes to get from our team's branch to the Windows main
branch is dependent on many factors, so it can range from 2-6 weeks.
Currently, this is by design. You can set the Preview version of the Windows Terminal as the Default Terminal, but not the Stable version. We're currently working through a few more bugs that we'd like to get sorted before allowing the Stable version to be set as the Default Terminal on Windows.
Windows 11 is shipping a new OS feature we're calling "defterm" - the ability to set the default terminal application for console launches in Windows. This was originally tracked in #492, #5000. This feature initially shipped in Terminal Preview version v1.9.1445.0
.
As of writing, this feature is still only available in "Preview" versions of the Terminal, and Stable versions 1.11+. There are two different versions of the Terminal available:
- Windows Terminal Preview (which we refer to as "preview").
- Windows Terminal (which we call "stable" or "release")
Stable is usually one minor version behind the Preview version, +/- a couple features. If you're wondering why the Terminal doesn't appear in the dropdown, then this is why.
If you only have "Windows Terminal" (stable) installed, you will not see the Terminal in the Settings app for the Default Terminal setting.
Launching the Windows Terminal as the Default Terminal doesn't work - it opens the vintage console window instead!
There could be multiple causes to this:
-
Launching elevated commandline applications won't open in the Terminal. Unfortunately, this is by design right now. Due to a limitation in the app platform it is impossible for Terminal to be "discovered" as the handler when the application that needs a terminal is running elevated. We're working on this, but this is something that needs OS-side work to resolve.
-
In v1.12.2931.0 Preview and v1.11.2921.0 Stable or below, you'll need to have the VC Redistributable installed.
This is often installed alongside other applications as a dependency, but on fresh Windows installs, it might not be present yet.
-
If you're still running into issues, then please file a new issue! We're probably going to ask you to follow these steps.
As of writing this, the default terminal feature is only available in Windows 11. Even if you install a 1.12+ build on Windows 10, the setting won't be available.
Nope. That feature is going to remain a Windows 11-only feature. It's powered by a fairly large feature change to the OS, which is unlikely to be serviced as a "bugfix" to earlier OS versions.
As a system-wide policy, acrylic is only enabled for the foreground window. So if you activate any other window than the Terminal, the Terminal's acrylic will turn off.
There are other system policies that control when acrylic is or isn't enabled. For example, if your laptop is in power saver mode, or you're accessing your machine through RDP, then acrylic will be disabled. Before filing a bug, make sure that acrylic works in other apps, like Calculator, or the Start Menu. Furthermore, if the Windows OS setting "Transparency effects" is not turned on (Windows Settings -> Customize -> Colors -> Transparency effects), then acrylic will not take effect.
We're currently using #7158 to track adding support for "enable acrylic even for inactive Terminal windows" - if you're passionate about this, we'd love your contribution!
Yes! As of Terminal v1.12.2922.0, this feature is supported on Windows 11.
SoonTM. We're working with the servicing folks to make this happen. The API we're using to achieve unblurred transparency is actually broken on Windows 10, so we need to get the fix for that serviced down to Windows 10.
Please make sure to check out #8888, which is tracking all the quake-mode and globalSummon
related issues.
"Global Summon" refers to the globalSummon
action. This action allows you to bind a shortcut systemwide to activate the Terminal window. This means that you can bind something like win+`, and press that anywhere in the OS to instantly activate the Terminal window. globalSummon
supports a ton of different parameters to control its behavior, so please make sure to check out the docs.
"Quake Mode" is a specific version of globalSummon
. It summons a window that's named _quake
, and the window named _quake
has certain special properties. Check out the docs for more details.
That's correct - the Terminal needs to be running to be able to register the global hotkeys. You can configure the Terminal to launch on machine startup with "startOnUserLogin": true
. We're also using #9996 to track "Allow the Terminal to start up and process global hotkeys without creating a window".
Right now, you can't. The window named _quake
will always open on the top half of the monitor.
What you can do, though, is rebind win+` to a different globalSummon
action. The following will be equivalent to the quakeMode
action, but without the requirement that the window's name is _quake
:
{ "keys": "win+`", "command": { "action": "globalSummon", "dropdownDuration": 200, "toggleVisibility": true, "monitor": "toCursor", "desktop": "toCurrent" } }
Then, your window will still obey your standard initalPosition
, initialRows
, etc. settings.
Additionally, #9992 is the issue we're tracking for "Allow configuring global settings per-window name". That means you'll be able to use that to change the settings for the window named _quake
.
The _quake
window always opens in "focus mode" by default. That doesn't mean that the quake window doesn't have tabs, just that they're hidden. You can use the Command Palette to disable focus mode if you want to see the tabs again.
If you don't want the global hotkey to summon the window in quake mode, there are two options:
- Either re-bind it to a different
globalSummon
action, like the above, without"name": "_quake"
. - Wait patiently for #9992 to allow changing the settings of the
_quake
window name.
This is another scenario that'll have to wait for #9992. What you'd end up with is different window names for each profile you want a specific hotkey for. The defaultProfile
for those windows would be set to whatever profile you want. Then, you'd bind globalSummon
actions, with the name
set to each of those window names.
This is a feature that's commonly associated with Quake Mode. Unfortunately, it didn't quite make the cut for 1.9. Never fear! We're working on it currently. Please follow #5727 for updates on adding this functionality to the Terminal.
This is a small list of FAQ-like questions that have had lengthy replies in the past. They're all preserved in the doc niksa.md
- Why do we avoid changing CMD.exe?
- Why is typing-to-screen performance better than every other app?
- How are the Windows graphics/messaging stack assembled?
- Output Processing between "Far East" and "Western"
- Why do we not backport things?
- Why can't we have mixed elevated and non-elevated tabs in the Terminal?
- What's the difference between a shell and a terminal?;
- Why do we feel like using an env var to identify the Terminal is a bad idea?
- https://github.com/microsoft/terminal/issues/7434#issuecomment-1211335449
- Consider launching CMD.exe with the Terminal set as the "default terminal emulator" - CMD is started first, then WT is started, and the two are connected by the OS. CMD is started before the Terminal is, so there's never any chance for the Terminal to set something like
WT_SESSION
,TERM
,TERM_PROGRAM
,COLORTERM
, etc, inside of cmd.exe's process space.