Co-authored-by: Sarah Edwards <skedwards88@github.com> Co-authored-by: Nick Trogh <1908215+ntrogh@users.noreply.github.com>
11 KiB
title, shortTitle, intro, versions, defaultTool, topics
| title | shortTitle | intro | versions | defaultTool | topics | |||
|---|---|---|---|---|---|---|---|---|
| Installing the GitHub Copilot extension in your environment | Install Copilot extension | To use {% data variables.product.prodname_copilot_short %} in your preferred coding environment, you must install the {% data variables.product.prodname_copilot %} extension. |
|
vscode |
|
{% azure_data_studio %}
Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
Installing the {% data variables.product.prodname_copilot %} extension in Azure Data Studio
-
Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "AUTOTITLE."
-
Make sure you have a compatible version of Azure Data Studio. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. See the Azure Data Studio download page in the Azure Data Studio documentation.
-
Install the {% data variables.product.prodname_copilot %} extension in Azure Data Studio. See Install the {% data variables.product.prodname_copilot %} extension in the Microsoft documentation.
-
If a popup window in Azure Data Studio prompts you to sign in to use {% data variables.product.prodname_copilot %}, click Sign in to {% data variables.product.prodname_dotcom %} and follow the instructions on screen.
- If you have previously authorized Azure Data Studio for your account on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_copilot %} will be automatically authorized.
- If you don't get the prompt to authorize, you can view notifications by clicking the bell icon in the bottom panel of the Azure Data Studio window.
-
If you are following the authorization steps, 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 Azure Data Studio.
{% endazure_data_studio %}
{% jetbrains %}
Installing the {% data variables.product.prodname_copilot %} extension in JetBrains IDEs allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
Installing the {% data variables.product.prodname_copilot %} plugin in your JetBrains IDE
The following procedure will guide you through installation of the {% data variables.product.prodname_copilot %} plugin in IntelliJ IDEA. Steps to install the plugin in another supported IDE may differ.
-
Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "AUTOTITLE."
-
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 tool finder.
-
Install the {% data variables.product.prodname_copilot %} plugin for JetBrains. See {% data variables.product.prodname_copilot %} plugin in the JetBrains Marketplace.
-
After {% data variables.product.prodname_copilot %} is installed, click Restart IDE.
-
After your JetBrains IDE has restarted, click the Tools menu. Click {% data variables.product.prodname_copilot %}, then click Login to {% data variables.product.prodname_dotcom %}.
-
In the "Sign in to {% data variables.product.prodname_dotcom %}" dialog box, to copy the device code and open the device activation window, click Copy and Open.
-
A device activation window will open in your browser. Paste the device code, then click Continue.
-
{% 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.
-
After the permissions have been approved, your JetBrains IDE will show a confirmation. To begin using {% data variables.product.prodname_copilot %}, click OK.
{% endjetbrains %}
{% vimneovim %}
Installing the {% data variables.product.prodname_copilot %} extension in Vim/Neovim allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
Installing the {% data variables.product.prodname_copilot %} extension in Vim/Neovim
{% data variables.product.prodname_dotcom %} recommends that you install the {% data variables.product.prodname_copilot %} plugin with Vim/Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install github/copilot.vim. For more information, see the copilot.vim repository.
-
Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "AUTOTITLE."
-
Make sure you have a compatible version of Vim/Neovim installed. To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above. See the Vim / Neovim documentation and the Node.js website.
-
Install {% data variables.product.prodname_copilot %} using the built-in plugin manager:
-
For Vim on macOS or Linux, run the following command in the terminal.
git clone https://github.com/github/copilot.vim \ ~/.vim/pack/github/start/copilot.vim -
For Vim on Windows, run the following command in Git Bash:
git clone https://github.com/github/copilot.vim.git \ $HOME/vimfiles/pack/github/start/copilot.vim -
For Neovim on macOS or Linux, run the following command in the terminal.
git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim -
For Neovim on Windows, run the following command in Git Bash:
git clone https://github.com/github/copilot.vim.git \ $HOME/AppData/Local/nvim/pack/github/start/copilot.vim
-
{% data reusables.copilot.config-enable-copilot-in-vimneovim %}
{% endvimneovim %}
{% visualstudio %}
Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %} allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type.
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vs %}
-
Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "AUTOTITLE."
-
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 %}" in the Microsoft documentation.
-
Install the {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %} See "Install GitHub Copilot in Visual Studio" in the Microsoft documentation.
-
After installing the {% data variables.product.prodname_copilot %} extension, to enable {% data variables.product.prodname_copilot %}, ensure you have added your {% data variables.product.prodname_dotcom %} account to {% data variables.product.prodname_vs %}. For more information, see Add your {% data variables.product.prodname_dotcom %} accounts to your {% data variables.product.prodname_vs %} keychain in the Microsoft documentation.
{% endvisualstudio %}
{% vscode %}
Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %} allows you to receive coding suggestions from {% data variables.product.prodname_copilot_short %} as you type. It also automatically installs the {% data variables.product.prodname_copilot_chat %} extension, which allows you to chat with {% data variables.product.prodname_copilot_short %}.
To see instructions for other popular coding environments, use the tool switcher at the top of the page.
Installing the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %}
-
Make sure you have access to {% data variables.product.prodname_copilot %}. For information, see "AUTOTITLE."
-
Install {% data variables.product.prodname_vscode %}. See the {% data variables.product.prodname_vscode %} download page.
-
Install the {% data variables.product.prodname_copilot %} extension in {% data variables.product.prodname_vscode %}. For detailed instructions, see "Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}" in the {% data variables.product.prodname_vscode %} documentation.
{% endvscode %}

