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-code.md
Jules Parker ebc0192b14 use reusables
2022-06-15 13:29:20 +02:00

7.0 KiB

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

About {% data variables.product.prodname_copilot %} and {% data variables.product.prodname_vscode %}

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

If you use {% data variables.product.prodname_vscode %}, 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_vscode %} for macOS, Windows, or Linux.

Prerequisites

To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must have {% data variables.product.prodname_vscode %} installed. For more information, see the {% data variables.product.prodname_vscode %} download page.

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

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

  1. In the {% data variables.product.prodname_vscode %} Marketplace, go to the {% data variables.product.prodname_copilot %} extension page and click Install. Install {% data variables.product.prodname_copilot %} extension {% data variables.product.prodname_vscode %}
  2. A popup will appear, asking to open {% data variables.product.prodname_vscode %}. Click Open {% data variables.product.prodname_vscode %}.
  3. In the "Extension: {% data variables.product.prodname_copilot %}" tab in {% data variables.product.prodname_vscode %}, click Install. Install button in {% data variables.product.prodname_vscode %}
  4. If you have not previously authorized {% data variables.product.prodname_vscode %} in your {% data variables.product.prodname_dotcom %} account, you will be prompted to sign in to {% data variables.product.prodname_dotcom %} in {% data variables.product.prodname_vscode %}.
    • If you have previously authorized {% data variables.product.prodname_vscode %} in your {% data variables.product.prodname_dotcom %} account, {% data variables.product.prodname_copilot %} will be automatically authorized. Screen shot of {% data variables.product.prodname_vscode %} authorization screen
  5. In your browser, {% 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_vscode %}. To refuse the permissions, click Cancel.
  6. In {% data variables.product.prodname_vscode %}, in the "{% data variables.product.prodname_vscode %}" dialogue box, to confirm the authentication, click Open. To cancel the authentication, click Cancel.

Seeing your first suggestion

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

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

  1. In the JavaScript 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 {% data variables.product.prodname_vscode %} {% data reusables.copilot.accept-suggestion %}

Seeing alternative suggestions

{% data reusables.copilot.alternative-suggestions %}

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

  1. In the JavaScript file, type the following function header. {% data variables.product.prodname_copilot %} will show you a suggestion.
function calculateDaysBetweenDates(begin, end) {

{% data reusables.copilot.see-alternative-suggestions %}

OS See next suggestion See previous suggestion
macOS Option (⌥) or Alt+] Option (⌥) or Alt+[
Windows Alt+] Alt+[
Linux Alt+] Alt+[
  1. Alternatively, 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 %}

Seeing multiple suggestions in a new tab

{% data reusables.copilot.suggestions-new-tab %}

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

  1. In the JavaScript file, type the following function header. {% data variables.product.prodname_copilot %} will show you a suggestion.
function calculateDaysBetweenDates(begin, end) {
  1. To open a new tab with multiple additional options, press Ctrl+Enter.
  2. To accept a suggestion, above the suggestion, click Accept Solution. To reject all suggestions, close the tab.

Generating code suggestions from comments

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

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

  1. In the JavaScript file, type the following comment. {% data variables.product.prodname_copilot %} will suggest an implementation of the function.
    // find all images without alternate text
    // and give them a red border
    function process() {
    

Using a framework

You can also use {% data variables.product.prodname_copilot %} to generate suggestions for APIs and frameworks. The following example uses {% data variables.product.prodname_copilot %} to create a simple Express server that returns the current time.

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

  1. In the JavaScript file, type the following comment and then press Enter.
    // Express server on port 3000
    
    {% data variables.product.prodname_copilot %} will suggest an implementation of the Express app.
  2. To accept each line, press Tab, then Enter.
  3. Type the following comment and then press Enter. {% data variables.product.prodname_copilot %} will suggest an implementation for the default handler.
    // Return the current time
    
  4. To accept each line, press Tab.

{% data reusables.copilot.enabling-and-disabling-in-vsc %}

Further reading