1
0
mirror of synced 2025-12-30 21:02:34 -05:00
Files
docs/content/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide.md
2024-02-22 12:43:51 +00:00

23 KiB

title, intro, topics, redirect_from, defaultTool, versions, shortTitle
title intro topics redirect_from defaultTool versions shortTitle
Using GitHub Copilot Chat in your IDE You can start using {% data variables.product.prodname_copilot_chat %} by installing the extension in your preferred environment.
Copilot
/copilot/github-copilot-chat/using-github-copilot-chat
vscode
feature
copilot
Using Copilot Chat

{% vscode %}

{% note %}

Important:

{% data reusables.gated-features.copilot-chat-callout %}

{% endnote %}

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

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

Prerequisites

{% data reusables.copilot.chat-subscription-prerequisite %}

  • To use {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vscode %}, you must have the latest version of {% data variables.product.prodname_vscode %} installed. For more information, see the {% data variables.product.prodname_vscode %} download page.

  • To use {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vscode %}, you must be signed into {% data variables.product.prodname_vscode %} with the same {% data variables.product.prodname_dotcom %} ID that has access to {% data variables.product.prodname_copilot %}.

Enabling or disabling {% data variables.product.prodname_copilot_chat %}

{% data reusables.copilot.enabling-or-disabling-copilot %}

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

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

  1. In {% data variables.product.prodname_vscode %}, open the Extensions view by clicking the Extensions icon in the activity bar on the left side of the {% data variables.product.prodname_vscode %} window.

    Screenshot of the extensions icon in the Activity Bar.

  2. In the "Search Extensions in Marketplace" search box, search for the {% data variables.product.prodname_copilot_chat %} extension, then click Install.

    Screenshot of the {% data variables.product.prodname_copilot_chat %} extension in the Extensions Marketplace.

  3. In the {% data variables.product.prodname_vscode %} window, click Reload required to update {% data variables.product.prodname_vscode %}.

  4. If you are prompted to sign in by a toast notification in the bottom right corner of {% data variables.product.prodname_vscode %}, click Sign in to {% data variables.product.prodname_dotcom %}. Sign in with the same {% data variables.product.prodname_dotcom %} ID that has a license for {% data variables.product.prodname_copilot %}, or is assigned a seat for {% data variables.product.prodname_copilot %} through an organization.

  5. Follow the prompts in {% data variables.product.prodname_vscode %} and on {% data variables.product.prodname_dotcom %} in your browser to complete the sign in and authentication process.

  6. To confirm that {% data variables.product.prodname_copilot_chat %} has been successfully installed, in the activity bar on the left side of the {% data variables.product.prodname_vscode %} window, click the {% data variables.product.prodname_copilot_chat %} icon to open the {% data variables.product.prodname_copilot_chat %} chat window.

    Screenshot of the {% data variables.product.prodname_copilot_chat %} icon in the Activity Bar.

{% note %}

Note: If you experience authentication issues after installing the extension, see "AUTOTITLE."

{% endnote %}

Asking your first question

{% data reusables.copilot.copilot-chat-exclusively-code-questions %}

  1. In the {% data variables.product.prodname_vscode %} activity bar, click the {% data variables.product.prodname_copilot_chat %} icon to open the {% data variables.product.prodname_copilot_chat %} chat window.

    Screenshot of the {% data variables.product.prodname_copilot_chat %} icon in the Activity Bar.

  2. At the bottom of the {% data variables.product.prodname_copilot_chat %} window, in the Ask {% data variables.product.prodname_copilot_short %} a question or type / for topics text box, type a coding-related question, then press Enter. For example, type "How do I write a function that returns the sum of two numbers?".

  3. {% data variables.product.prodname_copilot_chat %} will process your question and provide an answer, with code suggestions when appropriate, in the chat window.

    If your question is outside the scope of {% data variables.product.prodname_copilot_chat %}, it will tell you and may suggest an alternative question to ask.

  4. Optionally, if {% data variables.product.prodname_copilot_chat %} suggests a follow-up question above the Ask {% data variables.product.prodname_copilot_short %} a question or type / for topics text box, click the follow-up question to ask it.

Using code suggestions from {% data variables.product.prodname_copilot_chat %}

