Using extensions to integrate external tools with Copilot Chat

You can use Copilot 扩展 to interact with external tools in GitHub Copilot Chat.

谁可以使用此功能？

拥有 Copilot 专业版、Copilot Pro+ 或 Copilot 免费版 计划的任何人都可以使用 Copilot 扩展。

对于拥有 Copilot Business 或 Copilot Enterprise 计划的组织或企业，组织所有者和企业管理员可以授予对 Copilot 扩展 的访问权限。

Copilot 扩展 不适用于 GitHub Enterprise Server。

本文内容

About GitHub Copilot 扩展

GitHub Copilot 扩展 是一种将外部工具的的强大功能集成到 GitHub Copilot Chat 中的 GitHub App****。 Copilot 扩展 可由任何人开发，用于私人或公共用途，并且可以通过 GitHub Marketplace 与他人共享。

注意

GitHub Copilot 扩展 are not the same as the GitHub Copilot extension, which you install in your IDE to use default Copilot functionality like code completion and GitHub Copilot Chat. For more information on the GitHub Copilot extension, see Installing the GitHub Copilot extension in your environment.

You can get started with Copilot 扩展 in one of two ways:

You can interact with your custom-built or installed extension in a Copilot Chat conversation, asking questions and performing actions that combine the capabilities of the external tool and GitHub. For example, if you install the Sentry extension for GitHub Copilot, you can use the extension to get information about Sentry issues, then create and assign related tracking issues on GitHub.

Copilot 扩展 provide several benefits, including:

  • Interaction with external tools using natural language
  • Reduced context switching
  • Customization of your Copilot Chat experience for your developer flow

Copilot 扩展 are included in all Copilot subscriptions.

Supported clients and IDEs

客户端和 IDEGitHub Copilot 扩展 支持
Visual Studio Code
Visual Studio
GitHub.com
GitHub Mobile
JetBrains IDE
GitHub Codespaces
Vim/Neovim
Copilot（CLI 版）
Xcode

Prerequisites

If you have a Copilot 专业版 subscription, you need to install a Copilot 扩展 before you can use the extension in Copilot Chat. See Extending the capabilities of GitHub Copilot in your personal account.

If you have access to Copilot through a Copilot Business or Copilot Enterprise subscription:

  1. An organization owner or enterprise owner needs to enable the Copilot 扩展 policy for your organization or enterprise. See Managing policies for Copilot in your organization and Managing policies and features for Copilot in your enterprise in the GitHub Enterprise Cloud documentation.
  2. An organization owner needs to install Copilot 扩展 for your organization. See Extending the capabilities of GitHub Copilot in your organization.

Using GitHub Copilot 扩展

  1. To start using a Copilot 扩展, open a supported Copilot Chat interface. See Supported clients and IDEs.

  2. To see a list of all Copilot 扩展 available in your Copilot Chat conversation, in the Copilot Chat text box, type @.

    注意

    If you are using Copilot Chat in an IDE, and you or your organization owner install a Copilot 扩展 while your IDE is open, you need to restart your IDE to begin using the Copilot 扩展.

  3. In the list of available Copilot 扩展, click the one you want to use.

  4. To begin interacting with the Copilot 扩展, in the Copilot Chat text box, ask the extension to answer a question or perform an action, then press Enter. For each new request, be sure to include @EXTENSION-NAME at the beginning of your sentence.

    • If you did not install the Copilot 扩展 yourself, and it is your first time using the Copilot 扩展, you will be asked to authorize the extension. See 授权 GitHub Apps.
    • If you ask a Copilot 扩展 to perform an action, you need to confirm the extension has your permission to act on your behalf before it will complete the task. After carefully reviewing the proposed action, in the confirmation dialog, click Allow or Dismiss.

Tips for using GitHub Copilot 扩展

  • When you are using a Copilot 扩展, consider how you would interact with the tool outside of Copilot Chat, then use natural language to ask questions and assign tasks that integrate the capabilities of the tool with GitHub. For example, Sentry is an application monitoring software with a Copilot 扩展. The following are some example prompts for the Sentry extension for GitHub Copilot:

    • @sentry list my most recent issues
    • @sentry tell me more about issue ISSUE-ID-OR-ISSUE-LINK
    • @sentry create a GitHub issue for the most recent Sentry issue and assign it to @DEVELOPER

    For information on the best ways to use a specific Copilot 扩展, read the description of the extension on GitHub Marketplace.

  • Interactions with one Copilot 扩展 will never be shared with another Copilot 扩展. To interact with different Copilot 扩展 in an IDE, change the @EXTENSION-NAME at the beginning of each sentence. Interactions with different extensions will appear in the same Copilot Chat window, but the conversations themselves are automatically separated.

    To interact with different Copilot 扩展 on GitHub.com, you need to start a new conversation for each extension by clicking at the top of the Copilot Chat window.

Additional resources

For questions and issues related to GitHub Copilot 扩展, please use the following resources:

  • General issues for users and builders: Visit the GitHub Support Portal.
  • Requests or feedback for GitHub: Use the GitHub Community Discussion Thread.
  • Requests or feedback for third-party extension publishers: File an issue in the User Feedback Repo and add a label with the extension's slug name.
  • GitHub Technology Partners: Email the partnerships team directly for assistance.
  • 启用 Copilot 的 Visual Studio Code 扩展: For more information on this type of Copilot 扩展, see Chat extensions in the Visual Studio Code documentation.

注意

GitHub 支持 is not able to answer questions regarding 启用 Copilot 的 Visual Studio Code 扩展, as this implementation path is owned and maintained by the VS Code team.

Further reading