在你的环境中配置 GitHub Copilot

关于 JetBrains IDE 中的 GitHub Copilot

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

先决条件

要在 JetBrains IDE 中配置 GitHub Copilot，你必须安装 GitHub Copilot 插件。更多信息，请参阅 "在你的 IDE 中使用 GitHub Copilot 获取代码建议."

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

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

macOS 键盘快捷键

Windows 键盘快捷键

Linux 键盘快捷键

启用或禁用 GitHub Copilot

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

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

   

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

   

配置 GitHub Copilot 的高级设置

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

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

配置 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 中，单击**文件**菜单（Windows）或菜单栏中的应用程序名称（macOS），然后单击**设置**。
2. 在**语言和框架**下，单击**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`。

在对 IDE 设置中的默认语言配置进行更改之前，可能不会生成 `github-copilot.xml` 文件。如果你找不到该文件，则应尝试修改 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）如下所示

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

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

要停用所有语言的 GitHub Copilot，将通配符（`*`）值更改为 `false`

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

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

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

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

<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 中更改语言设置。例如

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

<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 策略”。

进一步阅读

• GitHub Copilot 常见问题