Configuring GitHub Copilot in your environment

About GitHub Copilot in Visual Studio Code

If you use Visual Studio Code, GitHub Copilot can autocomplete code as you type. After installation, you can enable or disable GitHub Copilot, and you can configure advanced settings within Visual Studio Code or on GitHub.com.

Prerequisites

To configure GitHub Copilot in Visual Studio Code, you must install the GitHub Copilot plugin. For more information, see "Getting started with GitHub Copilot."

Keyboard shortcuts for GitHub Copilot

You can use the default keyboard shortcuts in Visual Studio Code when using GitHub 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.

Keyboard shortcuts for macOS

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 (⌥)+\	editor.action.inlineSuggest.trigger
Open GitHub Copilot (additional suggestions in separate pane)	Ctrl+Return	github.copilot.generate
Toggle GitHub Copilot on/off	No default shortcut	github.copilot.toggleCopilot

Keyboard shortcuts for 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+\	editor.action.inlineSuggest.trigger
Open GitHub Copilot (additional suggestions in separate pane)	Ctrl+Enter	github.copilot.generate
Toggle GitHub Copilot on/off	No default shortcut	github.copilot.toggleCopilot

Keyboard shortcuts for 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+\	editor.action.inlineSuggest.trigger
Open GitHub Copilot (additional suggestions in separate pane)	Ctrl+Enter	github.copilot.generate
Toggle GitHub Copilot on/off	No default shortcut	github.copilot.toggleCopilot

Rebinding keyboard shortcuts

If you don't want to use the default keyboard shortcuts in Visual Studio Code when using GitHub Copilot, you can rebind the shortcuts in the Keyboard Shortcuts editor using your preferred keyboard shortcuts for each specific command.

Rebinding keyboard shortcuts for macOS

1. Click Code, click Preferences, then click Keyboard Shortcuts.

   

2. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.

3. Next to the command you want to change, click the pencil icon.

   

4. Type the keystrokes you want to use for the command, then press Enter/Return.

Rebinding keyboard shortcuts for Windows

1. Click the File menu, click Preferences, then click Keyboard Shortcuts.

   

2. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.

3. Next to the command you want to change, click the pencil icon.

   

4. Type the keystrokes you want to use for the command, then press Enter/Return.

Rebinding keyboard shortcuts for Linux

1. Click the File menu, click Preferences, then click Keyboard Shortcuts.

   

2. In the "Keyboard Shortcuts" editor, search for the command name of the keyboard shortcut you want to change.

3. Next to the command you want to change, click the pencil icon.

   

4. Type the keystrokes you want to use for the command, then press Enter/Return.

启用或禁用 GitHub Copilot

可以在 Visual Studio Code 中启用或禁用 GitHub Copilot。 Visual Studio Code 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是启用还是禁用。 启用后，图标的背景色将与状态栏颜色相匹配。 禁用后，图标的背景色将与状态栏颜色形成对比。

1. 若要启用或禁用 GitHub Copilot，请单击 Visual Studio Code 窗口底部面板中的状态图标。

   

2. 如果要禁用 GitHub Copilot，系统会询问是全局禁用建议，还是要禁用当前正在编辑的文件的语言。

   • 若要全局禁用 GitHub Copilot 的建议，请单击“全局禁用”。
   • 若要禁用指定语言的 GitHub Copilot 的建议，请单击“对 LANGUAGE 禁用”。

Enabling or disabling inline suggestions

You can choose to enable or disable inline suggestions for GitHub Copilot in Visual Studio Code.

1. 在“文件”菜单中，导航到“首选项”，然后单击“设置” 。

   

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 GitHub Copilot for specific languages

You can specify which languages you want to enable or disable GitHub Copilot for.

1. From the Visual Studio Code, 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 GitHub Copilot for. For example, to enable Python in GitHub 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
       }
   }
   

Revoking GitHub Copilot authorization

Visual Studio Code retains authorization to use GitHub Copilot through a particular GitHub account. If you want to prevent your GitHub account being used for GitHub Copilot on a device you no longer have access to, you can revoke authorization and then go through the authorization process again. The device you previously used will not have the new authorization.

1. 在任何页面的右上角，单击个人资料照片，然后单击“设置”。

   

2. 在边栏的“集成”部分中，单击 “应用程序”。

3. 单击“授权的 OAuth 应用程序”选项卡。

4. Click the ... next to GitHub for VS Code and click Revoke.

5. Click the Authorized GitHub Apps tab.

6. If the GitHub Copilot plugin is listed, click Revoke.

After revoking authorization, Visual Studio Code will be able to continue using GitHub Copilot in a current session for a maximum of 30 minutes. After that time, you will need to re-authorize GitHub Copilot for use in Visual Studio Code again.

Re-authorizing GitHub Copilot

After you have revoked authorization, if you want to continue using GitHub Copilot, you will need to complete the re-authorization process.

1. In the bottom left corner of Visual Studio Code, click the Accounts icon, hover over your username, and click Sign out.

   

2. In the "Visual Studio Code" pop-up, click Sign Out.

3. In the bottom left corner of Visual Studio Code, click the Accounts icon, hover over your username, and click Sign in with GitHub to use GitHub Copilot.

   

4. In your browser, GitHub will request the necessary permissions for GitHub Copilot. To approve these permissions, click Continue.

5. In the "Open Visual Studio Code?" pop-up, click Open Visual Studio Code.

Configuring proxy settings for GitHub Copilot

You can configure GitHub Copilot to connect through an HTTP proxy server in Visual Studio Code. GitHub Copilot supports basic HTTP proxy setups, with or without basic authentication.

1. 在“文件”菜单中，导航到“首选项”，然后单击“设置” 。

   

2. In the left-side panel of the settings tab, click Application and then select Proxy.

3. In the textbox under "Proxy", type the address of your proxy server, for example http://localhost:3128. Alternatively, GitHub Copilot will use the http_proxy and https_proxy variables from your environment.

4. Optionally, under "Proxy Authorization", click Edit in settings.json and add your required value to send as the Proxy-Authorization header for every network request.

5. Optionally, under "Proxy Strict SSL", select or deselect the checkbox to enable or disable strict SSL.

在 GitHub.com 上配置 GitHub Copilot 设置

在拥有处于活动状态的 GitHub Copilot 订阅后，可以在 GitHub 上的 GitHub Copilot 设置中为你的个人帐户调整 GitHub Copilot 设置。 无论在何处使用 GitHub Copilot，这些设置都适用。 可以配置 GitHub Copilot 提供的建议，以及 GitHub 使用你的遥测数据的方式。

启用或禁用重复检测

GitHub Copilot 包含筛选器，该筛选器用于检测与 GitHub 上的公共代码匹配的代码建议。 可以选择启用或禁用筛选器。 启用筛选器后，GitHub Copilot 会根据 GitHub 上的公共代码检查代码建议及其周围约 150 个字符的代码。 如果存在匹配或接近匹配，不会向你显示建议。

1. 在任何页面的右上角，单击个人资料照片，然后单击“设置”。

   1. 在左侧边栏中，单击“ GitHub Copilot”。

2. 在“与公共代码匹配的建议”下，选择下拉菜单，然后单击“允许”以允许与公共代码匹配的建议，或单击“阻止”以阻止与公共代码匹配的建议 。

3. 要确认新设置，请单击“保存”。

延伸阅读

• GitHub Copilot 常见问题解答

:help copilot