Skip to main content

在环境中配置 GitHub Copilot

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

谁可以使用此功能?

GitHub Copilot Individual 或 GitHub Copilot Business。

关于 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 在 IDE 中获取代码建议”。

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

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

macOS 键盘快捷方式

操作快捷键
接受内联建议选项卡
忽略内联建议Esc
显示下一个内联建议Option (⌥) 或 Alt+]
显示上一个内联建议Option (⌥) 或 Alt+[
触发内联建议选项 (⌥)+\
打开 GitHub Copilot(单独窗格中的其他建议)Option (⌥) 或 Alt+Return

Windows 键盘快捷方式

操作快捷键
接受内联建议选项卡
忽略内联建议Esc
显示下一个内联建议Alt+]
显示上一个内联建议Alt+[
触发内联建议Alt+\
打开 GitHub Copilot(单独窗格中的其他建议)Alt+Enter

Linux 键盘快捷方式

操作快捷键
接受内联建议选项卡
忽略内联建议Esc
显示下一个内联建议Alt+]
显示上一个内联建议Alt+[
触发内联建议Alt+\
打开 GitHub Copilot(单独窗格中的其他建议)Alt+Enter

启用或禁用 GitHub Copilot

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

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

    JetBrains IDE 中底部面板的屏幕截图。 GitHub Copilot 状态图标用深橙色框标出。

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

    全局或在 JetBrains IDE 中为当前语言禁用 GitHub Copilot 的菜单的屏幕截图。

配置 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 的每一行都必须包含一个条目键和一个值。 条目键表示语言名称,(*) 表示通配符。 该值为 truefalse。 如果值为 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 的 github-copilot.xml 文件的默认配置如下所示:

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>

还可以添加配置,让 languageAllowList 在 IDE 的设置中变为只读。 此举可阻止更改 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 Individual 订阅,则可选择允许或阻止与公开可用的代码匹配的代码完成建议。 还可允许或阻止收集和保留输入的提示和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 在 IDE 中获取代码建议”。

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

使用 GitHub Copilot 时,可使用 Visual Studio 中的默认键盘快捷方式。 或者,可使用每个特定命令的首选键盘快捷方式重新绑定 Visual Studio 的“工具设置”中的快捷方式。 可以在键盘快捷方式编辑器中按命令名称搜索每个键盘快捷方式。

使用默认键盘快捷方式

操作快捷键命令名称
显示下一个内联建议Alt+.Edit.NextSuggestion
显示上一个内联建议Alt+,Edit.PreviousSuggestion
触发内联建议Ctrl+Alt+\Edit.Copilot.TriggerInlineSuggestion

重新绑定键盘快捷方式

如果不想在使用 GitHub Copilot 时使用 Visual Studio 中的默认键盘快捷方式,可使用每个特定命令的首选键盘快捷方式在键盘编辑器中重新绑定快捷方式。

  1. 在 Visual Studio 菜单栏中的“工具”下,单击“选项” 。

    Visual Studio 菜单栏的屏幕截图。 “工具”菜单已展开,“选项”项以橙色边框突出显示。

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

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

    “显示命令包含”搜索栏的屏幕截图。 在搜索字段中输入字符串“tools.next”。

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

    用于输入新键盘快捷方式分配的字段的屏幕截图。

启用或禁用 GitHub Copilot

Visual Studio 窗口底部面板中的 GitHub Copilot 状态图标指示 GitHub Copilot 启用还是禁用。 启用后,图标的背景色将与状态栏颜色相匹配。 禁用后,将有一条对角线穿过它。

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

    Visual Studio 中编辑器边距的屏幕截图,其中突出显示 GitHub Copilot 图标。

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

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

为 GitHub Copilot 配置 ReSharper

如果使用 ReSharper,当你将 ReSharper 配置为使用 GitHub Copilot 的本机 IntelliSense 时,GitHub Copilot 可能效果最佳。 有关 ReSharper 的详细信息,请参阅 ReSharper 文档

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

在 GitHub.com

上配置 GitHub Copilot 设置

如果使用 GitHub Copilot Individual 订阅,则可选择允许或阻止与公开可用的代码匹配的代码完成建议。 还可允许或阻止收集和保留输入的提示和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 在 IDE 中获取代码建议”。

GitHub Copilot 的键盘快捷方式

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

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

macOS 键盘快捷方式

操作快捷键命令名称
接受内联建议选项卡editor.action.inlineSuggest.commit
忽略内联建议Esceditor.action.inlineSuggest.hide
显示下一个内联建议Option (⌥)+]
editor.action.inlineSuggest.showNext
显示上一个内联建议Option (⌥)+[
editor.action.inlineSuggest.showPrevious
触发内联建议选项 (⌥)+\
editor.action.inlineSuggest.trigger
打开 GitHub Copilot(单独窗格中的其他建议)Ctrl+Returngithub.copilot.generate
开启/关闭 GitHub Copilot没有默认快捷方式github.copilot.toggleCopilot

Windows 键盘快捷方式

操作快捷键命令名称
接受内联建议选项卡editor.action.inlineSuggest.commit
忽略内联建议Esceditor.action.inlineSuggest.hide
显示下一个内联建议Alt+]editor.action.inlineSuggest.showNext
显示上一个内联建议Alt+[editor.action.inlineSuggest.showPrevious
触发内联建议Alt+\editor.action.inlineSuggest.trigger
打开 GitHub Copilot(单独窗格中的其他建议)Ctrl+Entergithub.copilot.generate
开启/关闭 GitHub Copilot没有默认快捷方式github.copilot.toggleCopilot

Linux 键盘快捷方式

操作快捷键命令名称
接受内联建议选项卡editor.action.inlineSuggest.commit
忽略内联建议Esceditor.action.inlineSuggest.hide
显示下一个内联建议Alt+]editor.action.inlineSuggest.showNext
显示上一个内联建议Alt+[editor.action.inlineSuggest.showPrevious
触发内联建议Alt+\editor.action.inlineSuggest.trigger
打开 GitHub Copilot(单独窗格中的其他建议)Ctrl+Entergithub.copilot.generate
开启/关闭 GitHub Copilot没有默认快捷方式github.copilot.toggleCopilot

启用或禁用 GitHub Copilot

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

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

    Visual Studio Code 中底部面板的屏幕截图。 GitHub Copilot 图标用深橙色框标出。

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

    • 若要全局禁用 GitHub Copilot 的建议,请单击“全局禁用”。
    • 若要禁用指定语言的 GitHub Copilot 的建议,请单击“对 LANGUAGE 禁用”。
      全局或为当前语言禁用 GitHub Copilot 的选项的屏幕截图。

启用或禁用内联建议

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

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

    Visual Studio Code 设置的屏幕截图。

  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 应用”选项卡。

    “应用程序”页的屏幕截图。 标有“授权的 OAuth 应用”的选项卡以橙色边框突出显示。

  4. 单击用于 VS Code 的 GitHub 旁边的“...”,然后单击“撤销” 。

  5. 单击“授权的 GitHub Apps”选项卡。

  6. 如果列出了 GitHub Copilot 扩展,请单击“撤销”。****

撤销授权后,Visual Studio Code 将能够在当前会话中继续使用 GitHub Copilot 最多 30 分钟。 之后,你将需要重新授权 GitHub Copilot 以再次在 Visual Studio Code 中使用。

重新授权 GitHub Copilot

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

  1. 在 Visual Studio Code 的左下角,单击“帐户”图标,将鼠标悬停在用户名上,然后单击“退出登录” 。

    Visual Studio Code 中的菜单的屏幕截图。 “退出登录”选项以深橙色框出。

  2. 在“Visual Studio Code”弹出窗口中,单击“退出登录”。

  3. 在 Visual Studio Code 的左下角,单击“帐户”图标,将鼠标悬停在用户名上,然后单击“使用 GitHub 登录以使用 GitHub Copilot” 。

    Visual Studio Code 中的帐户菜单的屏幕截图。 “使用 GitHub 登录以使用 GitHub Copilot (1)”选项以深橙色框出。

  4. 在浏览器中,GitHub 将请求 GitHub Copilot 所需的权限。 若要批准这些权限,请单击“继续”。

  5. 在“打开 Visual Studio Code?” 弹出窗口中,单击“打开 Visual Studio Code”。

在 GitHub.com

上配置 GitHub Copilot 设置

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

其他阅读材料

在 Vim/Neovim 中配置 GitHub Copilot

有关在 Vim/Neovim 中配置 GitHub Copilot 的指导,请运行以下命令,在 Vim/Neovim 中调用 GitHub Copilot 文档:

:help copilot

重新绑定键盘快捷方式

使用 GitHub Copilot 为每个特定命令使用首选键盘快捷方式时,可以在 Vim/Neovim 中重新绑定键盘快捷方式。 有关详细信息,请参阅 Neovim 文档中的映射一文。

在 GitHub.com

上配置 GitHub Copilot 设置

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

其他阅读材料