When {% data variables.product.prodname_copilot_chat %} provides code suggestions, you have a few options for how to use them.

  1. In the {% data variables.product.prodname_copilot_chat %} window, to show the options for a code suggestion, hover over the suggestion.

    Screenshot of code suggestion options in the {% data variables.product.prodname_copilot_chat %} window.

  2. Choose one of the options for using the code suggestion.

    • To copy the code suggestion to your clipboard, click the Copy icon.
    • To insert the code suggestion into your code at the current location of your cursor, click the Insert at Cursor icon.
    • To view additional options, click the ... icon.
      • To create a new file and insert the suggestion into it, click Insert Into New File.
      • To run the code suggestion in the {% data variables.product.prodname_vscode %} terminal, click Run in Terminal.

Asking {% data variables.product.prodname_copilot_chat %} questions about your code

{% data variables.product.prodname_copilot_chat %} can provide answers and support with a wide range of coding related topics.

  1. In {% data variables.product.prodname_vscode %}, open the file you want {% data variables.product.prodname_copilot_chat %} to help you with.
  2. Ask {% data variables.product.prodname_copilot_chat %} a question about the file you have open. For example:
    • To generate a description of the file's purpose, ask a question like, "What does this file do?"
    • To generate a unit test for the file, type a request like, "Write a unit test for this file." Alternatively, highlight the code you want to generate a unit test for, then ask a question like, "Write a unit test for this code."
    • To generate a fix for a bug in the file, type a request like, "Fix this bug."

Sharing feedback about {% data variables.product.prodname_copilot_chat %}

To share feedback about {% data variables.product.prodname_copilot_chat %}, you can use the share feedback button in the {% data variables.product.prodname_copilot_chat %} window.

  1. At the top of the {% data variables.product.prodname_copilot_chat %} window, click the ellipsis (...), then click Send Chat Feedback.
  2. In your browser, in the vscode-copilot-release repository, click New issue.
  3. Choose one of the options that are displayed:
    • To open an issue to report a bug, click Bug report for {% data variables.product.prodname_copilot_chat %}.
    • To open an issue to request a feature, click Feature request for {% data variables.product.prodname_copilot_chat %}.
    • To report a security vulnerability, click Report a security vulnerability.
    • To ask a question in a discussion, click Questions.

Further reading

{% endvscode %}

{% visualstudio %}

{% note %}

Important:

{% data reusables.gated-features.copilot-chat-callout %}

{% endnote %}

About {% data variables.product.prodname_copilot_chat %} and {% data variables.product.prodname_vs %}

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

Prerequisites

{% data reusables.copilot.chat-subscription-prerequisite %}

  • To use {% data variables.product.prodname_copilot_chat %} with {% data variables.product.prodname_vs %}, you must be running {% data variables.product.prodname_vs %} 2022 version 17.6 or higher. For more information, see the Visual Studio IDE documentation.

  • To use {% data variables.product.prodname_copilot_chat %} with {% data variables.product.prodname_vs %}, you must be signed into {% data variables.product.prodname_vs %} with the same {% data variables.product.prodname_dotcom %} ID that has access to {% data variables.product.prodname_copilot %}.

Enabling or disabling {% data variables.product.prodname_copilot_chat %}

{% data reusables.copilot.enabling-or-disabling-copilot %}

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

To use {% data variables.product.prodname_copilot_chat %} with {% data variables.product.prodname_vs %}, you must install the {% data variables.product.prodname_vs %} extension. {% data reusables.copilot.vs-extensions %}

  1. In the "Manage Extensions" window, click Visual Studio Marketplace, search for "{% data variables.product.prodname_copilot_chat %}", then click Download. {% data reusables.copilot.vs-exit-and-relaunch %}

{% note %}

Note: If you experience authentication issues after installing the extension, see "AUTOTITLE."

{% endnote %}

Asking your first question

{% data reusables.copilot.copilot-chat-exclusively-code-questions %}

  1. In the {% data variables.product.prodname_vs %} menu bar, to launch {% data variables.product.prodname_copilot_chat %}, click View, then click {% data variables.product.prodname_copilot_chat %}.

  2. At the bottom of the {% data variables.product.prodname_copilot_chat_short %} window, in the Ask {% data variables.product.prodname_copilot_short %} text box, type a coding related question, then press Enter. For example, type "How do I write a function that returns the sum of two numbers?".

    {% note %}

    Note: If your question is outside the scope of {% data variables.product.prodname_copilot_chat %}, it will tell you and may suggest an alternative question to ask.

    {% endnote %}

  3. If {% data variables.product.prodname_copilot_chat_short %} offers a code suggestion that you want to use, click the Copy icon to copy the code suggestion to your clipboard.

  4. Optionally, if {% data variables.product.prodname_copilot_chat %} suggests a follow-up question under your last answer, click the follow-up question to ask it.

