-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Copilot cli support doc #54110
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
Merged
Copilot cli support doc #54110
Changes from 15 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
a3050b1
Rewrite Copilot CLI support doc for plugin-based modernization
d049ff4
Scope Copilot CLI doc to .NET only
2dbc269
Remove unused screenshots from old Copilot CLI doc
5588f88
Add /agent selection method for setting the modernization agent
4a4dfed
Fix IMPORTANT callout wording for agent selection
47c2077
Rename .NET modernization to .NET migration to Azure in capabilities …
594f019
Address PR review comments
020f22f
Reorder TOC and rename assessment title
792c744
Add Copilot CLI plugin tab to quickstart doc
f8c7031
Add (Preview) tag to Copilot CLI doc titles
dfe6ae3
joint work with azure storage team
sonwan2020 5767fe9
single line
sonwan2020 25d19cb
Merge pull request #3 from Caoxuyang/sonwan/add-storage-blob-words
sonwan2020 5a548f7
Remove (Preview) tag from Copilot CLI doc titles
0d0c658
Editorial fixes
alexwolfmsft fcd1ba5
Apply suggestions from code review
alexwolfmsft f164a91
edit pass
alexwolfmsft 754e033
fixes
alexwolfmsft 712f51b
Fix zone pivots
alexwolfmsft 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
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
125 changes: 125 additions & 0 deletions
125
docs/azure/migration/appmod/includes/quickstart-copilot-cli.md
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,125 @@ | ||
| --- | ||
| ms.topic: include | ||
| ms.date: 05/22/2026 | ||
| author: alexwolfmsft | ||
| ms.author: alexwolf | ||
| ms.reviewer: alexwolf | ||
| title: GitHub Copilot modernization in Copilot CLI | ||
| description: Learn how to assess .NET app readiness and migrate to Azure with GitHub Copilot modernization plugin in Copilot CLI. Follow step-by-step guidance for seamless modernization. | ||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A GitHub account with an active [GitHub Copilot](https://github.com/features/copilot) subscription under any plan. | ||
| - [Copilot CLI](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) installed. | ||
|
|
||
| ## Install the plugin | ||
|
|
||
| 1. In a terminal, run `copilot` to start Copilot CLI. | ||
|
|
||
| ```bash | ||
| copilot | ||
| ``` | ||
|
|
||
| 1. Add the marketplace and install the plugin: | ||
|
|
||
| ```bash | ||
| copilot plugin marketplace add microsoft/github-copilot-modernization | ||
| copilot plugin install github-copilot-modernization@github-copilot-modernization | ||
| ``` | ||
|
|
||
| 1. Verify the plugin is installed: | ||
|
|
||
| ```text | ||
| /plugin list | ||
| ``` | ||
|
|
||
| You should see `github-copilot-modernization` in the list. | ||
|
|
||
| ## Assess app readiness | ||
|
|
||
| GitHub Copilot modernization assessment helps you find app readiness challenges, learn their impact, and see recommended migration tasks. | ||
|
|
||
| 1. Clone the [.NET migration copilot samples](https://github.com/Azure-Samples/dotnet-migration-copilot-samples) repository to your computer. | ||
|
|
||
| 1. Navigate to the **Contoso University** project folder: | ||
|
|
||
| ```bash | ||
| cd dotnet-migration-copilot-samples/ContosoUniversity | ||
| ``` | ||
|
|
||
| 1. Start Copilot CLI with the modernization agent: | ||
|
|
||
| ```bash | ||
| copilot --agent=github-copilot-modernization:modernize | ||
| ``` | ||
|
alexwolfmsft marked this conversation as resolved.
|
||
|
|
||
| > [!IMPORTANT] | ||
| > You must select the `github-copilot-modernization:modernize` agent before running any modernization prompts. If you're already in a Copilot CLI session, use `/agent` and select `github-copilot-modernization:modernize` from the list. | ||
|
|
||
| 1. Ask the agent to assess the application: | ||
|
|
||
| ```text | ||
| copilot> modernize my application | ||
| ``` | ||
|
|
||
| The agent automatically starts the assessment phase and analyzes your project for migration readiness—including dependencies, frameworks, and Azure migration opportunities. | ||
|
|
||
| 1. When the assessment finishes, the agent presents a summary of findings and asks: **"Proceed to planning?"** | ||
|
|
||
| ## Migrate your app | ||
|
|
||
| After reviewing the assessment, continue through the planning and execution phases. | ||
|
|
||
| ### Full modernization (assess → plan → execute) | ||
|
|
||
| The agent runs the complete workflow automatically when you confirm each phase: | ||
|
|
||
| 1. **Assessment** → Review findings → Confirm to proceed | ||
| 1. **Planning** → The agent generates a migration plan (`plan.md`) → Review and confirm | ||
| 1. **Execution** → The agent routes tasks to specialized executor agents that apply code changes, run builds, and validate results | ||
|
alexwolfmsft marked this conversation as resolved.
Outdated
|
||
|
|
||
| The agent handles everything—just confirm at each checkpoint. | ||
|
|
||
| ### Specific migration task | ||
|
|
||
| If you already know what you want to migrate, skip the assessment and go straight to execution: | ||
|
|
||
| ```text | ||
| copilot> migrate from local SQL Server to Azure SQL Database | ||
| ``` | ||
|
|
||
| For multiple tasks, list them: | ||
|
|
||
| ```text | ||
| copilot> migrate from RabbitMQ to Azure Service Bus and upgrade to .NET 9 | ||
| ``` | ||
|
|
||
| ### Unattended execution | ||
|
|
||
| For fully autonomous execution without prompts, use the `--allow-all` flag: | ||
|
|
||
| ```bash | ||
| copilot --agent=github-copilot-modernization:modernize --allow-all | ||
| ``` | ||
|
|
||
| ### Enterprise rulebook | ||
|
|
||
| To embed modernization policies, place Markdown files in the `.github/modernize/rulebook/` directory. During the planning phase, rulebook constraints merge with assessment results—rulebook policies take precedence over assessment recommendations. | ||
|
|
||
| For more information, see [Migrate .NET apps to Azure using GitHub Copilot modernization in Copilot CLI](../copilot-cli-support.md#define-enterprise-modernization-policies). | ||
|
alexwolfmsft marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Validation | ||
|
|
||
| After the agent applies code changes, it runs validation checks: | ||
|
|
||
| 1. Builds the project and resolves any build errors. | ||
| 1. Detects Common Vulnerabilities and Exposures (CVEs) in dependencies and fixes them. | ||
| 1. Runs tests and fixes any failures. | ||
|
|
||
| After all validation checks pass, the agent generates a summary. Review the results and verify: | ||
|
|
||
| ```bash | ||
| dotnet build | ||
| dotnet test | ||
| ``` | ||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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
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.