在您的环境中配置 GitHub Copilot

关于 JetBrains IDE 中的 GitHub Copilot

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

先决条件

要在 JetBrains IDE 中配置 GitHub Copilot，必须安装 GitHub Copilot 插件。更多信息请参阅 在您的环境中安装 GitHub Copilot 扩展。

启用或禁用 GitHub Copilot

您可以在 JetBrains IDE 中启用或禁用 GitHub Copilot。JetBrains 窗口底部面板中的 GitHub Copilot 状态图标指示当前是否已启用。启用时图标呈高亮状态，禁用时则呈灰色。

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

   

2. 如果您选择禁用 GitHub Copilot，系统会询问您是要全局禁用，还是仅对当前编辑文件的语言禁用。全局禁用请选择 Disable Completions（禁用补全）。或者，单击特定语言的按钮以在对应语言上禁用 GitHub Copilot。

   

重新绑定键盘快捷键

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

或者，您也可以为每个具体命令重新绑定为自己偏好的快捷键。有关在 JetBrains IDE 中重新绑定键盘快捷键的详细信息，请查阅 JetBrains 官方文档。例如，您可以查看 IntelliJ IDEA 文档。

为 GitHub Copilot 配置高级设置

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

1. 在您的 JetBrains IDE 中，点击 文件 菜单 (Windows)，或菜单栏中应用程序的名称 (macOS)，然后点击 设置。
2. 在左侧边栏中单击 Tools（工具），再单击 GitHub Copilot，随后查看 General（常规）和 Completions（补全）设置。
3. 根据个人偏好编辑这些设置。
   • 若要调整代码建议的行为与外观，以及是否自动检查更新，只需勾选或取消勾选对应的复选框。
   • 如果您选择自动更新，可在 Update channel（更新通道）下拉框中选择 Stable（稳定）以获取更少但更稳定的更新，或选择 Nightly（每日构建）以获取更频繁但可能不太稳定的更新。

为 GitHub Copilot 配置语言设置

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

如果在 github-copilot.xml 中更改语言设置，您可以列出具体语言，或使用通配符（*）一次性为所有语言激活或停用 Copilot。您还可以指定例外，以覆盖通配符对特定语言的设置。例如，可停用所有语言的 Copilot，除 Python 和 YAML 外。默认情况下，安装 GitHub Copilot 扩展后，它会对所有语言激活。

在 IDE 中配置语言设置

1. 在您的 JetBrains IDE 中，点击 文件 菜单 (Windows)，或菜单栏中应用程序的名称 (macOS)，然后点击 设置。
2. 在左侧边栏点击 Tools，点击 GitHub Copilot，然后点击 Completions。
3. 在 “Languages”（语言）章节下，勾选或取消勾选希望激活或停用 GitHub Copilot 的语言对应的复选框。
4. 单击 Apply（应用），随后单击 OK（确定）。
5. 重新启动 JetBrains IDE 以使更改生效。

编辑 github-copilot.xml 文件

若要在 github-copilot.xml 中配置语言设置，需要编辑 languageAllowList。每行均需包含键和值。键为语言名称，或使用通配符（*）。值只能是 true 或 false。值为 true 表示在该语言上激活 Copilot，值为 false 则表示停用。

该文件位于以下目录：

• 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> 标签之间添加一行或多行，以指定希望激活或停用 Copilot 的语言。例如，要停用所有语言的 Copilot：

   XML

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

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

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

示例语言配置

github-copilot.xml 的默认配置（为所有语言启用 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>

若要停用所有语言，将通配符（*）的值改为 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>

若要单独指定语言，请为每个想要激活或停用的语言添加一条记录。具体语言的设置会覆盖通配符。例如，要为 Python 和 YAML 启用 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>

在 GitHub.com 上配置 Copilot 设置

如果您使用 Copilot Pro 计划，可选择允许或阻止匹配公开代码的行内建议，也可选择是否允许收集和保留您输入的提示以及 Copilot 的建议。这些设置在 GitHub.com 的个人设置中完成。请参阅 作为个人订阅者管理 GitHub Copilot 策略。

在 GHE.com 上进行账户身份验证

如果您在 GHE.com 上使用托管用户账户的 Copilot 计划，则需要在登录前更新某些设置。请参阅 在 GHE.com 上使用 GitHub Copilot。

延伸阅读

• GitHub Copilot 常见问题