131 lines
8.2 KiB
Markdown
131 lines
8.2 KiB
Markdown
---
|
|
title: Configuring GitHub Copilot in Visual Studio Code
|
|
intro: 'You can enable, configure, and disable {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}.'
|
|
product: '{% data reusables.gated-features.copilot %}'
|
|
versions:
|
|
feature: copilot
|
|
shortTitle: Visual Studio Code
|
|
topics:
|
|
- Copilot
|
|
---
|
|
|
|
## About {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}
|
|
|
|
If you use {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_copilot %} can autocomplete code as you type. After installation, you can enable or disable {% data variables.product.prodname_copilot %}, and you can configure advanced settings within {% data variables.product.prodname_vscode %} or on {% data variables.product.prodname_dotcom_the_website %}.
|
|
|
|
## Prerequisites
|
|
|
|
To configure {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see "[AUTOTITLE](/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code)."
|
|
|
|
## Keyboard shortcuts for {% data variables.product.prodname_copilot %}
|
|
|
|
You can use the default keyboard shortcuts in {% data variables.product.prodname_vscode %} when using {% data variables.product.prodname_copilot %}. Alternatively, you can rebind the shortcuts in the Keyboard Shortcuts editor using your preferred keyboard shortcuts for each specific command. You can search for each keyboard shortcut by command name in the Keyboard Shortcuts editor.
|
|
|
|
{% mac %}
|
|
|
|
| Action | Shortcut | Command name |
|
|
|:---|:---|:---|
|
|
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
|
|
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
|
|
|Show next inline suggestion| <kbd>Option (⌥)</kbd>+<kbd>]</kbd><br> |editor.action.inlineSuggest.showNext|
|
|
|Show previous inline suggestion| <kbd>Option (⌥)</kbd>+<kbd>[</kbd><br> |editor.action.inlineSuggest.showPrevious|
|
|
|Trigger inline suggestion| <kbd>Option (⌥)</kbd>+<kbd>\</kbd><br> |editor.action.inlineSuggest.trigger|
|
|
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Return</kbd>|github.copilot.generate|
|
|
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
|
|
|
|
{% endmac %}
|
|
|
|
{% windows %}
|
|
|
|
| Action | Shortcut | Command name |
|
|
|:---|:---|:---|
|
|
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
|
|
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
|
|
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd> |editor.action.inlineSuggest.showNext|
|
|
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|editor.action.inlineSuggest.showPrevious|
|
|
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\</kbd>|editor.action.inlineSuggest.trigger|
|
|
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Enter</kbd>|github.copilot.generate|
|
|
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
|
|
|
|
{% endwindows %}
|
|
|
|
|
|
{% linux %}
|
|
|
|
| Action | Shortcut | Command name |
|
|
|:---|:---|:---|
|
|
|Accept an inline suggestion|<kbd>Tab</kbd>|editor.action.inlineSuggest.commit|
|
|
|Dismiss an inline suggestion|<kbd>Esc</kbd>|editor.action.inlineSuggest.hide|
|
|
|Show next inline suggestion|<kbd>Alt</kbd>+<kbd>]</kbd> |editor.action.inlineSuggest.showNext|
|
|
|Show previous inline suggestion|<kbd>Alt</kbd>+<kbd>[</kbd>|editor.action.inlineSuggest.showPrevious|
|
|
|Trigger inline suggestion|<kbd>Alt</kbd>+<kbd>\</kbd>|editor.action.inlineSuggest.trigger|
|
|
|Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane)|<kbd>Ctrl</kbd>+<kbd>Enter</kbd>|github.copilot.generate|
|
|
|Toggle {% data variables.product.prodname_copilot %} on/off|_No default shortcut_|github.copilot.toggleCopilot|
|
|
|
|
{% endlinux %}
|
|
|
|
## Rebinding keyboard shortcuts
|
|
|
|
If you don't want to use the default keyboard shortcuts in {% data variables.product.prodname_vscode %} when using {% data variables.product.prodname_copilot %}, you can rebind the shortcuts in the Keyboard Shortcuts editor using your preferred keyboard shortcuts for each specific command.
|
|
|
|
1. Click the **File** menu, click **Preferences**, then click **Keyboard Shortcuts**.
|
|
|
|
1. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.
|
|
|
|
1. Next to the command you want to change, click the pencil icon.
|
|
|
|
1. Type the keystrokes you want to use for the command, then press <kbd>Enter</kbd>/<kbd>Return</kbd>.
|
|
|
|
|
|
{% data reusables.copilot.enabling-or-disabling-in-vsc %}
|
|
|
|
## Enabling or disabling inline suggestions
|
|
|
|
You can choose to enable or disable inline suggestions for {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}.
|
|
|
|
{% data reusables.copilot.vscode-settings %}
|
|
1. In the left-side panel of the settings tab, click **Extensions** and then select **{% data variables.product.prodname_copilot_short %}**.
|
|
1. Under "Inline Suggest:Enable," select or deselect the checkbox to enable or disable inline suggestions.
|
|
|
|
## Enabling or disabling {% data variables.product.prodname_copilot %} for specific languages
|
|
|
|
You can specify which languages you want to enable or disable {% data variables.product.prodname_copilot %} for.
|
|
|
|
1. From the {% data variables.product.prodname_vscode %}, click the **Extensions** tab, then navigate to the **Copilot** section. For more information, see "[Enabling and disabling inline suggestions](#enabling-and-disabling-inline-suggestions)."
|
|
1. Under "Enable or disable {% data variables.product.prodname_copilot_short %} for specified languages," click **Edit in settings.json**.
|
|
1. In the _settings.json_ file, add or remove the languages you want to enable or disable {% data variables.product.prodname_copilot %} for. For example, to enable Python in {% data variables.product.prodname_copilot %}, add `"python": true` to the list, ensuring there is a trailing comma after all but the last list item.
|
|
|
|
```json
|
|
{
|
|
"editor.inlineSuggest.enabled": true,
|
|
"github.copilot.enable": {
|
|
"*": true,
|
|
"yaml": false,
|
|
"plaintext": false,
|
|
"markdown": true,
|
|
"javascript": true,
|
|
"python": true
|
|
}
|
|
}
|
|
```
|
|
|
|
## Configuring proxy settings for {% data variables.product.prodname_copilot %}
|
|
|
|
You can configure {% data variables.product.prodname_copilot %} to connect through an HTTP proxy server in {% data variables.product.prodname_vscode %}. {% data variables.product.prodname_copilot %} supports basic HTTP proxy setups, with or without basic authentication.
|
|
|
|
{% data reusables.copilot.vscode-settings %}
|
|
1. In the left-side panel of the settings tab, click **Application** and then select **Proxy**.
|
|
1. In the textbox under "Proxy", type the address of your proxy server, for example `http://localhost:3128`. Alternatively, {% data variables.product.prodname_copilot %} will use the `http_proxy` and `https_proxy` variables from your environment.
|
|
|
|
|
|
|
|
1. Optionally, under "Http: Proxy Authorization", click **Edit in settings.json** and add your required value to send as the `Proxy-Authorization` header for every network request.
|
|
|
|
|
|
|
|
1. Optionally, under "Http: Proxy Strict SSL", select or deselect the checkbox to enable or disable strict SSL.
|
|
|
|
|
|
|
|
{% data reusables.copilot.dotcom-settings %}
|