About Copilot 扩展
Copilot 扩展 are integrations that expand the functionality of Copilot 对话助手, allowing developers to bring external tools, services, and custom behaviors into the Chat experience. You can use Copilot 扩展 to extend the capabilities of Copilot 对话助手 in a variety of ways, including:
- Querying documentation: A Copilot 扩展 can allow Copilot 对话助手 to query a third-party documentation service to find information about a specific topic.
- AI-assisted coding: A Copilot 扩展 can use a third-party AI model to provide code suggestions.
- Data retrieval: A Copilot 扩展 can allow Copilot 对话助手 to query a third-party data service to retrieve information about a specific topic.
- Action execution: A Copilot 扩展 can allow Copilot 对话助手 to execute a specific action, such as posting to a message board or updating a tracking item in an external system.
GitHub Copilot 扩展 are built with GitHub Apps. They are best suited for developers who want cross-platform compatibility and app management and support from GitHub.
Supported clients and IDEs
| 客户端和 IDE | GitHub Copilot 扩展 支持 |
|---|---|
| Visual Studio Code | |
| Visual Studio | |
| GitHub.com | |
| GitHub Mobile | |
| JetBrains IDE | |
| GitHub Codespaces | |
| Vim/Neovim | |
| Copilot（CLI 版） | |
| Xcode |
Visibility of GitHub Copilot 扩展
GitHub Copilot 扩展 can be private, public and shareable, or public and listed on the GitHub Marketplace. Which visibility option you choose will depend on your use case and the audience you are targeting.
- Private extensions are often preferred by large enterprises or companies that:
- Want more customization and controls over data access
- Need to integrate with a large volume of internal documents and databases
- Have strict security policies making it difficult to authorize permissions for third-parties
- Public extensions are suitable for:
- Open-source projects
- Collaborative development and use across organizations within an enterprise
- Sharing your tool and getting feedback before publishing to the GitHub Marketplace
- GitHub Marketplace extensions are ideal for third-parties that want to:
- Offer their service to a broader audience
- Integrate their tool into the developer workflow on GitHub and the IDE
- Leverage the GitHub ecosystem to raise awareness for their product
GitHub Copilot 扩展 permissions
Permissions vary by extension, depending on the level of authorization that the extension requires in order to respond to your query. You can view the required permissions on the extension’s installation page, located after the billing information step and before the install and authorize step.
For extension users: At a minimum, the Copilot 对话助手 permissions must be set to "Read-only". Additional permissions may include executing write actions on other surfaces and authorizing read access to repository and organization level data in GitHub.
For extension creators: In addition to the above, you may also request local context from a user’s editor to further tailor responses. To do so, the Copilot Editor Context permissions must be set to "Read-only". Users will be notified to provide the required authorization.
For more information on GitHub App permissions, see 为 GitHub Apps 选择权限.
Granting permissions to access organization resources
Users with an individual Copilot subscription can install and use Copilot 扩展. Users with a Copilot Business or Copilot Enterprise subscription need an organization administrator to enable this feature.
Only organization administrators can grant permissions for Copilot 扩展 to access organization resources.
To grant organization members access, the organization administrator must:
- Install the extension
- Grant the extension permission to access specific repositories
- Authorize access for all, or specific repositories
Controlling access at the enterprise level
If you are an enterprise administrator, you can disable Copilot 扩展 across your enterprise by setting the Copilot 扩展 policy to "Disabled". The "No Policy" setting allows organization administrators to set their own policy.
No, there is no allowlist or blocklist at the enterprise level.
Sharing data with Copilot 扩展
The following data is shared when you interact with Copilot 扩展:
- Data attached to your account and Copilot 对话助手 usage, such as GitHub user ID, and timestamps of messages.
- Past messages within the chat thread where you are invoking an extension. Only one extension can be used per thread, preventing data sharing across extensions. The data retention period for thread context is 30 days.
- Any additional organization and repository data that is authorized for the extension by your organization administrator. Administrators installing extensions must approve access to the required permissions prior to completing installation.
- For GitHub 中的 Copilot Chat, if your administrator has approved the extension to access repository or organization metadata, that data will be shared as well.