microsoft / terminal

GitHub

Code

How microsoft/terminal is laid out, and where to start for common changes.

There is no import map for this report yet.

File context

README.md

File list at 10630264af2c

Ask about this file Open source ↗

Ask opens an editable question with this file and revision. Send it when ready.

Reading suggestion

Read the repository's own usage and contribution guidance.

Source evidence captured at 10630264af2c.

Captured excerpt · 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](https://github.com/microsoft/terminal/releases).

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:

```powershell
# 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:
>
> * You may need to install the [VC++ v14 Desktop Framework Package](https://learn.microsoft.com/troubleshoot/cpp/c-runtime-packages-desktop-bridge#how-to-install-and-update-desktop-framework-packages).
>   This should only be necessary on older builds of Windows 10 and only if you get an error about missing framework packages.
> * 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](https://github.com/microsoft/winget-cli) users can download and install
the latest Terminal release by installing the `Microsoft.WindowsTerminal`
package:

```powershell
winget install --id Microsoft.WindowsTerminal -e
```

> [!NOTE]
> 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.

#### Via Chocolatey (unofficial)

[Chocolatey](https://chocolatey.org) users can download and install the latest
Terminal release by installing the `microsoft-windows-terminal` package:

```powershell
choco install microsoft-windows-terminal
```

To upgrade Windows Terminal using Chocolatey, run the following:

```powershell
choco upgrade microsoft-windows-terminal
```

If you have any issues when installing/upgrading the package please go to the
[Windows Terminal package
page](https://chocolatey.org/packages/microsoft-windows-terminal) and follow the
[Chocolatey triage process](https://chocolatey.org/docs/package-triage-process)

#### Via Scoop (unofficial)

[Scoop](https://scoop.sh) users can download and install the latest Terminal
release by installing the `windows-terminal` package:

```powershell
scoop bucket add extras
scoop install windows-terminal
```

To update Windows Terminal using Scoop, run the following:

```powershell
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](https://github.com/lukesampson/scoop-extras/issues) of Scoop Extras bucket
repository.

---

View cited source section ↗

Where to start reading

Repository root
Repository root
Suggested starting pointAI
Suggested starting pointAI
Suggested starting pointAI
Suggested starting pointAI
Suggested starting pointAI
Suggested starting pointAI

Find files for a task

Add a new VT-100 escape sequence handler

Define the new dispatch type enum in DispatchTypes.hpp
Add abstract method to ITermDispatch interface for the new sequence
Update parser state machine or routing logic in adapter to recognize sequence pattern

Add a new console buffer attribute or cell property

Add serialization/deserialization logic if needed for persistence
Update rendering backend to handle the new attribute (Backend.cpp or AtlasEngine.cpp)
Add corresponding API dispatch method in ApiDispatchers if externally configurable

Add a new settings UI page

Add new property sheet page class extending base property page (reference existing ColorsPage.cpp)
Define configuration structure in DefaultSettings.h for new settings
Implement registry serialization in RegistrySerialization.cpp
Register page in application manifest or main settings controller

Add a new rendering backend feature

Add abstract method to Backend.h interface
Implement feature in AtlasEngine.cpp (DirectX) or platform-specific backend
Update AtlasEngine.api.cpp to expose feature through public API if needed
Add corresponding test in ConPtyTests or rendering test suite

Add or update tests

Change build or automation

RepoPilot lists up to 500 files, so a file missing here may still exist.

Some of the written code guide was incomplete and is left out.
No public API or start-up file could be picked out from the file names.

Code quality and hotspots

Largest source files

Branch points165 per file on average
Code issues0 errors, 232 warnings
Largest file4,907 lines
Hotspot load0 high-risk files

Static checks on the 15 largest source files.

Tests, CI and tooling

CIGitHub Actions4 workflows
Tests164 test files0.13 test files per source file (file count, not coverage)
Dependency updatesNo config detected

Test folders: doc/specs/#1564 - Settings UI · doc/specs/#1502 - Advanced Tab Switcher/img · doc/specs

Hotspots

src/terminal/adapter/adaptDispatch.cpp4 commits in 180 days · 600 branch points
src/renderer/atlas/BackendD3D.cpp2 commits in 180 days · 214 branch points
src/terminal/adapter/ut_adapter/adapterTest.cpp1 commit in 180 days · 159 branch points
src/renderer/atlas/BuiltinGlyphs.cpp1 commit in 180 days · 45 branch points
src/server/ApiDispatchers.cpp1 commit in 180 days · 71 branch points
src/buffer/out/Row.cpp1 commit in 180 days · 94 branch points
src/renderer/atlas/AtlasEngine.cpp1 commit in 180 days · 127 branch points
src/renderer/atlas/BackendD2D.cpp1 commit in 180 days · 101 branch points

Files that change often and branch heavily, highest first. Branch points count if, loop, case, catch, ternary, && and || in the file.