{"id":13399621,"url":"https://github.com/microsoft/terminal","last_synced_at":"2025-05-12T17:46:08.069Z","repository":{"id":37234683,"uuid":"100060912","full_name":"microsoft/terminal","owner":"microsoft","description":"The new Windows Terminal and the original Windows console host, all in the same place!","archived":false,"fork":false,"pushed_at":"2025-05-04T06:23:03.000Z","size":152704,"stargazers_count":98005,"open_issues_count":1657,"forks_count":8553,"subscribers_count":1336,"default_branch":"main","last_synced_at":"2025-05-05T15:11:27.792Z","etag":null,"topics":["cmd","command-line","console","contributions-welcome","good-first-issue","hacktoberfest","terminal","windows","windows-console","windows-terminal","wsl"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-08-11T18:38:22.000Z","updated_at":"2025-05-05T14:58:55.000Z","dependencies_parsed_at":"2024-01-29T16:55:02.369Z","dependency_job_id":"38c26947-68ee-4afd-b40d-9c143124e43e","html_url":"https://github.com/microsoft/terminal","commit_stats":{"total_commits":4304,"total_committers":424,"mean_commits":"10.150943396226415","dds":0.8162174721189591,"last_synced_commit":"441709e1e15f02762687ea3ca02aef914e9f3217"},"previous_names":[],"tags_count":162,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fterminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fterminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fterminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fterminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/terminal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253789828,"owners_count":21964752,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cmd","command-line","console","contributions-welcome","good-first-issue","hacktoberfest","terminal","windows","windows-console","windows-terminal","wsl"],"created_at":"2024-07-30T19:00:40.468Z","updated_at":"2025-05-12T17:46:00.833Z","avatar_url":"https://github.com/microsoft.png","language":"C++","readme":"![terminal-logos](https://github.com/microsoft/terminal/assets/91625426/333ddc76-8ab2-4eb4-a8c0-4d7b953b1179)\n\n[![Terminal Build Status](https://dev.azure.com/shine-oss/terminal/_apis/build/status%2FTerminal%20CI?branchName=main)](https://dev.azure.com/shine-oss/terminal/_build/latest?definitionId=1\u0026branchName=main)\n\n# Welcome to the Windows Terminal, Console and Command-Line repo\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e\u003c/summary\u003e\n\n- [Installing and running Windows Terminal](#installing-and-running-windows-terminal)\n  - [Microsoft Store \\[Recommended\\]](#microsoft-store-recommended)\n  - [Other install methods](#other-install-methods)\n    - [Via GitHub](#via-github)\n    - [Via Windows Package Manager CLI (aka winget)](#via-windows-package-manager-cli-aka-winget)\n    - [Via Chocolatey (unofficial)](#via-chocolatey-unofficial)\n    - [Via Scoop (unofficial)](#via-scoop-unofficial)\n- [Installing Windows Terminal Canary](#installing-windows-terminal-canary)\n- [Windows Terminal Roadmap](#windows-terminal-roadmap)\n- [Terminal \\\u0026 Console Overview](#terminal--console-overview)\n  - [Windows Terminal](#windows-terminal)\n  - [The Windows Console Host](#the-windows-console-host)\n  - [Shared Components](#shared-components)\n  - [Creating the new Windows Terminal](#creating-the-new-windows-terminal)\n- [Resources](#resources)\n- [FAQ](#faq)\n  - [I built and ran the new Terminal, but it looks just like the old console](#i-built-and-ran-the-new-terminal-but-it-looks-just-like-the-old-console)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [Communicating with the Team](#communicating-with-the-team)\n- [Developer Guidance](#developer-guidance)\n- [Prerequisites](#prerequisites)\n- [Building the Code](#building-the-code)\n  - [Building in PowerShell](#building-in-powershell)\n  - [Building in Cmd](#building-in-cmd)\n- [Running \\\u0026 Debugging](#running--debugging)\n  - [Coding Guidance](#coding-guidance)\n- [Code of Conduct](#code-of-conduct)\n\n\u003c/details\u003e\n\n\u003cbr /\u003e\n\nThis repository contains the source code for:\n\n* [Windows Terminal](https://aka.ms/terminal)\n* [Windows Terminal Preview](https://aka.ms/terminal-preview)\n* The Windows console host (`conhost.exe`)\n* Components shared between the two projects\n* [ColorTool](./src/tools/ColorTool)\n* [Sample projects](./samples)\n  that show how to consume the Windows Console APIs\n\nRelated repositories include:\n\n* [Windows Terminal Documentation](https://docs.microsoft.com/windows/terminal)\n  ([Repo: Contribute to the docs](https://github.com/MicrosoftDocs/terminal))\n* [Console API Documentation](https://github.com/MicrosoftDocs/Console-Docs)\n* [Cascadia Code Font](https://github.com/Microsoft/Cascadia-Code)\n\n## Installing and running Windows Terminal\n\n\u003e [!NOTE]\n\u003e Windows Terminal requires Windows 10 2004 (build 19041) or later\n\n### Microsoft Store [Recommended]\n\nInstall the [Windows Terminal from the Microsoft Store][store-install-link].\nThis allows you to always be on the latest version when we release new builds\nwith automatic upgrades.\n\nThis is our preferred method.\n\n### Other install methods\n\n#### Via GitHub\n\nFor users who are unable to install Windows Terminal from the Microsoft Store,\nreleased builds can be manually downloaded from this repository's [Releases\npage](https://github.com/microsoft/terminal/releases).\n\nDownload the `Microsoft.WindowsTerminal_\u003cversionNumber\u003e.msixbundle` file from\nthe **Assets** section. To install the app, you can simply double-click on the\n`.msixbundle` file, and the app installer should automatically run. If that\nfails for any reason, you can try the following command at a PowerShell prompt:\n\n```powershell\n# NOTE: If you are using PowerShell 7+, please run\n# Import-Module Appx -UseWindowsPowerShell\n# before using Add-AppxPackage.\n\nAdd-AppxPackage Microsoft.WindowsTerminal_\u003cversionNumber\u003e.msixbundle\n```\n\n\u003e [!NOTE]\n\u003e If you install Terminal manually:\n\u003e\n\u003e * You may need to install the [VC++ v14 Desktop Framework Package](https://docs.microsoft.com/troubleshoot/cpp/c-runtime-packages-desktop-bridge#how-to-install-and-update-desktop-framework-packages).\n\u003e   This should only be necessary on older builds of Windows 10 and only if you get an error about missing framework packages.\n\u003e * Terminal will not auto-update when new builds are released so you will need\n\u003e   to regularly install the latest Terminal release to receive all the latest\n\u003e   fixes and improvements!\n\n#### Via Windows Package Manager CLI (aka winget)\n\n[winget](https://github.com/microsoft/winget-cli) users can download and install\nthe latest Terminal release by installing the `Microsoft.WindowsTerminal`\npackage:\n\n```powershell\nwinget install --id Microsoft.WindowsTerminal -e\n```\n\n\u003e [!NOTE]\n\u003e Dependency support is available in WinGet version [1.6.2631 or later](https://github.com/microsoft/winget-cli/releases). To install the Terminal stable release 1.18 or later, please make sure you have the updated version of the WinGet client.\n\n#### Via Chocolatey (unofficial)\n\n[Chocolatey](https://chocolatey.org) users can download and install the latest\nTerminal release by installing the `microsoft-windows-terminal` package:\n\n```powershell\nchoco install microsoft-windows-terminal\n```\n\nTo upgrade Windows Terminal using Chocolatey, run the following:\n\n```powershell\nchoco upgrade microsoft-windows-terminal\n```\n\nIf you have any issues when installing/upgrading the package please go to the\n[Windows Terminal package\npage](https://chocolatey.org/packages/microsoft-windows-terminal) and follow the\n[Chocolatey triage process](https://chocolatey.org/docs/package-triage-process)\n\n#### Via Scoop (unofficial)\n\n[Scoop](https://scoop.sh) users can download and install the latest Terminal\nrelease by installing the `windows-terminal` package:\n\n```powershell\nscoop bucket add extras\nscoop install windows-terminal\n```\n\nTo update Windows Terminal using Scoop, run the following:\n\n```powershell\nscoop update windows-terminal\n```\n\nIf you have any issues when installing/updating the package, please search for\nor report the same on the [issues\npage](https://github.com/lukesampson/scoop-extras/issues) of Scoop Extras bucket\nrepository.\n\n---\n\n## Installing Windows Terminal Canary\nWindows Terminal Canary is a nightly build of Windows Terminal. This build has the latest code from our `main` branch, giving you an opportunity to try features before they make it to Windows Terminal Preview.\n\nWindows Terminal Canary is our least stable offering, so you may discover bugs before we have had a chance to find them.\n\nWindows Terminal Canary is available as an App Installer distribution and a Portable ZIP distribution.\n\nThe App Installer distribution supports automatic updates. Due to platform limitations, this installer only works on Windows 11.\n\nThe Portable ZIP distribution is a portable application. It will not automatically update and will not automatically check for updates. This portable ZIP distribution works on Windows 10 (19041+) and Windows 11.\n\n| Distribution  | Architecture    | Link                                                 |\n|---------------|:---------------:|------------------------------------------------------|\n| App Installer | x64, arm64, x86 | [download](https://aka.ms/terminal-canary-installer) |\n| Portable ZIP  | x64             | [download](https://aka.ms/terminal-canary-zip-x64)   |\n| Portable ZIP  | ARM64           | [download](https://aka.ms/terminal-canary-zip-arm64) |\n| Portable ZIP  | x86             | [download](https://aka.ms/terminal-canary-zip-x86)   |\n\n_Learn more about the [types of Windows Terminal distributions](https://learn.microsoft.com/windows/terminal/distributions)._\n\n---\n\n## Windows Terminal Roadmap\n\nThe plan for the Windows Terminal [is described here](/doc/roadmap-2023.md) and\nwill be updated as the project proceeds.\n\n## Terminal \u0026 Console Overview\n\nPlease take a few minutes to review the overview below before diving into the\ncode:\n\n### Windows Terminal\n\nWindows Terminal is a new, modern, feature-rich, productive terminal application\nfor command-line users. It includes many of the features most frequently\nrequested by the Windows command-line community including support for tabs, rich\ntext, globalization, configurability, theming \u0026 styling, and more.\n\nThe Terminal will also need to meet our goals and measures to ensure it remains\nfast and efficient, and doesn't consume vast amounts of memory or power.\n\n### The Windows Console Host\n\nThe Windows Console host, `conhost.exe`, is Windows' original command-line user\nexperience. It also hosts Windows' command-line infrastructure and the Windows\nConsole API server, input engine, rendering engine, user preferences, etc. The\nconsole host code in this repository is the actual source from which the\n`conhost.exe` in Windows itself is built.\n\nSince taking ownership of the Windows command-line in 2014, the team added\nseveral new features to the Console, including background transparency,\nline-based selection, support for [ANSI / Virtual Terminal\nsequences](https://en.wikipedia.org/wiki/ANSI_escape_code), [24-bit\ncolor](https://devblogs.microsoft.com/commandline/24-bit-color-in-the-windows-console/),\na [Pseudoconsole\n(\"ConPTY\")](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/),\nand more.\n\nHowever, because Windows Console's primary goal is to maintain backward\ncompatibility, we have been unable to add many of the features the community\n(and the team) have been wanting for the last several years including tabs,\nunicode text, and emoji.\n\nThese limitations led us to create the new Windows Terminal.\n\n\u003e You can read more about the evolution of the command-line in general, and the\n\u003e Windows command-line specifically in [this accompanying series of blog\n\u003e posts](https://devblogs.microsoft.com/commandline/windows-command-line-backgrounder/)\n\u003e on the Command-Line team's blog.\n\n### Shared Components\n\nWhile overhauling Windows Console, we modernized its codebase considerably,\ncleanly separating logical entities into modules and classes, introduced some\nkey extensibility points, replaced several old, home-grown collections and\ncontainers with safer, more efficient [STL\ncontainers](https://docs.microsoft.com/en-us/cpp/standard-library/stl-containers?view=vs-2022),\nand made the code simpler and safer by using Microsoft's [Windows Implementation\nLibraries - WIL](https://github.com/Microsoft/wil).\n\nThis overhaul resulted in several of Console's key components being available\nfor re-use in any terminal implementation on Windows. These components include a\nnew DirectWrite-based text layout and rendering engine, a text buffer capable of\nstoring both UTF-16 and UTF-8, a VT parser/emitter, and more.\n\n### Creating the new Windows Terminal\n\nWhen we started planning the new Windows Terminal application, we explored and\nevaluated several approaches and technology stacks. We ultimately decided that\nour goals would be best met by continuing our investment in our C++ codebase,\nwhich would allow us to reuse several of the aforementioned modernized\ncomponents in both the existing Console and the new Terminal. Further, we\nrealized that this would allow us to build much of the Terminal's core itself as\na reusable UI control that others can incorporate into their own applications.\n\nThe result of this work is contained within this repo and delivered as the\nWindows Terminal application you can download from the Microsoft Store, or\n[directly from this repo's\nreleases](https://github.com/microsoft/terminal/releases).\n\n---\n\n## Resources\n\nFor more information about Windows Terminal, you may find some of these\nresources useful and interesting:\n\n* [Command-Line Blog](https://devblogs.microsoft.com/commandline)\n* [Command-Line Backgrounder Blog\n  Series](https://devblogs.microsoft.com/commandline/windows-command-line-backgrounder/)\n* Windows Terminal Launch: [Terminal \"Sizzle\n  Video\"](https://www.youtube.com/watch?v=8gw0rXPMMPE\u0026list=PLEHMQNlPj-Jzh9DkNpqipDGCZZuOwrQwR\u0026index=2\u0026t=0s)\n* Windows Terminal Launch: [Build 2019\n  Session](https://www.youtube.com/watch?v=KMudkRcwjCw)\n* Run As Radio: [Show 645 - Windows Terminal with Richard\n  Turner](https://www.runasradio.com/Shows/Show/645)\n* Azure Devops Podcast: [Episode 54 - Kayla Cinnamon and Rich Turner on DevOps\n  on the Windows\n  Terminal](http://azuredevopspodcast.clear-measure.com/kayla-cinnamon-and-rich-turner-on-devops-on-the-windows-terminal-team-episode-54)\n* Microsoft Ignite 2019 Session: [The Modern Windows Command Line: Windows\n  Terminal -\n  BRK3321](https://myignite.techcommunity.microsoft.com/sessions/81329?source=sessions)\n\n---\n\n## FAQ\n\n### I built and ran the new Terminal, but it looks just like the old console\n\nCause: You're launching the incorrect solution in Visual Studio.\n\nSolution: Make sure you're building \u0026 deploying the `CascadiaPackage` project in\nVisual Studio.\n\n\u003e [!NOTE]\n\u003e `OpenConsole.exe` is just a locally-built `conhost.exe`, the classic\n\u003e Windows Console that hosts Windows' command-line infrastructure. OpenConsole\n\u003e is used by Windows Terminal to connect to and communicate with command-line\n\u003e applications (via\n\u003e [ConPty](https://devblogs.microsoft.com/commandline/windows-command-line-introducing-the-windows-pseudo-console-conpty/)).\n\n---\n\n## Documentation\n\nAll project documentation is located at [aka.ms/terminal-docs](https://aka.ms/terminal-docs). If you would like\nto contribute to the documentation, please submit a pull request on the [Windows\nTerminal Documentation repo](https://github.com/MicrosoftDocs/terminal).\n\n---\n\n## Contributing\n\nWe are excited to work alongside you, our amazing community, to build and\nenhance Windows Terminal\\!\n\n***BEFORE you start work on a feature/fix***, please read \u0026 follow our\n[Contributor's\nGuide](./CONTRIBUTING.md) to\nhelp avoid any wasted or duplicate effort.\n\n## Communicating with the Team\n\nThe easiest way to communicate with the team is via GitHub issues.\n\nPlease file new issues, feature requests and suggestions, but **DO search for\nsimilar open/closed preexisting issues before creating a new issue.**\n\nIf you would like to ask a question that you feel doesn't warrant an issue\n(yet), please reach out to us via Twitter:\n\n* Christopher Nguyen, Product Manager:\n  [@nguyen_dows](https://twitter.com/nguyen_dows)\n* Dustin Howett, Engineering Lead: [@dhowett](https://twitter.com/DHowett)\n* Mike Griese, Senior Developer: [@zadjii@mastodon.social](https://mastodon.social/@zadjii)\n* Carlos Zamora, Developer: [@cazamor_msft](https://twitter.com/cazamor_msft)\n* Pankaj Bhojwani, Developer\n* Leonard Hecker, Developer: [@LeonardHecker](https://twitter.com/LeonardHecker)\n\n## Developer Guidance\n\n## Prerequisites\n\nYou can configure your environment to build Terminal in one of two ways:\n\n### Using WinGet configuration file\n\nAfter cloning the repository, you can use a [WinGet configuration file](https://learn.microsoft.com/en-us/windows/package-manager/configuration/#use-a-winget-configuration-file-to-configure-your-machine)\nto set up your environment. The [default configuration file](.config/configuration.winget) installs Visual Studio 2022 Community \u0026 rest of the required tools. There are two other variants of the configuration file available in the [.config](.config) directory for Enterprise \u0026 Professional editions of Visual Studio 2022. To run the default configuration file, you can either double-click the file from explorer or run the following command:\n\n```powershell\nwinget configure .config\\configuration.winget\n```\n\n### Manual configuration\n\n* You must be running Windows 10 2004 (build \u003e= 10.0.19041.0) or later to run\n  Windows Terminal\n* You must [enable Developer Mode in the Windows Settings\n  app](https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development)\n  to locally install and run Windows Terminal\n* You must have [PowerShell 7 or later](https://github.com/PowerShell/PowerShell/releases/latest) installed\n* You must have the [Windows 11 (10.0.22621.0)\n  SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/)\n  installed\n* You must have at least [VS\n  2022](https://visualstudio.microsoft.com/downloads/) installed\n* You must install the following Workloads via the VS Installer. Note: Opening\n  the solution in VS 2022 will [prompt you to install missing components\n  automatically](https://devblogs.microsoft.com/setup/configure-visual-studio-across-your-organization-with-vsconfig/):\n  * Desktop Development with C++\n  * Universal Windows Platform Development\n  * **The following Individual Components**\n    * C++ (v143) Universal Windows Platform Tools\n* You must install the [.NET Framework Targeting Pack](https://docs.microsoft.com/dotnet/framework/install/guide-for-developers#to-install-the-net-framework-developer-pack-or-targeting-pack) to build test projects\n\n## Building the Code\n\nOpenConsole.sln may be built from within Visual Studio or from the command-line\nusing a set of convenience scripts \u0026 tools in the **/tools** directory:\n\n### Building in PowerShell\n\n```powershell\nImport-Module .\\tools\\OpenConsole.psm1\nSet-MsBuildDevEnvironment\nInvoke-OpenConsoleBuild\n```\n\n### Building in Cmd\n\n```shell\n.\\tools\\razzle.cmd\nbcz\n```\n\n## Running \u0026 Debugging\n\nTo debug the Windows Terminal in VS, right click on `CascadiaPackage` (in the\nSolution Explorer) and go to properties. In the Debug menu, change \"Application\nprocess\" and \"Background task process\" to \"Native Only\".\n\nYou should then be able to build \u0026 debug the Terminal project by hitting\n\u003ckbd\u003eF5\u003c/kbd\u003e. Make sure to select either the \"x64\" or the \"x86\" platform - the\nTerminal doesn't build for \"Any Cpu\" (because the Terminal is a C++ application,\nnot a C# one).\n\n\u003e 👉 You will _not_ be able to launch the Terminal directly by running the\n\u003e WindowsTerminal.exe. For more details on why, see\n\u003e [#926](https://github.com/microsoft/terminal/issues/926),\n\u003e [#4043](https://github.com/microsoft/terminal/issues/4043)\n\n### Coding Guidance\n\nPlease review these brief docs below about our coding practices.\n\n\u003e 👉 If you find something missing from these docs, feel free to contribute to\n\u003e any of our documentation files anywhere in the repository (or write some new\n\u003e ones!)\n\nThis is a work in progress as we learn what we'll need to provide people in\norder to be effective contributors to our project.\n\n* [Coding Style](./doc/STYLE.md)\n* [Code Organization](./doc/ORGANIZATION.md)\n* [Exceptions in our legacy codebase](./doc/EXCEPTIONS.md)\n* [Helpful smart pointers and macros for interfacing with Windows in WIL](./doc/WIL.md)\n\n---\n\n## Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of\nConduct][conduct-code]. For more information see the [Code of Conduct\nFAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any\nadditional questions or comments.\n\n[conduct-code]: https://opensource.microsoft.com/codeofconduct/\n[conduct-FAQ]: https://opensource.microsoft.com/codeofconduct/faq/\n[conduct-email]: mailto:opencode@microsoft.com\n[store-install-link]: https://aka.ms/terminal\n","funding_links":[],"categories":["C++","Windows","Uncategorized","\u003ca name=\"cpp\"\u003e\u003c/a\u003eC++","WSL Tools \u0026 Projects","Real-World Projects","Cpp","终端","🔧 Utilites","windows","剪贴板工具","Tools","WSL Tools","🖥 Windows","Terminals and Shells","😎 Awesome Dev 😎","Windows Tools","Open Source Projects","Table of Contents","Recomeded setup"],"sub_categories":["Developement","Uncategorized","JavaScript","Desktop Application Development","网络服务_其他","10. GUI Apps","Mesh networks","websites to study from","Basic Setup - Windows","Tools","Terminal Emulator","Technical Stack Overview"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fterminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fterminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fterminal/lists"}