1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Files
docs/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio.md
2022-06-15 15:08:27 +02:00

5.4 KiB

title, shortTitle, product, intro, versions, topics
title shortTitle product intro versions topics
Getting started with GitHub Copilot in Visual Studio Visual Studio {% data reusables.gated-features.copilot %} Learn how to install {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, and start seeing suggestions as you write comments and code.
feature
copilot
Copilot

About {% data variables.product.prodname_copilot %} and Visual Studio

{% data reusables.copilot.procedural-intro %}

If you use {% data variables.product.prodname_vs %}, you can view and incorporate suggestions from {% data variables.product.prodname_copilot %} directly within the editor. This guide demonstrates how to use {% data variables.product.prodname_copilot %} within {% data variables.product.prodname_vs %} for Windows.

Prerequisites

To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have {% data variables.product.prodname_vs %} 2022 17.1 or later installed. For more information, see the Visual Studio IDE documentation.

{% note %}

Note: {% data variables.product.prodname_copilot %} is not currently available for use with Visual Studio for Mac.

{% endnote %}

Installing the {% data variables.product.prodname_vs %} extension

To use {% data variables.product.prodname_copilot %}, you must first install the {% data variables.product.prodname_vs %} extension.

  1. In the Visual Studio toolbar, under Extensions, click Manage Extensions. Screenshot of the Visual Studio toolbar
  2. In the "Manage Extensions" dialogue, click Visual Studio Marketplace, search for the {% data variables.product.prodname_copilot %} extension and click Download. Screenshot of GitHub Copilot extension for Visual Studio with the download button emphasized
  3. Close the "Manage Extensions" dialog, then exit and relaunch {% data variables.product.prodname_vs %}.
  4. Optionally, to check that {% data variables.product.prodname_copilot %} is installed and enabled, go back to Manage Extensions, click Installed to view your currently installed extensions and click {% data variables.product.prodname_copilot %} to see status information. Screenshot of installed extensions in Visual Studio with GitHub Copilot emphasized
  5. Open or create a new project in {% data variables.product.prodname_vs %}.
  6. In the "Microsoft {% data variables.product.prodname_vs %}" dialogue box, to copy your device activation code, click OK. Screenshot of the Microsoft {% data variables.product.prodname_vs %} dialogue box
  7. A device activation window will open in your browser. Press Ctrl+V to paste the device code and click Continue.
  8. {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click Authorize {% data variables.product.prodname_copilot %} Plugin To refuse the permissions, click Cancel.
  9. Once the permissions have been approved, {% data variables.product.prodname_vs %} will show a confirmation. Screenshot of {% data variables.product.prodname_vs %} permissions confirmation

Seeing your first suggestion

{% data reusables.copilot.supported-languages %} The following samples are in C#, but other languages will work similarly.

{% data reusables.copilot.create-c-file %}

  1. In the C# file, type the following function header. {% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text, as shown below. The exact suggestion may vary.
function calculateDaysBetweenDates(begin, end) {

Screenshot of a first suggestion Visual Studio Code {% data reusables.copilot.accept-suggestion %}

Seeing alternative suggestions

{% data reusables.copilot.alternative-suggestions %} {% data reusables.copilot.create-c-file %}

  1. In the C# file, type the following function header. {% data variables.product.prodname_copilot %} will show you a suggestion.
  function calculateDaysBetweenDates(begin, end) {
  1. If alternative suggestions are available, you can see these alternatives by pressing Alt+] (or Alt+[).
  2. Optionally, you can hover over the suggestion to see the {% data variables.product.prodname_copilot %} command palette for choosing suggestions. {% data reusables.copilot.accept-or-reject-suggestion %}

Generating code suggestions from comments

{% data reusables.copilot.generating-suggestions-from-comments %}

{% data reusables.copilot.create-c-file %}

  1. In the C# file, type the following comment. {% data variables.product.prodname_copilot %} will suggest an implementation of the function.
    using System.Xml.Linq;
    
    var doc = XDocument.Load("index.xhml");
    
    // find all images
    

{% data reusables.copilot.accept-suggestion %}

{% data reusables.copilot.enabling-and-disabling-vs %}

Further reading