starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-09-25 00:15:10 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Guide for build and installation #723

New Issue
Open
opened 2026-01-30 22:00:44 +00:00 by claunia · 0 comments
claunia commented 2026-01-30 22:00:44 +00:00
Owner
Copy Link

Originally created by @ZgblKylin on GitHub (May 7, 2019).

Tools needed

  1. VS2017 or higher with the following packages ("Workloads" tab in Visual Studio Installer) :
    1.1 Desktop Development with C++.
    1.2 Universal Windows Platform Development.
    1.3 Windows 10 SDK (10.0.18362.0).
    1.4 If you're running VS2019, you'll also need to install either v141 Toolset or v142 Toolset.
  2. Git command-line tool.
  3. Nuget.exe (Needed in build step 3, can be found in Terminal/dep/nuget).

Build Steps

  1. git clone this repository, not download .zip file.
  2. Run git submodule update --init --recursive in Terminal folder.
  3. Run nuget restore OpenConsole.sln (This step can be skipped, then Visual Studio should warn you that there are packages to restore - then restore).
  4. Open OpenConsole.sln with Visual Studio.
  5. Build whole solution(F7) with your platform(x86/x64) and release mode, you may need to fix some build errors:
    5.1 C2220 and code page warnings: All errors and warnings are encoding error of unicode characters, a helpful workaround is to modify corresponding file encoding to UTF-8 BOM (Notepad++ is recommended).
    5.2 Errors in src/tools/vtpipeterm/main.cpp: In addtion, you should also add u8 prefix before string literals with unicode characters, e.g. line 395, 398, 401 and 404.

Workaround

Try build with PR 458 or PR 549, both of them can build successfully.

Installation

Unfortunately, the generated .appx doesn't have any certificates, so it cannot be installed via double-click or powershell, the only way to install is to deploy the solution in VS.

  1. Open Windows Settings - Upgrade & Security - For Developers, switch App sources to Developer mode.
  2. Right click on CascadiaPackage project (under Solution/Terminal), select Deploy Solution to install, then you'll find Windows Terminal (Preview) in start menu.

Settings

After open the terminal, you can't see any menu buttons.

Just press Ctrl + T to open a new tab, and you'll see a drop-down button in the tab bar.

Click it and select Settings, then you can modify the configuration via opened profiles.json.

Add WSL

  1. Create a new session in profiles, with content copied from profiles/cmd.
  2. Give it a new guid.
  3. Give it a new name, such as WSL.
  4. Specify its commandline to wsl.exe.

Then you'll find WSL in the drop-down menu of tab bar.

Here're sample codes:

{
    "guid": "{09dc5eef-6840-4050-ae69-21e55e6a2e62}",
    "name": "WSL",
    "colorscheme": "Campbell",
    "historySize": 9001,
    "snapOnInput": true,
    "cursorColor": "#FFFFFF",
    "cursorShape": "bar",
    "commandline": "wsl.exe",
    "fontFace": "Consolas",
    "fontSize": 12,
    "acrylicOpacity": 0.75,
    "useAcrylic": true,
    "closeOnExit": false,
    "padding": "0, 0, 0, 0"
}
Originally created by @ZgblKylin on GitHub (May 7, 2019). # Tools needed 1. VS2017 or higher with the following packages ("Workloads" tab in Visual Studio Installer) : 1.1 `Desktop Development with C++`. 1.2 `Universal Windows Platform Development`. 1.3 `Windows 10 SDK (10.0.18362.0)`. 1.4 If you're running VS2019, you'll also need to install either `v141 Toolset` or `v142 Toolset`. 2. Git command-line tool. 3. Nuget.exe (Needed in build step 3, can be found in `Terminal/dep/nuget`). # Build Steps 1. `git clone` this repository, not download .zip file. 2. Run `git submodule update --init --recursive` in Terminal folder. 3. Run `nuget restore OpenConsole.sln` (This step can be skipped, then Visual Studio should warn you that there are packages to restore - then restore). 4. Open `OpenConsole.sln` with Visual Studio. 5. Build whole solution(F7) with your platform(`x86`/`x64`) and `release` mode, you may need to fix some build errors: 5.1 C2220 and code page warnings: All errors and warnings are encoding error of unicode characters, a helpful workaround is to modify corresponding file encoding to `UTF-8 BOM` (Notepad++ is recommended). 5.2 Errors in `src/tools/vtpipeterm/main.cpp`: In addtion, you should also add `u8` prefix before string literals with unicode characters, e.g. line `395`, `398`, `401` and `404`. ## Workaround Try build with [PR 458](https://github.com/microsoft/Terminal/pull/458) or [PR 549](https://github.com/microsoft/Terminal/pull/549), both of them can build successfully. # Installation Unfortunately, the generated .appx doesn't have any certificates, so it cannot be installed via double-click or powershell, the only way to install is to deploy the solution in VS. 1. Open `Windows Settings` - `Upgrade & Security` - `For Developers`, switch `App sources` to `Developer mode`. 2. Right click on `CascadiaPackage` project (under `Solution/Terminal`), select `Deploy Solution` to install, then you'll find `Windows Terminal (Preview)` in start menu. # Settings After open the terminal, you can't see any menu buttons. Just press `Ctrl + T` to open a new tab, and you'll see a drop-down button in the tab bar. Click it and select `Settings`, then you can modify the configuration via opened `profiles.json`. ## Add WSL 1. Create a new session in `profiles`, with content copied from `profiles/cmd`. 2. Give it a new `guid`. 3. Give it a new `name`, such as `WSL`. 4. Specify its `commandline` to `wsl.exe`. Then you'll find `WSL` in the drop-down menu of tab bar. Here're sample codes: ```json { "guid": "{09dc5eef-6840-4050-ae69-21e55e6a2e62}", "name": "WSL", "colorscheme": "Campbell", "historySize": 9001, "snapOnInput": true, "cursorColor": "#FFFFFF", "cursorShape": "bar", "commandline": "wsl.exe", "fontFace": "Consolas", "fontSize": 12, "acrylicOpacity": 0.75, "useAcrylic": true, "closeOnExit": false, "padding": "0, 0, 0, 0" } ```
claunia added the Needs-Tag-FixProduct-TerminalIssue-DocsArea-Build labels 2026-01-30 22:00:44 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-Build Issue-Docs Needs-Tag-Fix Product-Terminal
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#723
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?