1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Files
docs/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio.md
Jules Parker ebc0192b14 use reusables
2022-06-15 13:29:20 +02:00

6.5 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

Authorizing {% data variables.product.prodname_copilot %}

  1. Create a new C# Console App project. For more information, see steps 1 and 2 in "Tutorial: Create a simple C# console app in Visual Studio" in the Microsoft Visual Studio documentation.
  2. Name your project "Copilot Demo" and click Next. Screenshot of the new project window with the project name emphasized
  3. Click Create to create the project. Screenshot of the new project window with the "create" button emphasized
  4. To copy your device activation code, in the dialog box about authorizing {% data variables.product.prodname_copilot %}, click OK. Screenshot of the popup with the message to active your connection to GitHub
  5. A device code will be copied automatically to the clipboard. Paste it on the {% data variables.product.company_short %} device authorization page that will open. If you miss the device code, you will find it in the status bar, at the bottom left of {% data variables.product.prodname_vs %}, as well as on the {% data variables.product.prodname_copilot %} output window pane.
  6. After successful authorization, proceed to read and approve the {% data variables.product.prodname_copilot %} Telemetry Terms. Screenshot of the GitHub Copilot Telemetry Terms popup with "yes" button emphasized

After installation, a {% data variables.product.prodname_copilot %} icon will appear within the margin for the editor, in the lower-left corner of your {% data variables.product.prodname_vs %} window.

Screenshot of editor margin in Visual Studio with the GitHub Copilot icon emphasized

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