Asking {% data variables.product.prodname_copilot_chat %} questions about your code

{% data variables.product.prodname_copilot_chat %} can provide answers and support with a wide range of coding related topics.

  1. In {% data variables.product.prodname_vs %}, open the file you want {% data variables.product.prodname_copilot_chat %} to help you with.
  2. Ask {% data variables.product.prodname_copilot_chat %} a question about the file you have open. For example:
    • To generate a description of the file's purpose, ask a question like, "What does this file do"
    • To generate a unit test for the file, type a request like, "Write a unit test for this file." Alternatively, highlight the code you want to generate a unit test for, then ask a question like, "Write a unit test for this code."
    • To generate a fix for a bug in the file, type a request like, "Fix this bug."

Sharing feedback about {% data variables.product.prodname_copilot_chat %}

To share feedback about {% data variables.product.prodname_copilot_chat %}, you can use the Send feedback button in {% data variables.product.prodname_vs %}. For more information on providing feedback for {% data variables.product.prodname_vs %}, see the Visual Studio Feedback documentation.

  1. In the top right corner of the {% data variables.product.prodname_vs %} window, click the Send feedback button.

    Screenshot of the share feedback button in {% data variables.product.prodname_vs %}.

  2. Choose the option that best describes your feedback.

    • To report a bug, click Report a problem.
    • To request a feature, click Suggest a feature.

Further reading

{% endvisualstudio %}

{% jetbrains_beta %}

{% note %}

Important:

{% data reusables.gated-features.copilot-chat-jetbrains-beta %}

{% data reusables.gated-features.copilot-chat-callout-jetbrains-only %}

{% endnote %}

About {% data variables.product.prodname_copilot_chat %} and JetBrains

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

Joining the beta for {% data variables.product.prodname_copilot_chat %} in a JetBrains IDE

The following customers are eligible to participate in the private beta for {% data variables.product.prodname_copilot_chat %} in a JetBrains IDE.

  • Users with {% data variables.product.prodname_copilot_individuals_short %} subscriptions. To join the private beta, sign up on the waitlist. You will be notified by email when you are granted access to the beta. Joining the waitlist does not guarantee access to the beta.
  • Owners of invoiced organizations or enterprises with a {% data variables.product.prodname_copilot_business_short %} subscription who also have an account manager. To join the private beta, contact your account manager or solutions engineer to request access.

The following customers are not eligible for the private beta for {% data variables.product.prodname_copilot_chat %} in a JetBrains IDE at this time.

  • Customers on Free, Team, or Enterprise plans who do not have an account manager.
  • Customers on Enterprise plans who pay for {% data variables.product.product_name %} with a credit card or PayPal.

Prerequisites

{% data reusables.copilot.chat-subscription-prerequisite %}

  • To use the {% data variables.product.prodname_copilot_chat %} beta in JetBrains, you must have a compatible JetBrains IDE installed. {% data variables.product.prodname_copilot_chat_short %} is compatible with the following IDEs:

    • IntelliJ IDEA (Ultimate, Community, Educational)
    • Android Studio
    • AppCode
    • CLion
    • DataGrip
    • DataSpell
    • GoLand
    • MPS
    • PhpStorm
    • PyCharm (Professional, Community, Educational)
    • Rider
    • RubyMine
    • RustRover
    • WebStorm

    For more information, see the JetBrains IDEs tool finder.

Enabling or disabling {% data variables.product.prodname_copilot_chat %}

{% note %}

Note: If you have a {% data variables.product.prodname_copilot_for_individuals %} subscription, you can join the waitlist for {% data variables.product.prodname_copilot_chat_short %}. You will be notified by email when you have been grated access. Joining the waitlist does not guarantee you access.

{% endnote %}

If your organization {% ifversion ghec %}or enterprise{% endif %} is participating in the beta, organization {% ifversion ghec %}or enterprise{% endif %} owners can enable or disable {% data variables.product.prodname_copilot_chat %}.

Enabling or disabling {% data variables.product.prodname_copilot_chat %} at the organization level

{% data reusables.profile.access_org %} {% data reusables.profile.org_settings %}

  1. In the "Code planning, and automation" section of the sidebar, click {% octicon "copilot" aria-hidden="true" %} {% data variables.product.prodname_copilot_short %}, and then click Policies.
  2. To the right of {% data variables.product.prodname_copilot_chat %} Beta, select the dropdown menu, and then click Enabled or Disabled.

