在您的环境中配置 GitHub Copilot

您可以在支持的 IDE 中启用、配置或禁用 GitHub Copilot。

谁可以使用此功能？

GitHub Copilot 个人版或 GitHub Copilot 企业版。

本文内容

关于 JetBrains IDE 中的 GitHub Copilot

如果您使用 JetBrains IDE，GitHub Copilot 可以在您键入时自动完成代码。安装后，您可以启用或禁用 GitHub Copilot，并且可以在 IDE 或 GitHub.com 上配置高级设置。本文介绍了如何在 IntelliJ IDE 中配置 GitHub Copilot，但其他 JetBrains IDE 的用户界面可能有所不同。

先决条件

要在 JetBrains IDE 中配置 GitHub Copilot，您必须安装 GitHub Copilot 插件。有关更多信息，请参阅“在您的编辑器中使用 GitHub Copilot 代码建议”。

使用或重新绑定 GitHub Copilot 的键盘快捷键

在使用 GitHub Copilot 时，您可以使用 JetBrains IDE 中的内联建议的默认键盘快捷键。或者，您可以将快捷键重新绑定到您为每个特定命令首选的键盘快捷键。有关在 JetBrains IDE 中重新绑定键盘快捷键的更多信息，请参阅 JetBrains 文档。例如，您可以查看 IntelliJ IDEA 文档。

macOS 的键盘快捷键

