diff --git a/assets/images/help/copilot/chat-button-vscode.png b/assets/images/help/copilot/chat-button-vscode.png new file mode 100644 index 0000000000..075d936d48 Binary files /dev/null and b/assets/images/help/copilot/chat-button-vscode.png differ diff --git a/assets/images/help/copilot/insert-at-cursor-vscode.png b/assets/images/help/copilot/insert-at-cursor-vscode.png new file mode 100644 index 0000000000..2bcd23217a Binary files /dev/null and b/assets/images/help/copilot/insert-at-cursor-vscode.png differ diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md b/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md index 423aabb41e..f4c1ec4c44 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md @@ -39,8 +39,7 @@ On {% data variables.product.prodname_dotcom_the_website %}, you can use {% data ## Prerequisites -{% data reusables.copilot.chat-subscription-prerequisite %} -- To use {% data variables.product.prodname_copilot_chat_dotcom %}, you must have been granted access to {% data variables.product.prodname_copilot_chat %} as part of {% data variables.product.prodname_copilot_enterprise %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)." +{% data reusables.copilot.chat-dotcom-prerequisites %} ## Powered by skills diff --git a/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md b/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md index fa19737606..29198207d1 100644 --- a/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md +++ b/content/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide.md @@ -17,11 +17,9 @@ shortTitle: Use Copilot Chat ## Prerequisites - **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." -- **Latest version of {% data variables.product.prodname_vscode %}**. See the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/). -- **{% data variables.product.prodname_copilot_chat %} extension**. This is automatically installed when you install the {% data variables.product.prodname_copilot %} extension. See the [GitHub Copilot extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) in the Visual Studio Marketplace. -- **Sign in to {% data variables.product.company_short %} in {% data variables.product.prodname_vscode %}**. If you experience authentication issues, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides#troubleshooting-authentication-issues-in-your-editor)." +{% data reusables.copilot.vscode-prerequisites %} -If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.product.prodname_copilot_chat %} if your organization owner or enterprise administrator has disabled {% data variables.product.prodname_copilot_chat %}. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." +{% data reusables.copilot.chat-access-denied %} ## Submitting prompts @@ -252,12 +250,12 @@ To leave feedback about the {% data variables.product.prodname_copilot_chat %} e ## Prerequisites - **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." -- **{% data variables.product.prodname_vs %} 2022 version 17.8 or higher**. See [Install Visual Studio](https://learn.microsoft.com/visualstudio/install/install-visual-studio) in the {% data variables.product.prodname_vs %} documentation. +- **{% data variables.product.prodname_vs %} 2022 version 17.8 or later**. See [Install Visual Studio](https://learn.microsoft.com/visualstudio/install/install-visual-studio) in the {% data variables.product.prodname_vs %} documentation. - **{% data variables.product.prodname_copilot %} extension**. See [Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states) in the {% data variables.product.prodname_vs %} documentation. - **{% data variables.product.prodname_copilot_chat %} extension**. See [Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/visualstudio/ide/visual-studio-github-copilot-install-and-states) in the {% data variables.product.prodname_vs %} documentation. - **Sign in to {% data variables.product.company_short %} in {% data variables.product.prodname_vs %}**. If you experience authentication issues, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides#troubleshooting-authentication-issues-in-your-editor)." -If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.product.prodname_copilot_chat %} if your organization owner or enterprise administrator has disabled {% data variables.product.prodname_copilot_chat %}. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." +{% data reusables.copilot.chat-access-denied %} ## Submitting prompts @@ -424,26 +422,12 @@ To share feedback about {% data variables.product.prodname_copilot_chat_short %} - **Access to {% data variables.product.prodname_copilot %}**. See "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." - **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot %} 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 - See the [JetBrains IDEs](https://www.jetbrains.com/products/) tool finder to download. -- **{% data variables.product.prodname_copilot %} plugin**. See the [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace. For installation instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." -- **Sign in to {% data variables.product.company_short %} in your JetBrains IDE**. For authentication instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." + {% data reusables.copilot.jetbrains-compatible-ides %} -If you have access to {% data variables.product.prodname_copilot %} via your organization or enterprise, you cannot use {% data variables.product.prodname_copilot_chat %} if your organization owner or enterprise administrator has disabled {% data variables.product.prodname_copilot_chat %}. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." +{% data reusables.copilot.jetbrains-plugin-prerequisites %} + +{% data reusables.copilot.chat-access-denied %} ## Submitting prompts diff --git a/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md b/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md index ac8f9aa99e..7f2af1bb26 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md +++ b/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md @@ -56,24 +56,7 @@ The following procedure will guide you through installation of the {% data varia 1. Make sure you have a JetBrains IDE that is compatible with {% data variables.product.prodname_copilot %}. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: - - IntelliJ IDEA (Ultimate, Community, Educational) - - Android Studio - - AppCode - - CLion - - Code With Me Guest - - DataGrip - - DataSpell - - GoLand - - JetBrains Client - - MPS - - PhpStorm - - PyCharm (Professional, Community, Educational) - - Rider - - RubyMine - - RustRover - - WebStorm - - For more information, see the [JetBrains IDEs](https://www.jetbrains.com/products/) tool finder. + {% data reusables.copilot.jetbrains-compatible-ides %} 1. Install the {% data variables.product.prodname_copilot %} plugin for JetBrains. See [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace. @@ -161,7 +144,7 @@ Starting from {% data variables.product.prodname_vs %} 2022 Version 17.10, the u 1. Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "[AUTOTITLE](/copilot/about-github-copilot#getting-access-to-github-copilot)." -1. Make sure you have a compatible version of {% data variables.product.prodname_vs %} installed. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have version 2022 17.6 or later of {% data variables.product.prodname_vs %} for Windows. Note that {% data variables.product.prodname_copilot_short %} is not currently available in {% data variables.product.prodname_vs %} for Mac. For more information, see "[Install {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio)" in the Microsoft documentation. +1. Make sure you have a compatible version of {% data variables.product.prodname_vs %} installed. {% data reusables.copilot.visual-studio-version %} 1. Install the {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %} See "[Install GitHub Copilot in Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/visual-studio-github-copilot-install-and-states)" in the Microsoft documentation. diff --git a/content/copilot/quickstart.md b/content/copilot/quickstart.md index 4877e329be..632c2afbd9 100644 --- a/content/copilot/quickstart.md +++ b/content/copilot/quickstart.md @@ -1,6 +1,6 @@ --- title: Quickstart for GitHub Copilot -intro: 'Quickly learn how to use {% data variables.product.prodname_copilot_short %} to suggest code as you type.' +intro: 'Quickly learn how to use {% data variables.product.prodname_copilot %} in your editor{% ifversion ghec %} or on {% data variables.product.prodname_dotcom_the_website %}{% endif %}.' allowTitleToDifferFromFilename: true versions: feature: copilot @@ -11,29 +11,100 @@ topics: ## Introduction -This guide demonstrates how to set up a {% data variables.product.prodname_copilot_for_individuals %} subscription for your personal account, set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, and get your first code suggestion. +{% ifversion ghec %} +{% webui %} -To learn more about everything that {% data variables.product.prodname_copilot_short %} can do, see "[AUTOTITLE](/copilot/about-github-copilot)." +You can use {% data variables.product.prodname_copilot_chat_dotcom %} to get answers to coding-related questions, such as how best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see "[AUTOTITLE](/copilot/about-github-copilot)." -To get started using {% data variables.product.prodname_copilot_short %} in other coding environments, see "[AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor)." +Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on whether you are in an editor or on {% data variables.product.prodname_dotcom_the_website %}. This version of the quickstart is for {% data variables.product.prodname_dotcom_the_website %}. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in an editor. -## Sign up for {% data variables.product.prodname_copilot %} +## Prerequisites -Start a free trial {% octicon "link-external" height:16 %} +{% data reusables.copilot.chat-dotcom-prerequisites %} -Before you can start using {% data variables.product.prodname_copilot %} through your personal account, you will need to set up a free trial or subscription for {% data variables.product.prodname_copilot_for_individuals %}. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)." +## Asking your first question -## Install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_copilot %} extension +1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository and open a file. +1. Click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) at the top right of the file view. -1. If you don't already have {% data variables.product.prodname_vscode %} installed, install it from the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/Download). + ![Screenshot of the {% data variables.product.prodname_copilot_short %} button, highlighted with a dark orange outline, at the top of the file view.](/assets/images/help/copilot/copilot-button-for-file.png) -1. Install the {% data variables.product.prodname_copilot %} extension from the [{% data variables.product.prodname_vs %} Marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). For more information, see "[Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup)" in the Microsoft documentation. +1. Type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and press Enter. -## Get your first suggestion + For example, you could enter: -Now that you've installed the {% data variables.product.prodname_copilot %} extension, follow these steps to create a new file and get a code suggestion from {% data variables.product.prodname_copilot_short %}. + - Explain this file. + - How could I improve this code? + - How can I test this code? -This example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} + {% data variables.product.prodname_copilot_short %} responds to your request in the panel. + +1. You can continue the conversation by asking a follow-up question. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment. + +## Other questions you can ask + +There are many more things you can do with {% data variables.product.prodname_copilot_chat_dotcom %}. For example: + +- Ask a general question about software development +- Ask exploratory questions about a repository +- Ask a question about a knowledge base +- Find out about the changes in a pull request +- Ask a question about a specific issue or commit + +For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)." + +## Next steps + +- **Find out more about {% data variables.product.prodname_copilot_chat %}** - See "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide){% ifversion fpt %}.{% endif %}"{% ifversion ghec %} and "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)."{% endif %} +- **Get {% data variables.product.prodname_copilot_short %} code completion suggestions in an IDE** - See "[AUTOTITLE](/enterprise-cloud@latest/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor)." +- **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile)." +- **Use {% data variables.product.prodname_copilot_short %} on the command line** - See "[AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli)." + +{% endwebui %} +{% endif %} + +{% vscode %} + +{% data reusables.copilot.quickstart-intro %} + +Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on the editor you use. This version of the quickstart is for {% data variables.product.prodname_vscode %}. Click the tabs above to see instructions for other editors{% ifversion ghec %} and for {% data variables.product.prodname_dotcom_the_website %}{% endif %}. + +{% ifversion fpt %} +{% data reusables.copilot.quickstart-signup %} +{% endif %} + +## Prerequisites + +{% ifversion ghec %} +- **{% data variables.product.prodname_copilot_short %} subscription** - To use {% data variables.product.prodname_copilot %} you must have been assigned a seat as part of a {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} subscription. +{% endif %} +{% data reusables.copilot.vscode-prerequisites %} + +## Chat with {% data variables.product.prodname_copilot %} + +After you've installed the {% data variables.product.prodname_copilot %} extension, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. + +> [!NOTE] {% data reusables.copilot.chat-access-denied %} + +1. Open an existing code file. +1. Open the Chat view from the Activity Bar. + + ![Screenshot of the Chat icon in the {% data variables.product.prodname_vscode_shortname %} Activity Bar.](/assets/images/help/copilot/chat-button-vscode.png) + +1. At the bottom of the chat view, in the chat input field, type: `explain this file`. +1. Press Enter. + + {% data variables.product.prodname_copilot_short %} replies in the chat view. + +1. In the editor, select one or more lines of code that are not commented. +1. In the chat input field, type: `add comments to these lines`. +1. If you like the comments that {% data variables.product.prodname_copilot_short %} suggests, hover over the suggested code in the chat view and click the "Insert at Cursor" icon to replace the selected lines with the suggested code. + + ![Screenshot of the "Insert at Cursor" icon in the chat view.](/assets/images/help/copilot/insert-at-cursor-vscode.png) + +## Get your first code completion suggestion + +The following example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} 1. Open {% data variables.product.prodname_vscode %}. {% data reusables.copilot.create-js-file %} @@ -43,9 +114,110 @@ This example uses JavaScript, however other languages will work similarly. {% da ## Next steps -You successfully installed {% data variables.product.prodname_copilot %} and received your first suggestion, but that's just the beginning! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_copilot %}. - -- **Configure {% data variables.product.prodname_copilot_short %} in your editor** - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment)." -- **Get started with {% data variables.product.prodname_copilot_chat %}** - Learn how to ask {% data variables.product.prodname_copilot_short %} for information and assistance, using {% data variables.product.prodname_copilot_chat %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)"{% ifversion ghec %} and "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% endif %}. +{% data reusables.copilot.quickstart-nextsteps1 %} - **Use {% data variables.product.prodname_copilot_short %} like a pro** - Learn how to write effective prompts for {% data variables.product.prodname_copilot %}. For more information, see "[Best practices for using {% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/prompt-crafting)" in the {% data variables.product.prodname_vscode %} documentation. -- **Troubleshoot issues** - Learn more about how to troubleshoot common issues with {% data variables.product.prodname_copilot %}. For more information, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot)." +{% data reusables.copilot.quickstart-nextsteps2 %} + +{% endvscode %} + +{% visualstudio %} + +{% data reusables.copilot.quickstart-intro %} + +Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on the editor you use. This version of the quickstart is for {% data variables.product.prodname_vs %}. Click the tabs above to see instructions for other editors{% ifversion ghec %} and for {% data variables.product.prodname_dotcom_the_website %}{% endif %}. + +{% ifversion fpt %} +{% data reusables.copilot.quickstart-signup %} +{% endif %} + +## Prerequisites + +{% ifversion ghec %} +- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +{% endif %} +{% data reusables.copilot.visual-studio-prerequisites %} + +## Chat with {% data variables.product.prodname_copilot %} + +After you've installed the {% data variables.product.prodname_copilot %} extension, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. + +> [!NOTE] {% data reusables.copilot.chat-access-denied %} + +1. Open an existing code file. +1. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.product.prodname_copilot_chat %}**. +1. In the {% data variables.product.prodname_copilot_chat_short %} window, type `what does this file do` then press Enter. + + {% data variables.product.prodname_copilot_short %}'s answer is displayed below your question. + +1. Select a line of code in the editor. +1. In the {% data variables.product.prodname_copilot_chat_short %} window, type `explain this line` then press Enter. + +## Get your first code completion suggestion + +The following example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} + +1. Open {% data variables.product.prodname_vs %}. +1. In {% data variables.product.prodname_vs %}, create a new JavaScript (_*.js_) file. +{% data reusables.copilot.type-function-header %} + {% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary. +1. {% data reusables.copilot.accept-suggestion %} + +## Next steps + +{% data reusables.copilot.quickstart-nextsteps1 %} +- **Prompt like a pro** - Watch "[{% data variables.product.prodname_vs %} Prompt Engineering with {% data variables.product.prodname_copilot %}](https://www.youtube.com/watch?v=9hZsOeIINg8&list=PLReL099Y5nRckZDdcQ21UigO9pKa14yxC)" on YouTube. +{% data reusables.copilot.quickstart-nextsteps2 %} + +{% endvisualstudio %} + +{% jetbrains %} + +{% data reusables.copilot.quickstart-intro %} + +Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on the editor you use. This version of the quickstart is for JetBrains IDEs. Click the tabs above to see instructions for other editors{% ifversion ghec %} and for {% data variables.product.prodname_dotcom_the_website %}{% endif %}. + +{% ifversion fpt %} +{% data reusables.copilot.quickstart-signup %} +{% endif %} + +## Prerequisites + +{% ifversion ghec %} +- **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} +{% endif %} +- **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot_short %} is supported in a large number of JetBrains IDEs. For a full list, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=jetbrains)." +{% data reusables.copilot.jetbrains-plugin-prerequisites %} + +## Chat with {% data variables.product.prodname_copilot %} + +After you've installed the {% data variables.product.prodname_copilot %} plugin, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions. + +> [!NOTE] {% data reusables.copilot.chat-access-denied %} + +1. Open an existing code file. +1. Open the {% data variables.product.prodname_copilot_chat_short %} window by clicking the **{% data variables.product.prodname_copilot_chat_short %}** icon at the right side of the JetBrains IDE window. + + ![Screenshot of the {% data variables.product.prodname_copilot_chat_short %} icon in the Activity Bar.](/assets/images/help/copilot/jetbrains-copilot-chat-icon.png) + +1. In the {% data variables.product.prodname_copilot_chat_short %} window, type `what does this file do` then press Enter. + + {% data variables.product.prodname_copilot_short %}'s answer is displayed below your question. + +1. Select a line of code in the editor. +1. In the {% data variables.product.prodname_copilot_chat_short %} window, type `explain this line` then press Enter. + +## Get your first code completion suggestion + +The following example uses JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} + +1. In your JetBrains editor, create a new JavaScript (_*.js_) file. +{% data reusables.copilot.type-function-header %} + {% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary. +1. {% data reusables.copilot.accept-suggestion %} + +## Next steps + +{% data reusables.copilot.quickstart-nextsteps1 %} +{% data reusables.copilot.quickstart-nextsteps2 %} + +{% endjetbrains %} diff --git a/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md b/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md index bafe843293..606791a04a 100644 --- a/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md +++ b/content/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor.md @@ -36,26 +36,9 @@ The examples in this guide use Java, however other languages will work similarly - **Compatible JetBrains IDE**. To use {% data variables.product.prodname_copilot %} in JetBrains, you must have a compatible JetBrains IDE installed. {% data variables.product.prodname_copilot %} is compatible with the following IDEs: - - IntelliJ IDEA (Ultimate, Community, Educational) - - Android Studio - - AppCode - - CLion - - Code With Me Guest - - DataGrip - - DataSpell - - GoLand - - JetBrains Client - - MPS - - PhpStorm - - PyCharm (Professional, Community, Educational) - - Rider - - RubyMine - - RustRover - - WebStorm + {% data reusables.copilot.jetbrains-compatible-ides %} - For more information, see the [JetBrains IDEs](https://www.jetbrains.com/products/) tool finder. - -- **{% data variables.product.prodname_copilot %} plugin for JetBrains**. To use {% data variables.product.prodname_copilot %} in JetBrains, you must install the [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot). For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." +{% data reusables.copilot.jetbrains-plugin-prerequisites %} ## Getting code suggestions @@ -153,9 +136,7 @@ The examples in this guide use C#, however other languages will work similarly. - **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Visual Studio, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %} -- **Compatible version of {% data variables.product.prodname_vs %}**. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have version 2022 17.6 or later of {% data variables.product.prodname_vs %} for Windows installed. Note that {% data variables.product.prodname_copilot %} is not currently available in {% data variables.product.prodname_vs %} for Mac. For more information, see "[Install {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio)" in the Microsoft documentation. - -- **{% data variables.product.prodname_copilot %} extension for {% data variables.product.prodname_vs %}**. {% data reusables.copilot.link-to-vs-install-docs %} +{% data reusables.copilot.visual-studio-prerequisites %} ## Getting code suggestions diff --git a/data/reusables/copilot/chat-access-denied.md b/data/reusables/copilot/chat-access-denied.md new file mode 100644 index 0000000000..dda6b1d315 --- /dev/null +++ b/data/reusables/copilot/chat-access-denied.md @@ -0,0 +1 @@ +If you have access to {% data variables.product.prodname_copilot %} via your organization{% ifversion ghec %} or enterprise{% endif %}, you won't be able to use {% data variables.product.prodname_copilot_chat %} if your organization owner{% ifversion ghec %} or enterprise administrator{% endif %} has disabled chat. See "[AUTOTITLE](/copilot/managing-github-copilot-in-your-organization/managing-policies-and-features-for-copilot-in-your-organization)." diff --git a/data/reusables/copilot/chat-dotcom-prerequisites.md b/data/reusables/copilot/chat-dotcom-prerequisites.md new file mode 100644 index 0000000000..5a011cbe23 --- /dev/null +++ b/data/reusables/copilot/chat-dotcom-prerequisites.md @@ -0,0 +1 @@ +To use {% data variables.product.prodname_copilot_chat_dotcom %}, you must have been assigned a seat as part of a subscription to {% data variables.product.prodname_copilot_enterprise %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise-features)." diff --git a/data/reusables/copilot/jetbrains-compatible-ides.md b/data/reusables/copilot/jetbrains-compatible-ides.md new file mode 100644 index 0000000000..4c9f81ce7f --- /dev/null +++ b/data/reusables/copilot/jetbrains-compatible-ides.md @@ -0,0 +1,18 @@ +- IntelliJ IDEA (Ultimate, Community, Educational) +- Android Studio +- AppCode +- CLion +- Code With Me Guest +- DataGrip +- DataSpell +- GoLand +- JetBrains Client +- MPS +- PhpStorm +- PyCharm (Professional, Community, Educational) +- Rider +- RubyMine +- RustRover +- WebStorm + +See the [JetBrains IDEs](https://www.jetbrains.com/products/) tool finder to download. diff --git a/data/reusables/copilot/jetbrains-plugin-prerequisites.md b/data/reusables/copilot/jetbrains-plugin-prerequisites.md new file mode 100644 index 0000000000..a4282a0a0f --- /dev/null +++ b/data/reusables/copilot/jetbrains-plugin-prerequisites.md @@ -0,0 +1,2 @@ +- **{% data variables.product.prodname_copilot %} plugin**. See the [{% data variables.product.prodname_copilot %} plugin](https://plugins.jetbrains.com/plugin/17718-github-copilot) in the JetBrains Marketplace. For installation instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment)." +- **Log in to {% data variables.product.company_short %} in your JetBrains IDE**. For authentication instructions, see "[AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment?tool=jetbrains#installing-the-github-copilot-plugin-in-your-jetbrains-ide)." diff --git a/data/reusables/copilot/quickstart-intro.md b/data/reusables/copilot/quickstart-intro.md new file mode 100644 index 0000000000..a510c09f7f --- /dev/null +++ b/data/reusables/copilot/quickstart-intro.md @@ -0,0 +1 @@ +{% data variables.product.prodname_copilot %} provides coding suggestions as you type in your editor. You can also ask {% data variables.product.prodname_copilot_short %} coding-related questions, such as how to best to code something, how to fix a bug, or how someone else's code works. For full details of what {% data variables.product.prodname_copilot_short %} can do, see "[AUTOTITLE](/copilot/about-github-copilot)." diff --git a/data/reusables/copilot/quickstart-nextsteps1.md b/data/reusables/copilot/quickstart-nextsteps1.md new file mode 100644 index 0000000000..67e008c112 --- /dev/null +++ b/data/reusables/copilot/quickstart-nextsteps1.md @@ -0,0 +1,2 @@ +- **Find out more about {% data variables.product.prodname_copilot_short %} code completion"** - See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor)." +- **Find out more about {% data variables.product.prodname_copilot_chat %}** - See "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide){% ifversion fpt %}.{% endif %}"{% ifversion ghec %} and "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)."{% endif %} diff --git a/data/reusables/copilot/quickstart-nextsteps2.md b/data/reusables/copilot/quickstart-nextsteps2.md new file mode 100644 index 0000000000..038b68288b --- /dev/null +++ b/data/reusables/copilot/quickstart-nextsteps2.md @@ -0,0 +1,3 @@ +- **Use {% data variables.product.prodname_copilot_short %} on your mobile device** - See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile)." +- **Use {% data variables.product.prodname_copilot_short %} on the command line** - See "[AUTOTITLE](/copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli)." +- **Configure {% data variables.product.prodname_copilot_short %} in your editor** - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. See "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment)." diff --git a/data/reusables/copilot/quickstart-signup.md b/data/reusables/copilot/quickstart-signup.md new file mode 100644 index 0000000000..a8406e0979 --- /dev/null +++ b/data/reusables/copilot/quickstart-signup.md @@ -0,0 +1,15 @@ +{% ifversion fpt %} + +## Sign up for {% data variables.product.prodname_copilot %} + +Start a free trial {% octicon "link-external" height:16 %} + +If you don't already have access to {% data variables.product.prodname_copilot %}, you can set up a free trial or subscription for {% data variables.product.prodname_copilot_for_individuals %} on your personal {% data variables.product.prodname_dotcom %} account. For more information, see "[AUTOTITLE](/copilot/copilot-individual/about-github-copilot-individual)." + +{% elsif ghec %} + +## Prerequisites + +To use {% data variables.product.prodname_copilot %} you must have been assigned a seat by your organization as part of a {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} subscription, or you must have signed up for {% data variables.product.prodname_copilot_for_individuals %} on your personal {% data variables.product.prodname_dotcom %} account. + +{% endif %} diff --git a/data/reusables/copilot/visual-studio-prerequisites.md b/data/reusables/copilot/visual-studio-prerequisites.md new file mode 100644 index 0000000000..debb6540b9 --- /dev/null +++ b/data/reusables/copilot/visual-studio-prerequisites.md @@ -0,0 +1,3 @@ +- **Compatible version of {% data variables.product.prodname_vs %}**. {% data reusables.copilot.visual-studio-version %} +- **{% data variables.product.prodname_copilot %} extension for {% data variables.product.prodname_vs %}**. {% data reusables.copilot.link-to-vs-install-docs %} +- **Add your {% data variables.product.prodname_dotcom %} account to {% data variables.product.prodname_vs %}**. See [Add your {% data variables.product.prodname_dotcom %} accounts to your {% data variables.product.prodname_vs %} keychain](https://learn.microsoft.com/en-us/visualstudio/ide/work-with-github-accounts) in the Microsoft documentation. diff --git a/data/reusables/copilot/visual-studio-version.md b/data/reusables/copilot/visual-studio-version.md new file mode 100644 index 0000000000..f4f5074058 --- /dev/null +++ b/data/reusables/copilot/visual-studio-version.md @@ -0,0 +1 @@ +To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}, you must have version 2022 17.8 or later of {% data variables.product.prodname_vs %} for Windows installed. For more information, see "[Install {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/install/install-visual-studio)" in the Microsoft documentation. diff --git a/data/reusables/copilot/vscode-prerequisites.md b/data/reusables/copilot/vscode-prerequisites.md new file mode 100644 index 0000000000..24eeae97b8 --- /dev/null +++ b/data/reusables/copilot/vscode-prerequisites.md @@ -0,0 +1,3 @@ +- **Latest version of {% data variables.product.prodname_vscode %}**. See the [{% data variables.product.prodname_vscode %} download page](https://code.visualstudio.com/Download). +- **The {% data variables.product.prodname_copilot %} extension** - Install this from the [{% data variables.product.prodname_vs %} Marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). For more information, see "[Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/setup)" in the Microsoft documentation. +- **Sign in to {% data variables.product.company_short %} in {% data variables.product.prodname_vscode %}**. If you experience authentication issues, see "[AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides#troubleshooting-authentication-issues-in-your-editor)."