Enabling or disabling {% data variables.product.prodname_copilot_chat %} at the enterprise level

{% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.copilot-tab %}

  1. To the right of {% data variables.product.prodname_copilot_chat %} Beta, select the dropdown menu, and then choose the appropriate option.
    • Click Allowed to enable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise.
    • Click Blocked to disable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise.
    • Click No policy to allow each organization under your enterprise to set their own policy.

Installing or updating the {% data variables.product.prodname_copilot %} plugin in JetBrains

To use the {% data variables.product.prodname_copilot_chat %} beta in a JetBrains IDE, you must install or update the {% data variables.product.prodname_copilot %} plugin. If you have not yet installed the {% data variables.product.prodname_copilot %} plugin, follow the steps in "Installing the {% data variables.product.prodname_copilot %} plugin in your JetBrains IDE." If you have already installed the {% data variables.product.prodname_copilot %} plugin, follow the steps in "Updating the {% data variables.product.prodname_copilot %} plugin in JetBrains."

The following procedures will guide you through installing or updating the {% data variables.product.prodname_copilot %} plugin in IntelliJ IDEA. Steps to install the plugin in another supported IDE may differ.

Installing the {% data variables.product.prodname_copilot %} plugin in your JetBrains IDE

{% data reusables.copilot.installing-copilot-in-jetbrains-ide %}

Updating the {% data variables.product.prodname_copilot %} plugin in JetBrains

{% data reusables.copilot.jetbrains-settings-preferences %}

  1. In the left-side menu of the Settings/Preferences dialog box, click Plugins.
  2. At the top of the Settings/Preferences dialog box, click Installed. In the search bar, search for {% data variables.product.prodname_copilot %}, then click Update.
  3. After {% data variables.product.prodname_copilot %} is updated, quit and relaunch your JetBrains IDE.

Asking your first question

{% data reusables.copilot.copilot-chat-exclusively-code-questions %}

  1. At the right side of the JetBrains IDE window, click the {% data variables.product.prodname_copilot_chat %} icon to open the {% data variables.product.prodname_copilot_chat %} window.

    Screenshot of the {% data variables.product.prodname_copilot_chat %} icon in the Activity Bar.

  2. At the bottom of the {% data variables.product.prodname_copilot_chat %} window, in the Ask {% data variables.product.prodname_copilot_short %} a question or type / for commands text box, type a coding related question, then press Enter. For example, type "How do I write a function that returns the sum of two numbers?".

  3. {% data variables.product.prodname_copilot_chat %} will process your question and provide an answer, with code suggestions when appropriate, in the chat window.

    If your question is outside the scope of {% data variables.product.prodname_copilot_chat %}, it will tell you and may suggest an alternative question to ask.

  4. Optionally, if {% data variables.product.prodname_copilot_chat %} suggests a follow-up question above the Ask {% data variables.product.prodname_copilot_short %} a question or type / for commands text box, click the follow-up question to ask it.

Asking {% data variables.product.prodname_copilot_chat %} questions about your code

{% data variables.product.prodname_copilot_chat %} can provide answers and support with a wide range of coding-related topics.

  1. In your JetBrains IDE, open the file you want {% data variables.product.prodname_copilot_chat %} to help you with.
  2. Ask {% data variables.product.prodname_copilot_chat %} a question about the file you have open. For example:
    • To generate a description of the file's purpose, ask a question like, "What does this file do?"
    • To generate a unit test for the file, type a request like, "Write a unit test for this file." Alternatively, highlight the code you want to generate a unit test for, then ask a question like, "Write a unit test for this code."
    • To generate a fix for a bug in the file, type a request like, "Fix this bug."

Sharing feedback about {% data variables.product.prodname_copilot_chat %}

To share feedback about {% data variables.product.prodname_copilot_chat %}, you can use the share feedback link in JetBrains.

  1. At the right side of the JetBrains IDE window, click the {% data variables.product.prodname_copilot_chat %} icon to open the {% data variables.product.prodname_copilot_chat %} window.

    Screenshot of the {% data variables.product.prodname_copilot_chat %} icon in the Activity Bar.

  2. At the top of the {% data variables.product.prodname_copilot_chat %} window, click the share feedback link.

    Screenshot of the share feedback link in the {% data variables.product.prodname_copilot_chat %} window.

Further reading

{% endjetbrains_beta %}