Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 39 additions & 20 deletions docs/core/porting/upgrade-assistant-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,55 +4,74 @@
author: adegeo
ms.author: adegeo
ms.topic: install-set-up-deploy
ms.date: 10/08/2024
ms.date: 11/06/2025

#customer intent: As a developer, I want to install .NET Upgrade Assistant so that I can upgrade my projects.

---

# Install .NET Upgrade Assistant

This article teaches you how to install .NET Upgrade Assistant using either the Visual Studio extension or the command-line interface (CLI) tool.
This article teaches you how to enable .NET Upgrade Assistant in Visual Studio or install the tool using the command-line interface (CLI).

[!INCLUDE [github-copilot-suggestion](includes/github-copilot-suggestion.md)]

## Prerequisites

- Windows Operating System
- [Visual Studio 2022 version 17.1 or newer](https://visualstudio.microsoft.com/downloads/).
- [Visual Studio 2022 version 17.14.6 or newer](https://visualstudio.microsoft.com/downloads/).
- [.NET SDK 8 or later](https://dotnet.microsoft.com/download/dotnet/).

> [!IMPORTANT]
> Starting with Visual Studio 2022 17.14.16, the GitHub Copilot app modernization agent is included with Visual Studio. And, the .NET Upgrade Assistant is installed along with that feature. If you're using an older version of Visual Studio 2022, upgrade to the latest release.
>
> If you installed any of the following extensions published by Microsoft, uninstall them before using the version now included in Visual Studio:
>
> - .NET Upgrade Assistant
> - GitHub Copilot App Modernization – Upgrade for .NET
> - Azure Migrate Application and Code Assessment for .NET

## Methods

.NET Upgrade Assistant can be installed as a Visual Studio extension or as a .NET Global Tool.
.NET Upgrade Assistant is available as a feature in Visual Studio and it can be installed as a .NET Global Tool.

The .NET Global Tool is an interactive console application that runs on a solution or project file at or below the current directory.

If you want the streamlined experience of opening a project in Visual Studio and upgrading it, then enable the feature.

## Enable the Visual Studio Feature

The Visual Studio extension runs inside Visual Studio, on the solution or project you have open. The .NET Global Tool is an interactive console application that runs on a solution or project file at or below the current directory.
The following sections are both required to enable the .NET Upgrade Assistant.

If you want the streamlined experience of opening a project in Visual Studio and upgrading it, install the extension.
### Enable the GitHub Copilot app modernization for .NET

## Visual Studio Extension
1. Open the Visual Studio installer

Check failure on line 48 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Hard tabs

docs/core/porting/upgrade-assistant-install.md:48:3 MD010/no-hard-tabs Hard tabs [Column: 3] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md
2. Click the Modify button next to your Visual Studio instance

Check failure on line 49 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Hard tabs

docs/core/porting/upgrade-assistant-install.md:49:3 MD010/no-hard-tabs Hard tabs [Column: 3] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md
3. On the Workloads tab

Check failure on line 50 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Hard tabs

docs/core/porting/upgrade-assistant-install.md:50:3 MD010/no-hard-tabs Hard tabs [Column: 3] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md
1. Find the Installation details outline on the right side of the window

Check failure on line 51 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Ordered list item prefix

docs/core/porting/upgrade-assistant-install.md:51:3 MD029/ol-prefix Ordered list item prefix [Expected: 4; Actual: 1; Style: 1/2/3] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md

Check failure on line 51 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Hard tabs

docs/core/porting/upgrade-assistant-install.md:51:5 MD010/no-hard-tabs Hard tabs [Column: 5] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md

Check failure on line 51 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Inconsistent indentation for list items at the same level

docs/core/porting/upgrade-assistant-install.md:51:1 MD005/list-indent Inconsistent indentation for list items at the same level [Expected: 0; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md
2. Click the arrow to expand the ASP.NET and web development section

Check failure on line 52 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Ordered list item prefix

docs/core/porting/upgrade-assistant-install.md:52:3 MD029/ol-prefix Ordered list item prefix [Expected: 5; Actual: 2; Style: 1/2/3] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md

Check failure on line 52 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Hard tabs

docs/core/porting/upgrade-assistant-install.md:52:5 MD010/no-hard-tabs Hard tabs [Column: 5] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md

Check failure on line 52 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Inconsistent indentation for list items at the same level

docs/core/porting/upgrade-assistant-install.md:52:1 MD005/list-indent Inconsistent indentation for list items at the same level [Expected: 0; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md
3. Click the checkbox to install GitHub Copilot app modernization for .NET

Check failure on line 53 in docs/core/porting/upgrade-assistant-install.md

View workflow job for this annotation

GitHub Actions / lint

Inconsistent indentation for list items at the same level

docs/core/porting/upgrade-assistant-install.md:53:1 MD005/list-indent Inconsistent indentation for list items at the same level [Expected: 0; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md005.md

The following steps install the Visual Studio extension.
![Visual Studio installation details shows GitHub Copilot app modernization for .NET as a feature under the ASP.NET and web development workload](./media/upgrade-assistant-install/visual-studio-modify-workloads.png)

> [!TIP]
> As an alternative to using the **Manage Extensions** feature of Visual Studio, you can download and run the extensions installer from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.upgradeassistant).
When completed successfully. You can open a .NET solution in Visual Studio and will be able to see the Modernize menu option when you right-click a solution in the Solution Explorer.

01. Open Visual Studio.
![Visual Studio solution explorer shows modernize menu after right-click](./media/upgrade-assistant-install/visual-studio-solution-explorer-modernize-menu.png)

If the **Open Recent \ Get Started** window opens, select the **Continue without code** link.
### Enable the .NET Upgrade Assistant in Visual Studio

01. Select the **Extensions** > **Manage Extensions** menu to open the **Extension Manager** window.
01. Select the **Browse** tab.
01. Type **.NET upgrade assistant** into the search box.
01. Select the **.NET Upgrade Assistant** item, and then select **Install**.
1. Click on the Tools -> Options menu item to open the Options window
2. Use the left-side to select Projects and Solutions -> Modernization
3. Select True to Enable legacy Upgrade Assistant

:::image type="content" source="media/upgrade-assistant-install/visual-studio-manage-extensions.png" alt-text="The manage extensions window in Visual Studio, showing the .NET Upgrade Assistant.":::
![Visual Studio tools options dialog shows how to enable the .NET Upgrade Assistant](./media/upgrade-assistant-install/visual-studio-tools-options-enable-legacy-upgrade-assistant.png)

01. Once the extension finishes downloading, close Visual Studio to automatically start the installation.
> [!IMPORTANT]
> You will need to restart Visual Studio for this change to take effect.

:::image type="content" source="media/upgrade-assistant-install/install-prompt.png" alt-text="A prompt to install the .NET Upgrade Assistant extension.":::
When completed successfully. You can open a .NET solution in Visual Studio and will be able to see the Modernize menu option when you right-click a solution in the Solution Explorer.

01. Select **Modify** and follow the instructions to install the extension.
![Visual Studio solution explorer shows upgrade menu after right-click](./media/upgrade-assistant-install/visual-studio-solution-explorer-upgrade-menu.png)

## .NET Global Tool

Expand Down
Loading