1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Files
docs/content/copilot/configuring-github-copilot/configuring-github-copilot-in-visual-studio-code.md
Jules Parker 90adf8ab8c matt's changes
2022-06-15 13:10:10 +02:00

8.4 KiB

title, intro, product, versions, shortTitle, topics
title intro product versions shortTitle topics
Configuring GitHub Copilot in Visual Studio Code You can enable, configure, and disable {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}. {% data reusables.gated-features.copilot %}
feature
copilot
Visual Studio Code
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 "Getting started with {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}."

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 Tab editor.action.inlineSuggest.commit
Dismiss an inline suggestion Esc editor.action.inlineSuggest.hide
Show next inline suggestion Option (⌥)+]
editor.action.inlineSuggest.showNext
Show previous inline suggestion Option (⌥)+[
editor.action.inlineSuggest.showPrevious
Trigger inline suggestion Option (⌥)+</kbd>
editor.action.inlineSuggest.trigger
Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane) Ctrl+Return 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 Tab editor.action.inlineSuggest.commit
Dismiss an inline suggestion Esc editor.action.inlineSuggest.hide
Show next inline suggestion Alt+] editor.action.inlineSuggest.showNext
Show previous inline suggestion Alt+[ editor.action.inlineSuggest.showPrevious
Trigger inline suggestion Alt+</kbd> editor.action.inlineSuggest.trigger
Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane) Ctrl+Enter 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 Tab editor.action.inlineSuggest.commit
Dismiss an inline suggestion Esc editor.action.inlineSuggest.hide
Show next inline suggestion Alt+] editor.action.inlineSuggest.showNext
Show previous inline suggestion Alt+[ editor.action.inlineSuggest.showPrevious
Trigger inline suggestion Alt+</kbd> editor.action.inlineSuggest.trigger
Open {% data variables.product.prodname_copilot %} (additional suggestions in separate pane) Ctrl+Enter 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. Screenshot of Visual Studio Code keyboard shortcuts
  2. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change. Screenshot of Keyboard shortcut search bar
  3. Next to the command you want to change, click the pencil icon. Screenshot of Keyboard shortcut editor
  4. Type the keystrokes you want to use for the command, then press Enter/Return. Screenshot of Edit keyboard shortcut textbox

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

You can enable or disable {% data variables.product.prodname_copilot %} from within {% data variables.product.prodname_vscode %}. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of the {% data variables.product.prodname_vscode %} window indicates whether {% data variables.product.prodname_copilot %} is enabled or disabled. When enabled, the background color of the icon will match the color of the status bar. When disabled, the background color of the icon will contrast the color of the status bar.

  1. To enable or disable {% data variables.product.prodname_copilot %}, click the status icon in the bottom panel of the {% data variables.product.prodname_vscode %} window. Screenshot of status icon in {% data variables.product.prodname_vscode %}
  2. If you are disabling {% data variables.product.prodname_copilot %}, Visual Studio Code will ask whether you want to disable it globally, or only for the language of the file you are currently editing. To disable globally, click Disable globally. Alternatively, click the language-specific button to disable {% data variables.product.prodname_copilot %} for the specified language. Screenshot of disable {% data variables.product.prodname_copilot %} globally or for the current language option

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 %}.

  1. In the File menu, navigate to Preferences and click Settings. Screenshot of {% data variables.product.prodname_vscode %} settings
  2. In the left-side panel of the settings tab, click Extensions and then select Copilot.
  3. 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."

  2. Under "Enable or disable Copilot for specified languages", click Edit in settings.json.

  3. 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.

    {
        "editor.inlineSuggest.enabled": true,
        "github.copilot.enable": {
            "*": true,
            "yaml": false,
            "plaintext": false,
            "markdown": true,
            "javascript": true,
            "python": true
        }
    }
    

{% data reusables.copilot.dotcom-settings %}