-
Notifications
You must be signed in to change notification settings - Fork 138
Add quickstart for local dev/build. update documents #436
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Dinah Xiaoman G (DinahK-2SO)
merged 14 commits into
main
from
user/DinahK-2SO/update-build-docs
Jul 20, 2026
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
61dd6fe
remove submodules instructions; update doc and script to accept vs2026
DinahK-2SO 8071d7a
Merge branch 'main' of github.com:microsoft/intelligent-terminal into…
DinahK-2SO b56009b
quick start reader friendly
DinahK-2SO f872bd4
Potential fix for pull request finding
DinahK-2SO 6bad68b
require VS2026
DinahK-2SO d3ffd88
fix errors
DinahK-2SO 1d1c21a
revert msbuild version limit when searching for msbuild
DinahK-2SO 520b3b2
preferably 2026
DinahK-2SO 4e16306
Merge branch 'main' of github.com:microsoft/intelligent-terminal into…
DinahK-2SO 0e35804
Potential fix for pull request finding
DinahK-2SO 287e87a
Revert "revert msbuild version limit when searching for msbuild"
DinahK-2SO 1caf6da
Merge branch 'user/DinahK-2SO/update-build-docs' of github.com:micros…
DinahK-2SO 1d3ac9d
resolve comments
DinahK-2SO 5196fd9
resolve comments
DinahK-2SO File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Quick start for local development | ||
|
|
||
|
|
||
| The fast path for local development. Intelligent Terminal is a dual-stack project: the Rust | ||
| **WTA** agent (`tools/wta/`) plus the C++ **Windows Terminal** app (`src/`). For command-line | ||
| builds, CI, packaging, and troubleshooting, see [building.md](./building.md). | ||
|
|
||
| ## 1. First-time setup | ||
|
|
||
| **1.1. Install:** | ||
|
|
||
| - **Visual Studio 2026 (18.x)** with the **Desktop development with C++** and **Universal Windows | ||
| Platform development** workloads. | ||
| - **Rust** via [rustup](https://rustup.rs/) (standard rustup; the repo's toolchain pin falls back | ||
| to stable). | ||
|
|
||
| Then open `OpenConsole.slnx` in Visual Studio and click **Install** on the "extra components" | ||
| prompt. It reads `.vsconfig` and adds what the build needs, including **C++ Universal Windows | ||
| Platform tools (Latest MSVC)** (required for `WindowsTerminal` to load; a separate item from the | ||
| UWP workload). NuGet and vcpkg dependencies restore automatically during the build, so that is all | ||
| the setup needed. | ||
|
|
||
| **1.2. Build and run** (two build systems, in order): | ||
|
|
||
| 1. Build the Rust agent: | ||
| `cargo build --target <the target triple> --manifest-path <the toml file>` | ||
|
|
||
| For instance, | ||
| ```powershell | ||
| cargo build --target x86_64-pc-windows-msvc --manifest-path tools/wta/Cargo.toml | ||
| ``` | ||
| 2. In Visual Studio: | ||
| - Set startup project: **`CascadiaPackage`** | ||
| - Select platform, **x64** for instance. | ||
| - Go to `CascadiaPackage` > Properties > Debug: set **Application process** and **Background task | ||
| process** to **Native Only** | ||
| - Run (**F5**) | ||
|
|
||
| F5 builds the app, deploys, and launches Windows Terminal (Dev) with the debugger attached. The | ||
| first build is slow; later ones are incremental. | ||
|
|
||
| ## 2. After changing code | ||
|
|
||
| | Changed | Do this | | ||
| |---------|---------| | ||
| | **Rust** (`tools/wta/`) | Rebuild via `cargo build`. For instance,<br>`cargo build --target x86_64-pc-windows-msvc --manifest-path tools/wta/Cargo.toml` | | ||
| | **C++** (`src/`) | Press **F5** in Visual Studio | | ||
|
|
||
| `cargo build` is incremental (seconds for a small change). To see a WTA change inside the running | ||
| Terminal (agent pane, autofix), press **F5** afterward so the new `wta.exe` is copied in. | ||
|
|
||
| > If a rebuild reports `wta.exe` in use, stop the running instance first: close the Dev Terminal, | ||
| > or run `taskkill /f /im wta.exe`. | ||
|
|
||
| ## 3. Running tests | ||
|
|
||
| | Side | Command | | ||
| |------|---------| | ||
| | **Rust** | `cargo test --manifest-path tools/wta/Cargo.toml` | | ||
| | **C++** (TAEF) | `runut.cmd` (unit), `runft.cmd` (feature), `runuia.cmd` (UIA), from a dev environment | | ||
|
|
||
| Run one C++ test with `te.exe <Tests.dll> /name:<pattern>`. See [building.md](./building.md) for | ||
| the dev environment and [TAEF.md](./TAEF.md) for details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.