| title | description | author | ms.author | ms.date | ms.topic | ms.localizationpriority |
|---|---|---|---|---|---|---|
Windows Terminal Troubleshooting |
Learn fixes to common obstacles in Windows Terminal. |
cinnamon-msft |
cinnamon |
10/08/2021 |
overview |
high |
This guide addresses some of the common errors and obstacles you may encounter when using Windows Terminal.
If you click on the "settings" button in the dropdown, the Terminal will attempt to open the settings file, settings.json. This will cause the OS to try and launch your configured .json file editor. This might be Visual Studio, or Notepad, or some other completely unexpected application. If there isn't a configured .json editor on your machine, then the OS will eventually show you the "How do you want to open this file" dialog.
Tip
You can also use the settings UI to configure your settings if you are using Windows Terminal Preview. You can learn how to open the settings UI on the Actions page.
By default, the startingDirectory of a profile is %USERPROFILE% (C:\Users\<YourUsername>). This is a Windows path. For WSL, however, you may want to use the WSL home path instead. startingDirectory only accepts a Windows-style path, so setting it to start within a WSL distribution requires a prefix.
Beginning in Windows 10 version 1903, the file systems of WSL distributions can be addressed using the \\wsl$\ prefix. For any WSL distribution with the name DistroName, use \\wsl$\DistroName as a Windows path that points to the root of that distribution's file system.
For example, the following setting will launch the "Ubuntu-18.04" distribution in its home file path:
{
"name": "Ubuntu-18.04",
"commandline" : "wsl -d Ubuntu-18.04",
"startingDirectory" : "//wsl$/Ubuntu-18.04/home/<Your Ubuntu Username>"
}Beginning in Windows 10 version 21H1, the file systems of WSL distributions is directly referenced and does not need any prefix. You can use /home/<Your Ubuntu Username> to directly refer your home folder.
For example, the following setting will launch the "Ubuntu-20.04" distribution in its home file path:
{
"name": "Ubuntu-20.04",
"commandline" : "wsl -d Ubuntu-20.04",
"startingDirectory" : "/home/<Your Ubuntu Username>"
}To have the shell automatically set your tab title, visit the set the tab title tutorial. If you want to set your own tab title, open the settings.json file and follow these steps:
-
In the profile for the command line of your choice, add
"suppressApplicationTitle": trueto suppress any title change events that get sent from the shell. Adding only this setting to your profile will set the tab title to the name of your profile. -
If you want a custom tab title that is not the name of your profile, add
"tabTitle": "TITLE". Replacing "TITLE" with your preferred tab title.
Visit the Command line arguments page to learn how command-line arguments operate in PowerShell.
Visit the Command line arguments page to learn how command-line arguments operate in WSL.
If the startingDirectory is being ignored in your profile, first check to make sure the syntax is correct in your settings.json file. To help you check this syntax, "$schema": "https://aka.ms/terminal-profiles-schema" is automatically injected. Some applications, like Visual Studio Code, can use that injected schema to validate your json file as you make edits.
If your settings are correct, you may be running a startup script that sets the starting directory of your terminal separately. For example, PowerShell has its own separate concept of profiles. If you are changing your starting directory there, it will take precedence over the setting defined in Windows Terminal.
Alternatively, if you are running a script using the commandline profile setting, it may be that you are setting the location there. Similar to PowerShell profiles, your commands there take precedence over the startingDirectory profile setting.
The purpose of startingDirectory is to launch a new Windows Terminal instance in the given directory. If the terminal runs any code that changes its directory, that may be a good place to take a look.
If you are using a German keyboard layout, you may run into this problem. ctrl+= gets deserialized as ctrl+shift+0 if your main keyboard layout is set to German. This is the correct mapping for German keyboards.
More importantly, the app never receives the ctrl+shift+0 keystroke. This is because ctrl+shift+0 is reserved by Windows if you have multiple keyboard layouts active.
If you would like to disable this feature in order for Ctrl+= to work properly, follow the instructions for "Change Hotkeys to Switch Keyboard Layout in Windows 10" in this blog post.
Change the 'Switch Keyboard Layout' option to 'Not Assigned' (or off of ctrl+shift), then select OK and then Apply. ctrl+shift+0 should now work as a key binding and is passed through to the terminal.
On the other hand, if you do use this hotkey feature for multiple input languages, you can configure your own custom key binding in your settings.json file.
Some display drivers and hardware combinations do not handle scroll and/or dirty regions without blurring the data from the previous frame. To mitigate this problem, you can add a combination of these global rendering settings to reduce the strain placed on your hardware caused by the terminal text renderer.
Important
This applies only to version 1.2+ of Windows Terminal. If you are seeing color issues in Windows Terminal 1.0 or 1.1, or issues that are not captured here, please file a bug.
Windows Terminal 1.2 and beyond has an improved understanding of certain application color settings. Because of this improved understanding, we have been able to remove a number of compatibility blocks that resulted in a poor user experience. Unfortunately, there is a small number of applications that may experience issues.
We will keep this troubleshooting item up-to-date with the list of known issues and their workarounds.
Terminal, when coupled with PowerShell's line editing library PSReadline, may draw black lines across the screen. These miscolored regions will extend across the screen beyond your prompt wherever there are command parameters, strings or operators.
PSReadline version 2.0.3 has been released and contains a fix for this issue. If you are using the prerelease version of PSReadline, note that a fix is not yet available.
To update to the newest version of PSReadline, please run the following command:
Update-Module PSReadlineOnly images linked from a file location can be rendered as profile icons in the jumplist. Emojis are not supported for jumplist icons.
Applications that use the GetConsoleScreenBufferInfo family of APIs to retrieve the active console colors in Win32 format and then attempt to transform them into cross-platform VT sequences (for example, by transforming BACKGROUND_RED to \x1b[41m) may interfere with Terminal's ability to detect what background color the application is attempting to use.
Application developers are encouraged to choose either Windows API functions or VT sequences for adjusting colors and not attempt to mix them.
Starting in Windows Terminal 1.5, the Terminal will display a warning if the "Touch Keyboard and Handwriting Panel Service" is disabled. This service is needed by the operating system to properly route input events to the Terminal application (as well as many other applications on Windows). If you see this warning, you can follow these steps to re-enable the service:
- In the run dialog, run
services.msc
- Find the "Touch Keyboard and Handwriting Panel Service"
- Open the "Properties" for this service
- Change the "startup type" to "Automatic"
- Hit "Ok", and restart the PC.
After restarting the machine, the service should auto-start, and the dialog should no longer appear.
You may notice a blinking or flashing when using a git bash command line inside Windows Terminal. This behavior is actually by design. The Terminal is obeying what git bash is telling it to do (setting bell-style to visible, causing a flash to associate with the bell response), BUT we understand this may be distracting. To fix this, open the .inputrc file for your Git bash with a text editor. This file will likely be located in the path C:\Program Files\Git\etc. To open with the Nano text editor: nano ~/.inputrc
Change the default:
# none, visible or audible
set bell-style visibleSet the bell-style to either none or audible to remove the visible flash:
set bell-style nonePress Ctrl + O and Ctrl + X to Save and Exit.
To reset your settings back to the original default settings, delete your settings.json file. This will cause Windows Terminal to regenerate a settings.json file with the original default settings.
Important
As of Windows Terminal version 1.10 or greater, you'll also need to delete the state.json file in the same directory as the settings.json file to fully reset the settings to the defaults.