Go to file
Leonard Hecker f2386de422
Improve performance and binary size of til::enumset (#11493)
This commit approximately doubles the performance of til::enumset
and reduces it's binary footprint by approximately 1kB.
Most of the binary size can be attributed to exception handling.

Unfortunately this commit removes assertions that the given values are less than
the number of bits in the `underlying_type`. However I believe this to be a good
trade-off as the tests previously only happened at runtime, while tests at
compile time would be highly preferable. Such tests are technically possible,
however MSVC fails to compile (valid) `static_assert`s containing
`static_cast`s over a parameter pack at the time of writing.
With future MSVC versions such checks can be added to this class.

This change was initially discussed in #10492, but was forgotten to
be considered before it was merged. Since the work was already done,
this commit re-introduces the optimization. It's free!

## PR Checklist
* [x] I work here.
* [x] Tests added/passed

## Validation Steps Performed
* Run `printf '\e]8;;http://example.com\e\\This is a link\e]8;;\e\\\n'` in WSL
* A wild dotted line appears ✔️
2021-11-23 18:44:58 +00:00
.config Auto-format our XAML files and enforce in CI (#9589) 2021-03-29 17:09:38 -05:00
.github Consolidate the color palette APIs (#11784) 2021-11-23 18:28:55 +00:00
.nuget Auto-format our XAML files and enforce in CI (#9589) 2021-03-29 17:09:38 -05:00
.vscode Add a language switcher using PrimaryLanguageOverride (#10309) 2021-06-10 23:24:21 +00:00
build Wrap these commands with quotes (#11807) 2021-11-23 17:01:59 +00:00
dep Rev wil to latest version (#10435) 2021-06-15 23:11:16 +00:00
doc Upgrade to Windows SDK 22000 (#11728) 2021-11-18 18:08:26 +00:00
oss Implement basic profile matching (#11390) 2021-10-08 00:40:10 +00:00
res Update Cascadia Code to 2108.26 (#11061) 2021-08-26 14:54:32 -05:00
samples Upgrade to Windows SDK 22000 (#11728) 2021-11-18 18:08:26 +00:00
scratch/ScratchIslandApp Fixes the wapproj fast-up-to-date check (#11806) 2021-11-23 11:22:56 +00:00
src Improve performance and binary size of til::enumset (#11493) 2021-11-23 18:44:58 +00:00
tools Prefer Preview VS builds always; use any existing msbuild if it's on the path (#11803) 2021-11-23 06:35:21 -06:00
.clang-format Update clang-format to 10.0 (#7389) 2020-08-25 17:15:43 +00:00
.editorconfig .editorconfig: add utf-8 encoding (#11190) 2021-09-23 18:47:07 +00:00
.gitattributes .gitattributes: removed php display in the project (#11329) 2021-09-27 13:27:59 +00:00
.gitignore Scale box drawing glyphs to fit cells for visual bliss (#5743) 2020-05-08 14:09:32 -07:00
.gitmodules Lowercase GH org name in .gitmodules (#629) 2019-05-09 12:19:45 -07:00
.vsconfig Upgrade to Windows SDK 22000 (#11728) 2021-11-18 18:08:26 +00:00
CODE_OF_CONDUCT.md doc: update CODE_OF_CONDUCT.md (#4816) 2020-03-05 10:18:36 -08:00
CONTRIBUTING.md Add some details about working on assigned issues (#11802) 2021-11-23 15:21:42 +00:00
LICENSE Initial release of the Windows Terminal source code 2019-05-02 15:29:04 -07:00
NOTICE.md Improve til::gen_random documentation (#11465) 2021-10-11 17:59:40 +02:00
NuGet.Config Cleanup NuGet.Config file. (#8829) 2021-01-20 19:00:36 +00:00
OpenConsole.sln Introduce AtlasEngine - A new text rendering prototype (#11623) 2021-11-13 00:10:06 +00:00
README.md README.md: HTTP => HTTPS (#11671) 2021-11-04 22:45:19 +00:00
SECURITY.md doc: fix a small issue for #hacktoberfest (#3057) 2019-10-04 13:54:13 -07:00
SUPPORT.md Prepare for the primary branch name to change to main (#7985) 2020-10-21 17:29:36 -07:00
Scratch.sln Add a Scratch.sln for prototyping (#10067) 2021-06-10 12:56:47 -05:00
XamlStyler.json Auto-format our XAML files and enforce in CI (#9589) 2021-03-29 17:09:38 -05:00
common.openconsole.props Initial release of the Windows Terminal source code 2019-05-02 15:29:04 -07:00
consolegit2gitfilters.json Update Cascadia Code to 2106.17 (#10455) 2021-06-18 20:47:19 +00:00
custom.props Update version to 1.13 on main (#11550) 2021-10-20 13:12:17 -05:00
dirs Initial release of the Windows Terminal source code 2019-05-02 15:29:04 -07:00



Welcome to the Windows Terminal, Console and Command-Line repo

This repository contains the source code for:

Related repositories include:

Installing and running Windows Terminal

🔴 Note: Windows Terminal requires Windows 10 1903 (build 18362) or later

Install the Windows Terminal from the Microsoft Store. This allows you to always be on the latest version when we release new builds with automatic upgrades.

This is our preferred method.

Other install methods

Via GitHub

For users who are unable to install Windows Terminal from the Microsoft Store, released builds can be manually downloaded from this repository's Releases page.

Download the Microsoft.WindowsTerminal_<versionNumber>.msixbundle file from the Assets section. To install the app, you can simply double-click on the .msixbundle file, and the app installer should automatically run. If that fails for any reason, you can try the following command at a PowerShell prompt:

# NOTE: If you are using PowerShell 7+, please run
# Import-Module Appx -UseWindowsPowerShell
# before using Add-AppxPackage.

Add-AppxPackage Microsoft.WindowsTerminal_<versionNumber>.msixbundle

🔴 Note: If you install Terminal manually:

  • Terminal will not auto-update when new builds are released so you will need to regularly install the latest Terminal release to receive all the latest fixes and improvements!

Via Windows Package Manager CLI (aka winget)

winget users can download and install the latest Terminal release by installing the Microsoft.WindowsTerminal package:

winget install --id=Microsoft.WindowsTerminal -e

Via Chocolatey (unofficial)

Chocolatey users can download and install the latest Terminal release by installing the microsoft-windows-terminal package:

choco install microsoft-windows-terminal

To upgrade Windows Terminal using Chocolatey, run the following:

choco upgrade microsoft-windows-terminal

If you have any issues when installing/upgrading the package please go to the Windows Terminal package page and follow the Chocolatey triage process

Via Scoop (unofficial)

Scoop users can download and install the latest Terminal release by installing the windows-terminal package:

scoop bucket add extras
scoop install windows-terminal

To update Windows Terminal using Scoop, run the following:

scoop update windows-terminal

If you have any issues when installing/updating the package, please search for or report the same on the issues page of Scoop Extras bucket repository.

Windows Terminal 2.0 Roadmap

The plan for delivering Windows Terminal 2.0 is described here and will be updated as the project proceeds.

Project Build Status

Project Build Status
Terminal Terminal Build Status
ColorTool Colortool Build Status

Terminal & Console Overview

Please take a few minutes to review the overview below before diving into the code:

Windows Terminal

Windows Terminal is a new, modern, feature-rich, productive terminal application for command-line users. It includes many of the features most frequently requested by the Windows command-line community including support for tabs, rich text, globalization, configurability, theming & styling, and more.

The Terminal will also need to meet our goals and measures to ensure it remains fast and efficient, and doesn't consume vast amounts of memory or power.

The Windows Console Host

The Windows Console host, conhost.exe, is Windows' original command-line user experience. It also hosts Windows' command-line infrastructure and the Windows Console API server, input engine, rendering engine, user preferences, etc. The console host code in this repository is the actual source from which the conhost.exe in Windows itself is built.

Since taking ownership of the Windows command-line in 2014, the team added several new features to the Console, including background transparency, line-based selection, support for ANSI / Virtual Terminal sequences, 24-bit color, a Pseudoconsole ("ConPTY"), and more.

However, because Windows Console's primary goal is to maintain backward compatibility, we have been unable to add many of the features the community (and the team) have been wanting for the last several years including tabs, unicode text, and emoji.

These limitations led us to create the new Windows Terminal.

You can read more about the evolution of the command-line in general, and the Windows command-line specifically in this accompanying series of blog posts on the Command-Line team's blog.

Shared Components

While overhauling Windows Console, we modernized its codebase considerably, cleanly separating logical entities into modules and classes, introduced some key extensibility points, replaced several old, home-grown collections and containers with safer, more efficient STL containers, and made the code simpler and safer by using Microsoft's Windows Implementation Libraries - WIL.

This overhaul resulted in several of Console's key components being available for re-use in any terminal implementation on Windows. These components include a new DirectWrite-based text layout and rendering engine, a text buffer capable of storing both UTF-16 and UTF-8, a VT parser/emitter, and more.

Creating the new Windows Terminal

When we started planning the new Windows Terminal application, we explored and evaluated several approaches and technology stacks. We ultimately decided that our goals would be best met by continuing our investment in our C++ codebase, which would allow us to reuse several of the aforementioned modernized components in both the existing Console and the new Terminal. Further, we realized that this would allow us to build much of the Terminal's core itself as a reusable UI control that others can incorporate into their own applications.

The result of this work is contained within this repo and delivered as the Windows Terminal application you can download from the Microsoft Store, or directly from this repo's releases.


For more information about Windows Terminal, you may find some of these resources useful and interesting:


I built and ran the new Terminal, but it looks just like the old console

Cause: You're launching the incorrect solution in Visual Studio.

Solution: Make sure you're building & deploying the CascadiaPackage project in Visual Studio.

⚠ Note: OpenConsole.exe is just a locally-built conhost.exe, the classic Windows Console that hosts Windows' command-line infrastructure. OpenConsole is used by Windows Terminal to connect to and communicate with command-line applications (via ConPty).


All project documentation is located at aka.ms/terminal-docs. If you would like to contribute to the documentation, please submit a pull request on the Windows Terminal Documentation repo.


We are excited to work alongside you, our amazing community, to build and enhance Windows Terminal!

BEFORE you start work on a feature/fix, please read & follow our Contributor's Guide to help avoid any wasted or duplicate effort.

Communicating with the Team

The easiest way to communicate with the team is via GitHub issues.

Please file new issues, feature requests and suggestions, but DO search for similar open/closed pre-existing issues before creating a new issue.

If you would like to ask a question that you feel doesn't warrant an issue (yet), please reach out to us via Twitter:

Developer Guidance


Building the Code

This repository uses git submodules for some of its dependencies. To make sure submodules are restored or updated, be sure to run the following prior to building:

git submodule update --init --recursive

OpenConsole.sln may be built from within Visual Studio or from the command-line using a set of convenience scripts & tools in the /tools directory:

Building in PowerShell

Import-Module .\tools\OpenConsole.psm1

Building in Cmd


Running & Debugging

To debug the Windows Terminal in VS, right click on CascadiaPackage (in the Solution Explorer) and go to properties. In the Debug menu, change "Application process" and "Background task process" to "Native Only".

You should then be able to build & debug the Terminal project by hitting F5.

👉 You will not be able to launch the Terminal directly by running the WindowsTerminal.exe. For more details on why, see #926, #4043

Coding Guidance

Please review these brief docs below about our coding practices.

👉 If you find something missing from these docs, feel free to contribute to any of our documentation files anywhere in the repository (or write some new ones!)

This is a work in progress as we learn what we'll need to provide people in order to be effective contributors to our project.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.