在环境中配置 GitHub Copilot

关于 JetBrains IDE 中的 GitHub Copilot

如果使用 JetBrains IDE，GitHub Copilot 可帮助你完成各种任务，包括生成代码建议、解释编辑器中的代码工作原理以及提供代码修复建议。 安装后，您可以启用或禁用 GitHub Copilot，而且可以在 IDE 或 GitHub 上配置高级设置。 本文介绍如何在 IntelliJ IDE 中配置 GitHub Copilot，但其他 JetBrains IDE 的用户界面可能有所不同。

Prerequisites

要在 JetBrains IDE 中配置 GitHub Copilot，必须先安装 GitHub Copilot 插件。 有关详细信息，请参阅 在环境中安装 GitHub Copilot 扩展。

启用或禁用 GitHub Copilot

可从 JetBrains IDE 启用或禁用 GitHub Copilot。 JetBrains 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 是启用还是禁用。 启用后，将突出显示图标。 禁用后，图标灰显。

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

   

2. 如果要禁用 GitHub Copilot，系统会询问是全局禁用它，还是要禁用当前正在编辑的文件的语言。 要全局禁用，请单击“禁用完成”****。 或者，单击特定于语言的按钮，为指定语言禁用 GitHub Copilot。

   

重新绑定键盘快捷方式

使用 GitHub Copilot 时，可以在 JetBrains IDE 中使用默认键盘快捷方式获取内联建议。 有关默认键盘快捷方式的列表，请参阅 IDE 中GitHub Copilot 的键盘快捷方式。

或者，可以将快捷方式重新绑定到每个特定命令的首选键盘快捷方式。 有关在 JetBrains IDE 中重新绑定键盘快捷方式的详细信息，请参阅 JetBrains 文档。 例如，可以查看 IntelliJ IDEA 文档。

配置 GitHub Copilot 的高级设置

可以在 JetBrains IDE 中管理 GitHub Copilot 的高级设置，例如，配置 IDE 如何展示内联建议，以及选择启用或禁用 GitHub Copilot 的编程语言。

1. 在 JetBrains IDE 中，单击“文件”**** 菜单 (Windows) 或菜单栏中的应用程序名称 (macOS)，然后单击“设置”****。1. 在左侧栏中，单击 工具，单击 GitHub Copilot，并查看 常规设置 和 代码补全 设置。
2. 根据个人首选项编辑设置。
   • 要调整代码建议的行为和外观，以及是否自动检查更新，请选中或取消选中相应的复选框。
   • 如果已选择接收自动更新，可以选择是接收稳定但频率较低的更新，还是接收可能不太稳定的夜间更新。 单击“更新通道”**** 下拉菜单，选择“稳定版”**** 以获取稳定更新，或选择“夜间版”**** 以获取夜间更新。

配置 GitHub Copilot 的语言设置

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

如果更改 github-copilot.xml 文件中的语言设置，则可以指定单个语言，也可以使用通配符为所有语言激活或停用 GitHub Copilot 。 还可以指定例外，用以替代指定语言的通配符设置。 例如，可以为 Python 和 YAML 以外的所有语言停用 GitHub Copilot。 在安装 GitHub Copilot 扩展时，默认为所有语言激活 GitHub Copilot。

在 IDE 中配置语言设置

1. 在 JetBrains IDE 中，单击“文件”**** 菜单 (Windows) 或菜单栏中的应用程序名称 (macOS)，然后单击“设置”****。1. 在左侧栏中，单击 工具，单击 GitHub Copilot，然后单击“ 完成”。
2. 在“语言”下，选择或取消选择要激活或停用 GitHub Copilot 的语言的复选框。
3. 单击“应用”，然后单击“确定”。
4. 重启 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>

还可以添加配置，让 languageAllowList 在 IDE 的设置中变为只读。 此举可阻止更改 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>

在 Copilot 上配置 GitHub.com

设置

如果您使用 Copilot Pro 计划，可以选择允许或阻止与公开可用代码匹配的行内建议。 还可允许或阻止收集和保留输入的提示和Copilot的建议。可在 GitHub.com的个人设置中配置它。 请参阅“以个人订阅者身份管理 GitHub Copilot 策略”。

在 GHE.com

上对帐户进行身份验证

如果在 Copilot 上使用 托管用户帐户 的 GHE.com 计划，则需要在登录之前更新一些设置。 请参阅“在 GHE.com 上将 GitHub Copilot 与帐户配合使用”。

其他阅读材料

• GitHub Copilot 常见问题解答