操作快捷键
接受内联建议Tab
Dismiss an inline suggestionEsc
Show next inline suggestionOption (⌥) or Alt+]
Show previous inline suggestionOption (⌥) or Alt+[
Trigger inline suggestionOption (⌥)+\
Open GitHub Copilot (additional suggestions in separate pane)Option (⌥) or Alt+Return

Keyboard shortcuts for Windows

操作快捷键
接受内联建议Tab
Dismiss an inline suggestionEsc
Show next inline suggestionAlt+]
Show previous inline suggestionAlt+[
Trigger inline suggestionAlt+\
Open GitHub Copilot (additional suggestions in separate pane)Alt+Enter

Keyboard shortcuts for Linux

操作快捷键
接受内联建议Tab
Dismiss an inline suggestionEsc
Show next inline suggestionAlt+]
Show previous inline suggestionAlt+[
Trigger inline suggestionAlt+\
Open GitHub Copilot (additional suggestions in separate pane)Alt+Enter

Enabling or disabling GitHub Copilot

您可以在 JetBrains IDE 中启用或禁用 GitHub Copilot。JetBrains 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是否已启用或禁用。启用时，图标会突出显示。禁用时，图标会变灰。

  1. 要启用或禁用 GitHub Copilot，请单击 JetBrains 窗口底部面板右侧的状态图标。

    Screenshot of the bottom panel in a JetBrains IDE. The GitHub Copilot status icon is outlined in dark orange.

  2. 如果您要禁用 GitHub Copilot，系统会询问您是否要全局禁用它，还是仅针对当前正在编辑的文件的语言禁用它。要全局禁用，请单击 **Disable Completions**。或者，单击特定于语言的按钮以禁用针对指定语言的 GitHub Copilot。

    Screenshot of the menu to disable GitHub Copilot globally or for the current language in a JetBrains IDE.

Configuring advanced settings for GitHub Copilot

您可以在 JetBrains IDE 中管理 GitHub Copilot 的高级设置，例如 IDE 如何显示代码补全以及您希望为哪些语言启用或禁用 GitHub Copilot。

  1. 在 JetBrains IDE 中，单击 **File** 菜单（Windows）或菜单栏中的应用程序名称（macOS），然后单击 **Settings**。
  2. 在 **Languages & Frameworks** 下，单击 **GitHub Copilot**。
  3. 根据您的个人喜好编辑设置。
    • 要调整代码建议的行为和外观，以及是否自动检查更新，请选中或取消选中相应的复选框。
    • 如果您已选择接收自动更新，您可以选择接收稳定但频率较低的更新，还是接收可能不太稳定的夜间更新。单击 **Update channel** 下拉菜单并选择 **Stable** 以获取稳定更新，或选择 **Nightly** 以获取夜间更新。

Configuring language settings for GitHub Copilot

您可以在 IDE 中或通过编辑您的 github-copilot.xml 文件来指定要为哪些语言激活或停用 GitHub Copilot。如果您在 IDE 中更改了语言设置，您可以单独选择和取消选择要激活或停用的语言。

如果您在 github-copilot.xml 文件中更改语言设置，您可以指定单个语言，也可以使用通配符来激活或停用所有语言的 GitHub Copilot。您还可以指定例外，这将覆盖为指定语言设置的通配符设置。例如，您可以停用所有语言的 GitHub Copilot，但 Python 和 YAML 除外。默认情况下，当您安装 GitHub Copilot 扩展时，GitHub Copilot 会为所有语言激活。

在 IDE 中配置语言设置

  1. 在 JetBrains IDE 中，单击 **File** 菜单（Windows）或菜单栏中的应用程序名称（macOS），然后单击 **Settings**。
  2. 在 **Languages & Frameworks** 下，单击 **GitHub Copilot**。
  3. 在“语言”下，选中或取消选中您要激活或停用 GitHub Copilot 的语言的复选框。
  4. 单击应用，然后单击确定。
  5. 重新启动您的 JetBrains IDE 以使更改生效。

编辑您的 github-copilot.xml 文件

要在 github-copilot.xml 文件中配置语言设置，您必须编辑 languageAllowList。您添加到 languageAllowList 的每一行都必须包含一个条目键和一个值。条目键是语言的名称，或（*）用于通配符。值为 true 或 false。如果值为 true，则为指定语言激活 GitHub Copilot。如果值为 false，则为指定语言停用 GitHub Copilot。

该文件位于以下目录中

  • macOS: ~/Library/Application Support/JetBrains/<product><version>/options/github-copilot.xml
  • Windows: %APPDATA%\JetBrains\<product><version>\options\github-copilot.xml
  • Linux: ~/.config/JetBrains/<product><version>/options/github-copilot.xml

例如，如果您在 macOS 上使用 IntelliJ IDEA 2021.1，则该文件位于 ~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xml。

github-copilot.xml 文件可能要到您在 IDE 设置中更改默认语言配置后才会生成。如果您找不到该文件，您应该尝试修改 IDE 中的默认语言设置。有关更多信息，请参阅“在 IDE 中配置语言设置”。

或者，您可以手动创建该文件并将其保存在上面列出的操作系统位置。有关更多信息，请参阅“示例语言配置”。

  1. 在文本编辑器中打开 github-copilot.xml 文件。

  2. 在 <map> 标签之间，添加您要激活或停用 GitHub Copilot 的语言的行或多行。例如，要停用所有语言的 GitHub Copilot

    XML
    <entry key="*" value="false" />

  3. 保存对 github-copilot.xml 文件的更改。

  4. 重新启动您的 JetBrains IDE 以使更改生效。

示例语言配置

github-copilot.xml 文件的默认配置如下，它为所有语言启用 GitHub Copilot。

XML
<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

要停用所有语言的 GitHub Copilot，将通配符 (*) 值更改为 false。

XML
<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
      </map>
    </languageAllowList>
  </component>
</application>

要单独指定语言，请为要激活或停用 GitHub Copilot 的每种语言添加一个条目。特定语言设置将覆盖通配符。例如，要激活 Python 和 YAML 的 GitHub Copilot，并停用所有其他语言的 GitHub Copilot，请添加以下条目。

XML
<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
        <entry key="Python" value="true" />
        <entry key="YAML" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

您还可以添加一个配置，在 IDE 的设置中使 languageAllowList 只读。这将阻止您在 IDE 中更改语言设置。例如

XML
<application>
  <component name="github-copilot">
    <option name="languageAllowListReadOnly" value="true" />
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

在 GitHub.com 上配置 GitHub Copilot 设置

如果您使用的是 GitHub Copilot 个人订阅，您可以选择允许或阻止与公开可用代码匹配的代码完成建议。您还可以允许或阻止收集和保留您输入的提示和 Copilot 的建议。您可以在 GitHub.com 上的个人设置中配置此选项。请参阅 "作为个人订阅者管理 Copilot 策略。"。

进一步阅读

关于 Visual Studio 中的 GitHub Copilot

如果您使用 Visual Studio，GitHub Copilot 可以在您键入时自动完成代码。安装后，您可以启用或禁用 GitHub Copilot，并且可以在 Visual Studio 或 GitHub.com 上配置高级设置。

先决条件

要在 Visual Studio 中配置 GitHub Copilot，您必须安装 GitHub Copilot 插件。有关更多信息，请参阅 "在您的编辑器中使用 GitHub Copilot 代码建议。"。

使用或重新绑定 GitHub Copilot 的键盘快捷键

在使用 GitHub Copilot 时，您可以使用 Visual Studio 中的默认键盘快捷键。或者，您可以在 Visual Studio 的工具设置中重新绑定快捷键，使用您喜欢的键盘快捷键来执行每个特定命令。您可以在键盘快捷键编辑器中按命令名称搜索每个键盘快捷键。

使用默认键盘快捷键

操作快捷键命令名称
Show next inline suggestionAlt+.Edit.NextSuggestion
Show previous inline suggestionAlt+,Edit.PreviousSuggestion
Trigger inline suggestionCtrl+Alt+\Edit.Copilot.TriggerInlineSuggestion

重新绑定键盘快捷键

如果您不想在使用 GitHub Copilot 时使用 Visual Studio 中的默认键盘快捷键，可以在键盘编辑器中重新绑定快捷键，使用您喜欢的键盘快捷键来执行每个特定命令。

  1. 在 Visual Studio 菜单栏中，在 **工具** 下，单击 **选项**。

    Screenshot of the Visual Studio menu bar. The "Tools" menu is expanded, and the "Options" item is highlighted with an orange outline.

  2. 在“选项”对话框中，在 **环境** 下，单击 **键盘**。

  3. 在“显示包含的命令”下，搜索您要重新绑定的命令。

    Screenshot of the "Show commands containing" search bar. The string "tools.next" is entered in the search field.

  4. 在“按快捷键”下，键入要分配给该命令的快捷键，然后单击 **分配**。

    Screenshot of the fields for entering a new keyboard shortcut assignment.

Enabling or disabling GitHub Copilot

Visual Studio 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是启用还是禁用。启用时，图标的背景颜色将与状态栏的颜色匹配。禁用时，图标上将有一条斜线。

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

    Screenshot of editor margin in Visual Studio with the GitHub Copilot icon emphasized.

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

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

为 GitHub Copilot 配置 ReSharper

如果您使用 ReSharper，当您将 ReSharper 配置为使用 GitHub Copilot 的原生 IntelliSense 时，GitHub Copilot 可能效果最佳。有关 ReSharper 的更多信息，请参阅 ReSharper 文档

  1. 在 Visual Studio 菜单栏中，在 **扩展** 下，单击 **ReSharper**，然后单击 **选项**。
  2. 在“选项”对话框中，在 **环境** 下，单击 **IntelliSense**，然后单击 **常规**。
  3. 在“常规”下，选择 **Visual Studio**，然后单击 **保存**。

在 GitHub.com 上配置 GitHub Copilot 设置

如果您使用的是 GitHub Copilot 个人订阅，您可以选择允许或阻止与公开可用代码匹配的代码完成建议。您还可以允许或阻止收集和保留您输入的提示和 Copilot 的建议。您可以在 GitHub.com 上的个人设置中配置此选项。请参阅 "作为个人订阅者管理 Copilot 策略。"。

进一步阅读

关于 Visual Studio Code 中的 GitHub Copilot

如果您使用 Visual Studio Code，您可以使用 GitHub Copilot 来

  • 生成代码
  • 从 Copilot 生成的代码中学习
  • 帮助您配置编辑器

您可以在 VS Code 文档 中了解更多关于场景和设置的信息。

安装 GitHub Copilot 扩展后，您可以启用或禁用它，并且可以在 Visual Studio Code 或 GitHub.com 中配置高级设置。

先决条件

要在 Visual Studio Code 中配置 GitHub Copilot，您必须安装 GitHub Copilot 扩展。有关更多信息，请参阅“在您的编辑器中使用 GitHub Copilot 代码建议”。

GitHub Copilot 的键盘快捷键

您可以在 GitHub Copilot 中使用 GitHub Copilot 的默认键盘快捷键。在键盘快捷键编辑器中按命令名称搜索键盘快捷键。

或者，您可以在键盘快捷键编辑器中重新绑定每个命令的快捷键。有关更多信息，请参阅 VS Code 文档中的键绑定。

macOS 的键盘快捷键

操作快捷键命令名称
接受内联建议Tabeditor.action.inlineSuggest.commit
Dismiss an inline suggestionEsceditor.action.inlineSuggest.hide
Show next inline suggestionOption (⌥)+]
editor.action.inlineSuggest.showNext
Show previous inline suggestionOption (⌥)+[
editor.action.inlineSuggest.showPrevious
Trigger inline suggestionOption (⌥)+\
editor.action.inlineSuggest.trigger
Open GitHub Copilot (additional suggestions in separate pane)Ctrl+Returngithub.copilot.generate
切换 GitHub Copilot 开启/关闭无默认快捷键github.copilot.toggleCopilot

Keyboard shortcuts for Windows

操作快捷键命令名称
接受内联建议Tabeditor.action.inlineSuggest.commit
Dismiss an inline suggestionEsceditor.action.inlineSuggest.hide
Show next inline suggestionAlt+]editor.action.inlineSuggest.showNext
Show previous inline suggestionAlt+[editor.action.inlineSuggest.showPrevious
Trigger inline suggestionAlt+\editor.action.inlineSuggest.trigger
Open GitHub Copilot (additional suggestions in separate pane)Ctrl+Entergithub.copilot.generate
切换 GitHub Copilot 开启/关闭无默认快捷键github.copilot.toggleCopilot

Keyboard shortcuts for Linux

操作快捷键命令名称
接受内联建议Tabeditor.action.inlineSuggest.commit
Dismiss an inline suggestionEsceditor.action.inlineSuggest.hide
Show next inline suggestionAlt+]editor.action.inlineSuggest.showNext
Show previous inline suggestionAlt+[editor.action.inlineSuggest.showPrevious
Trigger inline suggestionAlt+\editor.action.inlineSuggest.trigger
Open GitHub Copilot (additional suggestions in separate pane)Ctrl+Entergithub.copilot.generate
切换 GitHub Copilot 开启/关闭无默认快捷键github.copilot.toggleCopilot

Enabling or disabling GitHub Copilot

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

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

    Screenshot of the bottom panel in Visual Studio Code. The GitHub Copilot icon is outlined in dark orange.

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

    • 要全局禁用 GitHub Copilot 的建议，请单击“全局禁用”。
    • 要禁用 GitHub Copilot 对指定语言的建议，请单击“禁用 LANGUAGE”。
      Screenshot of option to disable GitHub Copilot globally or for the current language.

启用或禁用内联建议

您可以选择在 Visual Studio Code 中启用或禁用 GitHub Copilot 的内联建议。

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

    Screenshot of Visual Studio Code settings.

  2. 在设置选项卡的左侧面板中，单击**扩展**，然后选择**Copilot**。

  3. 在“内联建议：启用”下，选中或取消选中复选框以启用或禁用内联建议。

为特定语言启用或禁用 GitHub Copilot

您可以指定要为哪些语言启用或禁用 GitHub Copilot。

  1. 从 Visual Studio Code 中，单击**扩展**选项卡，然后导航到**Copilot** 部分。有关更多信息，请参阅“启用或禁用内联建议”。

  2. 在“为指定语言启用或禁用 Copilot”下，单击**在 settings.json 中编辑**。

  3. 在settings.json 文件中，添加或删除要为其启用或禁用 GitHub Copilot 的语言。例如，要启用 GitHub Copilot 中的 Python，请将"python": true 添加到列表中，确保在除最后一个列表项之外的所有列表项之后都有一个尾随逗号。

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

撤销 GitHub Copilot 授权

Visual Studio Code 通过特定 GitHub 帐户保留使用 GitHub Copilot 的授权。如果您想阻止您的 GitHub 帐户在您不再有权访问的设备上用于 GitHub Copilot，您可以撤销授权，然后再次进行授权过程。您之前使用的设备将不会拥有新的授权。

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

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

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

    Screenshot of the "Applications" page. A tab, labeled "Authorized OAuth Apps," is highlighted with an orange outline.

  4. 点击 **GitHub for VS Code** 旁边的 **...**，然后点击 **撤销**。

  5. 点击 **已授权的 GitHub 应用** 选项卡。

  6. 如果列出了 **GitHub Copilot** 扩展，请点击 **撤销**。

撤销授权后，Visual Studio Code 可以在当前会话中继续使用 GitHub Copilot 最多 30 分钟。之后，您需要重新授权 GitHub Copilot 才能在 Visual Studio Code 中使用。

重新授权 GitHub Copilot

撤销授权后，如果您想继续使用 GitHub Copilot，则需要完成重新授权过程。

  1. 在 Visual Studio Code 的左下角，点击 **帐户** 图标，将鼠标悬停在您的用户名上，然后点击 **注销**。

    Screenshot of the menu in Visual Studio Code. The "Sign out" option is outlined in dark orange.

  2. 在“Visual Studio Code”弹出窗口中，点击 **注销**。

  3. 在 Visual Studio Code 的左下角，点击 **帐户** 图标，将鼠标悬停在您的用户名上，然后点击 **使用 GitHub 登录以使用 GitHub Copilot**。

    Screenshot of the accounts menu in Visual Studio Code. The "Sign in with GitHub to use GitHub Copilot (1)" option is outlined in dark orange.

  4. 在您的浏览器中，GitHub 将请求 GitHub Copilot 所需的权限。要批准这些权限，请点击 **继续**。

  5. 在“打开 Visual Studio Code？”弹出窗口中，点击 **打开 Visual Studio Code**。

在 GitHub.com 上配置 GitHub Copilot 设置

如果您使用的是 GitHub Copilot 个人订阅，您可以选择允许或阻止与公开可用代码匹配的代码完成建议。您还可以允许或阻止收集和保留您输入的提示和 Copilot 的建议。您可以在 GitHub.com 上的个人设置中配置此选项。请参阅 "作为个人订阅者管理 Copilot 策略。"。

进一步阅读

在 Vim/Neovim 中配置 GitHub Copilot

有关在 Vim/Neovim 中配置 GitHub Copilot 的指南，请通过运行以下命令在 Vim/Neovim 中调用 GitHub Copilot 文档

:help copilot

重新绑定键盘快捷键

在使用 GitHub Copilot 时，您可以重新绑定 Vim/Neovim 中的键盘快捷键，以便为每个特定命令使用您喜欢的键盘快捷键。有关更多信息，请参阅 Neovim 文档中的 Map 文章。

在 GitHub.com 上配置 GitHub Copilot 设置

如果您使用的是 GitHub Copilot 个人订阅，您可以选择允许或阻止与公开可用代码匹配的代码完成建议。您还可以允许或阻止收集和保留您输入的提示和 Copilot 的建议。您可以在 GitHub.com 上的个人设置中配置此选项。请参阅 "作为个人订阅者管理 Copilot 策略。"。

进一步阅读