Guide for build and installation

[ZgblKylin]

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"
}

[kev-landry]

Thank you.

[yanke1311]

thanks!

[ShrinkWrapper]

Thanks a bunch!

[ecampidoglio]

This information should be included in the Building the Code section of the README file.

[pavelovcharov]

Windows 1903 is required to deploy Windows Terminal
#437 (comment)

[AregevDev]

Can I build it with VS 2019?

[NikolausWeiss]

Can I build it with VS 2019?

I've been trying for a few hours with no success. I have given up and am currently installing VS 2017

[AregevDev]

Same as you

[HowBoring]

Can I build it with VS 2019?

I'm afraid you can't, I have got 23 FAILED to build with VS2019...

[AregevDev]

Thanks! I am installing VS2017, can't wait to try the new Terminal out!

[clearcodecn]

hello. can I download the binary file of you build ? I don`t want to build it . no environment . 😆

[DarryNobi]

Can I build it with VS 2019?

I've been trying for a few hours with no success. I have given up and am currently installing VS 2017

Me, neither. Better try on VS2017 directly. \cry

[NikolausWeiss]

There is a pull request for a branch that fixes the VS 2019 errors: #449

[Berrysoft]

Can I build it with VS 2019?

Yes, with hours of patience, and fixing many bugs.

[noobhacker]

There is a pull request for a branch that fixes the VS 2019 errors: #449

That single line of code worked for me in VS2019. I'm now installing insider build to get to 1903 or above.

[ob1231]

what dos the 'solution' mean exactly in step5, i'm new here

[pulimento]

So, still, you need an insider build, right?

[Berrysoft]

what dos the 'solution' mean exactly in step5, i'm new here

The solution (top one) in the Solution Explorer.

[noobhacker]

what dos the 'solution' mean exactly in step5, i'm new here

[AregevDev]

I successfully built it, but wanted to ask, are all the features shown in the video implemented? I can only see the new UWP based console

[ob1231]

what dos the 'solution' mean exactly in step5, i'm new here

thanks a lot

[Aarklendoia]

To compile, you also need to install the "Universal Windows Platform Tools" (not installed by default).

For me, TerminalCore and Unittests_TerminalCode can't be loaded, I don't know why. The file common.build.pre.props can't be loaded...

[martinmine]

This should be in the readme.md-file, maybe you should open a PR for this @ZgblKylin ? :)

[zhouchaoyuan]

========== Build: 0 succeeded, 45 failed, 2 up-to-date, 0 skipped ==========

[joj]

Is there a way to do that from command prompt? /t:Deploy doesn't do anything on the solution.

[hjc2024]

Thanks! I am installing VS2017, can't wait to try the new Terminal out!

hope you have succeed, I am doing this now (I have spend half a day on VS2019 )

[noobhacker]

To peoples who really want to try out but failed to build:
#468 (comment)

[Mika-Lahtinen]

When I used Git bash，I was told bash：nuget：command not found
How to solve it？

[AdrianoCahete]

Also I noticed some people deploy the project in debug mode, while others deployed it in release mode?
What's the consensus regarding this?

In my understanding, there's no directly difference for your self use. Debug mode can contain some symbols and be a little bigger, when Release mode can be smaller since the deploy can run some improvements/optimization tasks.

But I really don't think that is something really different in that alpha stage.

[Byloth]

Hi, everybody!
I'm trying to run this new Windows Terminal.

After some difficulties and a few attempts I was able to build and deploy the project locally.
«Great! Finally!» I said to myself, just before clicking on the Windows Terminal (Dev Build) in the Start menu...

This was the result: an empty window.

After a few seconds, it simply disappeared and then...
Well... Nothing more!

---

I read some comments (like this one #489 (comment)) and tried to delete any profiles.json files but nothing has changed.

Any other ideas?
Thank you all!

---

Here are some useful (hopefully) information about my current system:

Windows 10 1903 Build 18362.175
Developer mode enabled
Visual Studio 2019
Repo version built: v0.1.1621.0 (6fc0978)

---

🚀 I recently opened the Issue #1364 related to this problem.

If you're experiencing the same behaviour, you can find here some other detailed information about it.

[pistons-2004]

Could you please unsubscribe me from all of these threads. Its overwhelming From: Matteo Bilotta <notifications@github.com> Sent: Friday, June 14, 2019 7:07 AM To: microsoft/terminal <terminal@noreply.github.com> Cc: Subscribed <subscribed@noreply.github.com> Subject: Re: [microsoft/terminal] Guide for build and installation (#489) Hi, everybody! I'm trying to run this new Windows Terminal. After some difficulties and a few attempts I was able to build and deploy the project locally. «Great! Finally!» I said to myself, just before clicking on the Windows Terminal (Dev Build) in the Start menu... This was the result: an empty window. [image]<https://gcc01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fuser-images.githubusercontent.com%2F14953974%2F59504305-f5ba8a80-8ea2-11e9-929f-4a56104b77b9.png&data=02%7C01%7Cbugbeed%40michigan.gov%7C5cefc88d219d4eb64b9408d6f0b87147%7Cd5fb7087377742ad966a892ef47225d1%7C0%7C0%7C636961072290405684&sdata=rMk46apT2apEI8kTsaiuyBacg61ZqgwUQVX0NwnMV1s%3D&reserved=0> After a few seconds, it simply disappeared and then... Well... Nothing more!

…

________________________________ I read some comments (like this one #489 (comment)<https://gcc01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fterminal%2Fissues%2F489%23issuecomment-492177267&data=02%7C01%7Cbugbeed%40michigan.gov%7C5cefc88d219d4eb64b9408d6f0b87147%7Cd5fb7087377742ad966a892ef47225d1%7C0%7C0%7C636961072290415692&sdata=YGfemyxYCdZBtD%2F3U1bAaczZeJG2pAHV7IKrrANLMh4%3D&reserved=0>) and tried to delete any profiles.json files but nothing has changed. Any other ideas? Thank you all!

________________________________ Here are some useful (hopefully) information about my current system: Windows 10 1903 Build 18362.175 Visual Studio 2019 Repo version built: v0.1.1621.0 (6fc0978<https://gcc01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fterminal%2Fcommit%2F6fc0978ddb41a7276aa965dba70df49a13d2ab56&data=02%7C01%7Cbugbeed%40michigan.gov%7C5cefc88d219d4eb64b9408d6f0b87147%7Cd5fb7087377742ad966a892ef47225d1%7C0%7C0%7C636961072290425701&sdata=ubqTm0Wa9xzJL8Jsf6tKDSmCMntRxafIPOoazPnEPFg%3D&reserved=0>) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub<https://gcc01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fterminal%2Fissues%2F489%3Femail_source%3Dnotifications%26email_token%3DAMAAYZOTXBHT35VESGFBKWLP2N3VXA5CNFSM4HLHRKI2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODXWPDOQ%23issuecomment-502067642&data=02%7C01%7Cbugbeed%40michigan.gov%7C5cefc88d219d4eb64b9408d6f0b87147%7Cd5fb7087377742ad966a892ef47225d1%7C0%7C0%7C636961072290425701&sdata=nsmHbdfbQJhW0qHQegsCU8w9tlriwrsTe5oNColnKoU%3D&reserved=0>, or mute the thread<https://gcc01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAMAAYZICWRIFMDKMHSUHM7LP2N3VXANCNFSM4HLHRKIQ&data=02%7C01%7Cbugbeed%40michigan.gov%7C5cefc88d219d4eb64b9408d6f0b87147%7Cd5fb7087377742ad966a892ef47225d1%7C0%7C0%7C636961072290435709&sdata=3LVEYEzkxE09SC1RZImkCT8%2BTptEPSQlWB3hI3s6xoA%3D&reserved=0>.

[AdrianoCahete]

Could you please unsubscribe me from all of these threads. Its overwhelming

You're automatic subscribed if you comment or subscribe to issue.
You need to enter in the issue Github page, go to the right sidebar, on the Notification button, change to "Custom" or click on "Unsubscribe".

But remember that every time that you comment on a issue, you'll be auto subscribed again.

[rdevraj950]

1. Open Windows Settings - Upgrade & Security - For Developers, switch App sources to Developer mode

Upgrade & Security should be Update & Security

[adeloyedeji]

1. Open Windows Settings - Upgrade & Security - For Developers, switch App sources to Developer mode

Upgrade & Security should be Update & Security

This didn't work for me. Still loading blank screen

[ihdavids]

I had it running.
I am an avid emacs user and was excited at the prospect of this + WSL 2.
A little bit of tinkering and I had it building and running but I found it really bogs down on my surface. There are quite a few instances of WSL running after a little experimentation which I found a little surprising given I didn't have any tabs running WSL at that point.

I am also now unable to launch the terminal after changing the font and scheme now and it fails to launch every time. We are far from stable it seems. :(

[mKay00]

Of course it still takes time, but you are welcome to contribute 😉
Maybe you can try to figure out, why there are instances of WSL running although you have no tabs open.

If you are unable to open after you made changes in the settings, you probably corrupted your profiles.json. Go to "%LOCALAPPDATA%\packages\WindowsTerminalDev_8wekyb3d8bbwe\RoamingState" and delete your profiles.json to regenerate a new one with default settings.

[musm]

Now getting

[DHowett-MSFT]

@adeloyedeji if you are seeing a blank screen, make sure you are targeting the right architecture. you cannot run windows terminal x86 on an x64 machine.

[ihdavids]

Of course it still takes time, but you are welcome to contribute 😉
Maybe you can try to figure out, why there are instances of WSL running although you have no tabs open.

If you are unable to open after you made changes in the settings, you probably corrupted your profiles.json. Go to "%LOCALAPPDATA%\packages\WindowsTerminalDev_8wekyb3d8bbwe\RoamingState" and delete your profiles.json to regenerate a new one with default settings.

Yup,
I made a typo in the font name! Thank you!

[ihdavids]

With each WSL tab I open and then close there does seem to be something left behind. I currently have closed all WSL tabs and I am seeing the following in the process list?

[DHowett-MSFT]

@ihdavids The "WSL Background Host" processes are kept around for some time to support WSL background scenarios. This is not exactly a Terminal issue.

[simkessy]

I tried to build and I just got this instead:

[musm]

I get the same errors. Can anyone help

[yzlnew]

It seems that we can get a preview build in mid-June. Is this still on track for a pre-release?
Edit: You can download it form the Microsoft Store now.

[adeloyedeji]

@adeloyedeji if you are seeing a blank screen, make sure you are targeting the right architecture. you cannot run windows terminal x86 on an x64 machine.

And I still get a blank screen?

[tahasamar]

Hey can I install it on Windows 7 ??

[MartinJohns]

@tahasamar You can not. Windows 7 is not a supported platform. You need Windows 10.

[DHowett-MSFT]

Many of our build and installation issues have been resolved since we moved to Visual Studio 2019 and the newest SDK. This bug is a great archive of our old build problems, but I'm going to close it because I think it's served its purpose. Thanks everyone for the reports!

[xpwn3rx]

I can no longer open the program. I have been running builds since a couple days after the source was released. I tried uninstalling and deleting the profile.json files, and the entire folder for the dev version. I also uninstalled the released version (from the store). I am on 18963.1000 insider preview build. I've tried updating source and rebuilding multiple times. The program crashes with this information in the event viewer.

Fault bucket 1289599514809151433, type 5
Event Name: MoBEX
Response: Not available
Cab Id: 0

Problem signature:
P1: WindowsTerminalDev_0.0.1.0_x64__8wekyb3d8bbwe
P2: praid:App
P3: 0.0.0.0
P4: 5d5ed050
P5: ucrtbase.dll
P6: 10.0.18963.1000
P7: afa25d02
P8: 00000000000714ae
P9: c0000409
P10: 0000000000000007

Attached files:
\?\C:\ProgramData\Microsoft\Windows\WER\Temp\WER4461.tmp.mdmp
\?\C:\ProgramData\Microsoft\Windows\WER\Temp\WER46B4.tmp.WERInternalMetadata.xml
\?\C:\ProgramData\Microsoft\Windows\WER\Temp\WER46C5.tmp.xml
WPR_initiated_DiagTrackMiniLogger_OneTrace User Logger 20190808 1 Event Collector_0_inject.etl
\?\C:\Users\username\AppData\Local\Temp\WER4704.tmp.etl
WPR_initiated_DiagTrackMiniLogger_WPR System Collector_inject.etl
\?\C:\Users\username\AppData\Local\Temp\WER4715.tmp.etl
\?\C:\ProgramData\Microsoft\Windows\WER\Temp\WER4711.tmp.csv
\?\C:\ProgramData\Microsoft\Windows\WER\Temp\WER477F.tmp.txt

These files may be available here:
\?\C:\ProgramData\Microsoft\Windows\WER\ReportArchive\AppCrash_WindowsTerminalD_3c51dde5976618279e5030b5b28a6694657054_a3463a88_ca0aacc6-5135-4050-9eef-60ec5d5348b5

Analysis symbol:
Rechecking for solution: 0
Report Id: 58849b5b-6947-47e5-a83f-e0488d271f72
Report Status: 268435456
Hashed bucket: f6539afacf462710c1e593ed16b72fc9
Cab Guid: 0

I have also tried deleting my source directory and running through the steps to grab it from GIT and init the submodules.

[justingoldberg]

@tahasamar You can not. Windows 7 is not a supported platform. You need Windows 10.

Can / will it be ported to windows 7? Or should we stick with ConEmu/CMDer?

[KindDragon]

@justingoldberg Terminal depend on new Windows 10 API

[jackluo923]

@justingoldberg Use fluent terminal, since it supports pretty much all the MS terminal's functionality (i.e. supports Bash, PowerShell, WSL, cmder and any other ConEMU stuff all at the same time). You won't get WSL though because that's a Win10 feature, but connecting cygwin, docker, ubuntu VM, remote ssh terminals shouldn't be a problem. A the current state, it looks prettier than MS terminal and is based on the same "xterm.js" framework.