Skip to content

Guide for build and installation #489

Closed

Description

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

Activity

  1. changed the title [-]Instruction for build new Terminal[/-] [+]Guide for build new Terminal[/+] on May 7, 2019
  2. kev-landry commented on May 7, 2019

    @kev-landry

    Thank you.

  3. yanke1311 commented on May 7, 2019

    @yanke1311

    thanks!

  4. ShrinkWrapper commented on May 7, 2019

    @ShrinkWrapper

    Thanks a bunch!

  5. ecampidoglio commented on May 7, 2019

    @ecampidoglio

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

  6. pavelovcharov commented on May 7, 2019

    @pavelovcharov

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

  7. AregevDev commented on May 7, 2019

    @AregevDev

    Can I build it with VS 2019?

  8. NikolausWeiss commented on May 7, 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

  9. AregevDev commented on May 7, 2019

    @AregevDev

    Same as you

  10. HowBoring commented on May 7, 2019

    @HowBoring

    Can I build it with VS 2019?

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

  11. AregevDev commented on May 7, 2019

    @AregevDev

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

  12. clearcodecn commented on May 7, 2019

    @clearcodecn

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

  13. DarryNobi commented on May 7, 2019

    @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

  14. NikolausWeiss commented on May 7, 2019

    @NikolausWeiss

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

  15. Berrysoft commented on May 7, 2019

    @Berrysoft

    Can I build it with VS 2019?

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

  16. 256 remaining items

  17. DHowett-MSFT commented on Jun 20, 2019

    @DHowett-MSFT
    Contributor

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

  18. simkessy commented on Jun 20, 2019

    @simkessy

    I tried to build and I just got this instead:

    image

  19. musm commented on Jun 20, 2019

    @musm

    I get the same errors. Can anyone help

  20. yzlnew commented on Jun 21, 2019

    @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.

  21. adeloyedeji commented on Jun 22, 2019

    @adeloyedeji

    Adeloye Adedeji (@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.

    winspec1
    winspec2
    winrun

    And I still get a blank screen?

  22. tahasamar commented on Jun 23, 2019

    @tahasamar

    Hey can I install it on Windows 7 ??

  23. MartinJohns commented on Jun 23, 2019

    @MartinJohns

    Mohammad Taha Samarghandi (@tahasamar) You can not. Windows 7 is not a supported platform. You need Windows 10.

  24. DHowett-MSFT commented on Jul 11, 2019

    @DHowett-MSFT
    Contributor

    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!

  25. ghost added
    Needs-Tag-FixDoesn't match tag requirements
    on Jul 11, 2019
  26. xpwn3rx commented on Aug 22, 2019

    @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.

  27. justingoldberg commented on Oct 11, 2019

    @justingoldberg

    Mohammad Taha Samarghandi (@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?

  28. KindDragon commented on Oct 11, 2019

    @KindDragon

    Justin Goldberg (@justingoldberg) Terminal depend on new Windows 10 API

  29. jackluo923 commented on Oct 11, 2019

    @jackluo923

    Justin Goldberg (@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area-BuildIssues pertaining to the build system, CI, infrastructure, metaIssue-DocsIt's a documentation issue that really should be on MicrosoftDocs/Console-DocsNeeds-Tag-FixDoesn't match tag requirementsProduct-TerminalThe new Windows Terminal.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions