This repository contains the source code & documentation for:

• Windows Terminal
• The Windows console host (conhost.exe)
• Components shared between the two projects
• ColorTool
• Sample projects that show how to consume the Windows Console APIs

Other related repositories include:

• Console API Documentation

Windows Terminal can be installed on Windows 10 1903 (build 18362) or later.

We recommend downloading the Windows Terminal from the Microsoft Store so that it will be automatically upgraded when we release new builds:

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

⚠ Note: If you install Terminal manually:

• Be sure to install the Desktop Bridge VC++ v14 Redistributable Package otherwise Terminal may not install and/or run and may crash at startup
• 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!

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

Project	Build Status
Terminal
ColorTool

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

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

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, conhost.exe, is Windows' original command-line user experience. It implements Windows' command-line infrastructure, and is responsible for hosting the Windows Console API, input engine, rendering engine, and user preferences. The console host code in this repository is the actual source from which the conhost.exe in Windows itself is built.

Since assuming ownership of the Windows command-line in 2014, the team has added several new features to the Console, including window 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've been unable to add many of the features the community has been asking for (and which we've been wanting to add) for the last several years including tabs, unicode text, emoji, etc.

These limitations led us to create the new Windows Terminal.

While overhauling the Console, we've modernized its codebase considerably. We've cleanly separated 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 WIL header library.

This overhaul work resulted in the creation of several key components that would be useful for any terminal implementation on Windows, including a new DirectWrite-based text layout and rendering engine, a text buffer capable of storing both UTF-16 and UTF-8, and a VT parser/emitter.

When we started building the new terminal application, we explored and evaluated several approaches and technology stacks. We ultimately decided that our goals would be best met by sticking with C++ and sharing the aforementioned modernized components, placing them atop the modern Windows application platform and UI framework.

Further, we realized that this would allow us to build the terminal's renderer and input stack as a reusable Windows UI control that others can incorporate into their applications.

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. It is used by Windows Terminal to connect to and communicate with command-line applications (via ConPty).

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

We ask that before you start work on a feature that you would like to contribute, please read our Contributor's Guide. We will be happy to work with you to figure out the best approach, provide guidance and mentorship throughout feature development, and help avoid any wasted or duplicate effort.

👉 Remember! Your contributions may be incorporated into future versions of Windows! Because of this, all pull requests will be subject to the same level of scrutiny for quality, coding standards, performance, globalization, accessibility, and compatibility as those of our internal contributors.

⚠ Note: The Command-Line Team is actively working out of this repository and will be periodically re-structuring the code to make it easier to comprehend, navigate, build, test, and contribute to, so DO expect significant changes to code layout on a regular basis.

All documentation is located in the ./doc folder. If you would like to contribute to the documentation, please submit a pull request.

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 you do.

Please help us keep this repository clean, inclusive, and fun! We will not tolerate any abusive, rude, disrespectful or inappropriate behavior. Read our Code of Conduct for more details.

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

• Rich Turner, Program Manager: @richturn_ms

• Dustin Howett, Engineering Lead: @dhowett

• Michael Niksa, Senior Developer: @michaelniksa

• Kayla Cinnamon, Program Manager (especially for UX issues): @cinnamon_msft

• You must be running Windows 1903 (build >= 10.0.18362.0) or above in order to run Windows Terminal.

• You must have the 1903 SDK (build 10.0.18362.0) installed.

• You must have at least VS 2019 installed.

• You must install the following Workloads via the VS Installer. Opening the solution will prompt you to install missing components automatically.

  • Desktop Development with C++
  • Universal Windows Platform Development
  • The following Individual Components
    • C++ (v142) Universal Windows Platform Tools

• You must also enable Developer Mode in the Windows Settings app to locally install and run the Terminal app.

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 MSBuild. To build from the command line, find your shell below.

Import-Module .\tools\OpenConsole.psm1
Set-MsBuildDevEnvironment
Invoke-OpenConsoleBuild

.\tools\razzle.cmd
bcz

We've provided a set of convenience scripts as well as README in the /tools directory to help automate the process of building and running tests.

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

Please review these brief docs below relating to our coding standards etc.

👉 If you find something missing from these docs, feel free to contribute to any of our documentation files anywhere in the repository (or make 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.

• Coding Style
• Code Organization
• Exceptions in our legacy codebase
• Helpful smart pointers and macros for interfacing with Windows in WIL

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.