text
stringlengths
12
91.7k
metadata
dict
About let you save recurring agent tasks and run them on a schedule or on demand. For example, you can create an that triages new issues daily or checks your open pull requests for review status each morning. You can create and manage from: The Agents tab in a repository on , in the pane. The tab in the . For a...
{ "source": "github-docs/copilot/how-tos/github-copilot-app/using-automations.md", "title": "Using automations in the GitHub Copilot app" }
About canvas extensions A canvas extension is a shared, interactive surface for a work artifact, such as a plan, triage board, browser session, release checklist, dashboard, incident, or spreadsheet. While chat is useful for defining intent and discussing tasks, most work happens in work surfaces such as a terminal, a ...
{ "source": "github-docs/copilot/how-tos/github-copilot-app/working-with-canvas-extensions.md", "title": "Working with canvas extensions in the GitHub Copilot app" }
When you're adopting in an enterprise, you will want to set budgets and track spending to ensure your rollout is sustainable. offers billing tools to help you visualize your spending patterns, control consumption with budget controls, receive alerts when you reach budget thresholds, and optimize your license usage. ...
{ "source": "github-docs/copilot/how-tos/manage-and-track-spending/manage-company-spending.md", "title": "Managing your company's spending on GitHub Copilot" }
You can track your monthly usage of to help you get the most value from your plan. How to view your usage depends on the plan you are on. For or users If you access through a or plan, you can see your individual consumption under the settings page. 1. Under Usage, review Usage this cycle to see your consump...
{ "source": "github-docs/copilot/how-tos/manage-and-track-spending/monitor-ai-usage.md", "title": "Monitoring your {% data variables.product.prodname_ai_credits %} usage" }
is automatically disabled when you have a paid plan, or when you are granted a license through an organization or enterprise. If you want to disable without subscribing to a paid plan, you can do so in your IDE and in . Disabling in You can disable in your account settings. This will disable all features of on ...
{ "source": "github-docs/copilot/how-tos/manage-your-account/disable-copilot-free.md", "title": "Disabling GitHub Copilot Free" }
You can get started with your plan by: Accessing Upgrading from Subscribing to , , or Accessing Most individual developers can start using with no setup required. However, there are a few cases where isn't available: You have a . You are assigned a seat through an organization. You have an existing , , o...
{ "source": "github-docs/copilot/how-tos/manage-your-account/get-started-with-a-copilot-plan.md", "title": "Getting started with a GitHub Copilot plan" }
About settings on In addition to the configuration for the plugin in your supported IDE, you can configure settings for on . The settings apply wherever you use . Enabling or disabling suggestions matching public code [!NOTE] If you are a member of an organization on who has been assigned a seat through your or...
{ "source": "github-docs/copilot/how-tos/manage-your-account/manage-policies.md", "title": "Managing GitHub Copilot policies as an individual subscriber" }
You can view your current plan details in your account settings. From there, you can change or cancel your plan. If you have access to through an organization or enterprise, you will not be able to modify your plan. Viewing your plan Under "Licensing" and "Current plan", you can see which license and plan you're cu...
{ "source": "github-docs/copilot/how-tos/manage-your-account/view-and-change-your-copilot-plan.md", "title": "Viewing and changing your GitHub Copilot plan" }
These articles provide how-to information for creating and using . For an overview, see AUTOTITLE. To learn how to use to help with development work, see AUTOTITLE.
{ "source": "github-docs/copilot/how-tos/provide-context/use-copilot-spaces/index.md", "title": "GitHub Copilot Spaces" }
For information on creating , see AUTOTITLE. Using in your IDE You can also access the information and context from directly in your IDE using the MCP server. This allows you to leverage your curated context while coding without switching between your IDE and the web interface. This functionality is available in an...
{ "source": "github-docs/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces.md", "title": "Using GitHub Copilot Spaces" }
MCP registries for in your IDE streamline the process of discovering and setting up MCP servers. By default, uses the MCP Registry, but you can configure your own MCP registry to customize the list of servers available in your environment. [!NOTE] MCP registry availability in is currently in , and requires the late...
{ "source": "github-docs/copilot/how-tos/provide-context/use-mcp-in-your-ide/change-mcp-registry.md", "title": "Changing your MCP registry in your IDE" }
The MCP server includes default toolsets (repos, issues, and pullrequests) that are enabled automatically. You can customize toolset configuration by: Enabling individual toolsets such as actions, codesecurity, or secretprotection. For a step-by-step guide to scanning for secrets using the secretprotection toolset, s...
{ "source": "github-docs/copilot/how-tos/provide-context/use-mcp-in-your-ide/configure-toolsets.md", "title": "Configuring toolsets for the GitHub MCP Server" }
The MCP server can be configured to work with and . The configuration steps differ depending on whether you are using the remote or local MCP server. About enterprise MCP server configuration The MCP server supports two enterprise deployment types: : Supports both remote and local MCP server configurations : Supp...
{ "source": "github-docs/copilot/how-tos/provide-context/use-mcp-in-your-ide/enterprise-configuration.md", "title": "Configuring the GitHub MCP Server for GitHub Enterprise" }
Introduction The Model Context Protocol (MCP) is an open standard that defines how applications share context with large language models (LLMs). For an overview of MCP, see AUTOTITLE. For a curated list of MCP servers from partners and the community, see the MCP Registry. Prerequisites Access to . version 1.99 or...
{ "source": "github-docs/copilot/how-tos/provide-context/use-mcp-in-your-ide/extend-copilot-chat-with-mcp.md", "title": "Extending GitHub Copilot Chat with Model Context Protocol (MCP) servers" }
The MCP server is available to all users regardless of plan type. However, specific tools within the MCP server inherit the same access requirements as their corresponding features. If a feature requires a paid or license, the equivalent MCP tool will require the same subscription. For example, tools that interact...
{ "source": "github-docs/copilot/how-tos/provide-context/use-mcp-in-your-ide/set-up-the-github-mcp-server.md", "title": "Setting up the GitHub MCP Server" }
The MCP server is available to all users regardless of plan type. However, specific tools within the MCP server inherit the same access requirements as their corresponding features. If a feature requires a paid or license, the equivalent MCP tool will require the same subscription. For example, tools that interact...
{ "source": "github-docs/copilot/how-tos/provide-context/use-mcp-in-your-ide/use-the-github-mcp-server.md", "title": "Using the GitHub MCP Server in your IDE" }
Prerequisite To use in your IDE, you need either limited access through or a paid plan for full access. For more information about how to get access and choose the right plan, see AUTOTITLE. About the extension in Azure Data Studio Installing the extension in Azure Data Studio allows you to receive coding suggest...
{ "source": "github-docs/copilot/how-tos/set-up/install-copilot-extension.md", "title": "Installing the GitHub Copilot extension in your environment" }
1. Get access to There are a few ways that you can get access to : Use . Get a limited experience of with up to 2,000 inline suggestion requests and limited chat and agent usage-no paid plan required. See AUTOTITLE. Sign up for a paid plan. You can subscribe to one of these plans: , which includes access to prem...
{ "source": "github-docs/copilot/how-tos/set-up/set-up-for-self.md", "title": "Setting up GitHub Copilot for yourself" }
For questions about the general use of , product impact, human oversight, and privacy, see the comprehensive list of FAQs. If stops working, check 's Status page for any active incidents affecting or model availability. Unable to use the extension in the IDE We recommend you follow the quickstart guide for while ...
{ "source": "github-docs/copilot/how-tos/troubleshoot-copilot/troubleshoot-common-issues.md", "title": "Troubleshooting common issues with GitHub Copilot" }
About the problem If is responding more slowly than expected, the problem may be related to network conditions, local system performance, editor configuration, or connectivity restrictions such as proxies or firewalls. Because relies on remote services to generate responses, issues that affect communication with ser...
{ "source": "github-docs/copilot/how-tos/troubleshoot-copilot/troubleshoot-copilot-slowness.md", "title": "Troubleshooting slow responses from GitHub Copilot" }
About the problem If you or your company uses a firewall, may not function as expected. interacts with a remote machine learning model and checks for updates, and a firewall may block important traffic and degrade the user experience. Solving the problem For an optimal experience, you should create an "allowlist" t...
{ "source": "github-docs/copilot/how-tos/troubleshoot-copilot/troubleshoot-firewall-settings.md", "title": "Troubleshooting firewall settings for GitHub Copilot" }
If you're working on company equipment and connecting to a corporate network, you may be connecting to the Internet via a VPN or an HTTP proxy server. In some cases, these types of network setups may prevent from connecting to 's server. For more information about the options for setting up proxies with , see AUTOTITL...
{ "source": "github-docs/copilot/how-tos/troubleshoot-copilot/troubleshoot-network-errors.md", "title": "Troubleshooting network errors for GitHub Copilot" }
[!NOTE] Error: "Live preview is interrupted. Try refreshing the page to reconnect." There is a known compatibility issue between Apple's Safari browser and the way renders its live preview. To resolve the issue, switch to a different browser such as Google Chrome, Microsoft Edge or Mozilla Firefox. Error: "HTTP 413 ...
{ "source": "github-docs/copilot/how-tos/troubleshoot-copilot/troubleshoot-spark.md", "title": "Troubleshooting common issues with GitHub Spark" }
Collecting log files The location of the log files depends on the JetBrains IDE you are using. For more information, see AUTOTITLE. These steps describe how to view and collect the log files for the following JetBrains IDEs: IntelliJ IDEA Android Studio GoLand PhpStorm PyCharm RubyMine WebStorm The extension lo...
{ "source": "github-docs/copilot/how-tos/troubleshoot-copilot/view-logs.md", "title": "Viewing logs for GitHub Copilot in your environment" }
Choose from a selection of models, each with its own particular strengths. You may have a favorite model that you like to use, or you might prefer to use a particular model for inquiring about a specific subject. To view the available models per client, see AUTOTITLE. [!NOTE] Different models consume at different rat...
{ "source": "github-docs/copilot/how-tos/use-ai-models/change-the-chat-model.md", "title": "Changing the AI model for GitHub Copilot Chat" }
The following instructions are for . If you are using , or a JetBrains IDE, click the appropriate tab at the start of this article. Prerequisites For more information, see AUTOTITLE. Changing the AI model for inline suggestions 1. Open the command palette by pressing <kbdCtrl</kbd+<kbdShift</kbd+<kbdP</kbd (Windows/L...
{ "source": "github-docs/copilot/how-tos/use-ai-models/change-the-completion-model.md", "title": "Changing the AI model for GitHub Copilot inline suggestions" }
[!NOTE] For an overview of , see AUTOTITLE. Introduction In supported entrypoints, you can select the model used by . You may find that different models perform better, or provide more useful responses, depending on the type of tasks you give . [!NOTE] Model selection for is only supported when assigning an issue ...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md", "title": "Changing the AI model for GitHub Copilot cloud agent" }
Enabling or disabling built-in code quality and security validation tools Optionally, you can choose to disable these tools to help work faster or avoid conflicts with other code quality or security products you're using. You must be a repository administrator to configure these settings. 1. click then . 1. In the "...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings.md", "title": "Configuring settings for GitHub Copilot cloud agent" }
Introduction You can create and manage from the Agents tab of a repository on . You can also create and manage from the tab in the . For an overview of , including triggers, tools, visibility, and security, see AUTOTITLE. Prerequisites Creating an 1. Under your repository name, click Agents. 1. In the sidebar, c...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/create-automations.md", "title": "Creating automations with Copilot cloud agent" }
allow you to tailor 's expertise for specific tasks. For a conceptual overview of , see AUTOTITLE. Creating a profile 1. Open in . 1. From the agents dropdown at the bottom of the chat view, click Configure Custom Agents..., then click Create new . 1. Choose the location where the should be created: Workspace:...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents-in-your-ide.md", "title": "Creating custom agents for {% data variables.copilot.copilot_cloud_agent %} in your IDE" }
These articles provide how-to information for using . For an overview of , see the articles under AUTOTITLE.
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/index.md", "title": "GitHub Copilot cloud agent" }
The Azure Boards integration allows you to invoke without leaving your workspace. From within a Azure Boards work item you can initiate sessions and open pull requests, using the context of your work item description and comments. For information about additional integrations, see AUTOTITLE. [!NOTE] uses AI. Ch...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md", "title": "Integrating Copilot cloud agent with Azure Boards" }
[!NOTE] uses AI. Check for mistakes. See AUTOTITLE. The integration in Jira allows you to invoke without leaving your Jira workspace. From within Jira you can initiate sessions and open pull requests, using the context of the work item's title, description, labels, comments, and any Atlassian custom fields such as...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md", "title": "Integrating Copilot cloud agent with Jira" }
[!NOTE] uses AI. Check for mistakes. See AUTOTITLE. The integration in Linear allows you to invoke without leaving your Linear workspace. From within a Linear issue you can initiate sessions, customize which model, custom agent, or branches the agent uses, steer a session, and open pull requests, all using the con...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md", "title": "Integrating Copilot cloud agent with Linear" }
[!NOTE] This feature is in and subject to change. uses AI. Check for mistakes. See AUTOTITLE. Introduction The integration in Slack allows you to interact with from your Slack workspace and is included in the for Slack. From within a Slack thread or direct message, you can initiate sessions using the context...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md", "title": "Integrating Copilot cloud agent with Slack" }
[!NOTE] This feature is currently in and subject to change. uses AI. Check for mistakes. See AUTOTITLE. The integration in Microsoft Teams allows you to interact with all from within your Teams channels. From within a Teams thread you can initiate sessions and open pull requests, using the context of your conv...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md", "title": "Integrating Copilot cloud agent with Teams" }
Rationale and confidence need no extra configuration. When an 's agent changes a supported issue attribute, it attaches a rationale and a confidence level automatically. Whether that change applies directly or waits for review depends on your repository's automation level, or on an explicit request to suggest rather th...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/manage-rationale-confidence-approvals.md", "title": "Managing rationale, confidence, and approvals for issues" }
You can start from several clients. Choose the one that fits your workflow: — issues, agents tab, dashboard, , new repositories, and failing runs IDEs — , JetBrains, Eclipse, and 2026 REST API MCP Server Jira Slack Microsoft Teams Azure Boards Linear Raycast You can also start sessions automatically, on ...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/start-copilot-sessions.md", "title": "Starting GitHub Copilot sessions" }
is not available in the "Assignees" list on my issue You can only assign issues to if you have access to through a paid plan. If you do not already have a subscription for one of these plans, click this button for more information:<br <a href="https://github.com/features/copilot/plans?refproduct=copilot&reftype=enga...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md", "title": "Troubleshooting GitHub Copilot cloud agent" }
[!NOTE] Introduction let you delegate work to partner-built agents from within . For an overview, see AUTOTITLE. Before you can use an , the must be installed on the account or organization that owns the repository, and agent features must be enabled for the app. If the repository is owned by an organization that b...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-agent-apps.md", "title": "Using agent apps" }
[!NOTE] The agent-task command set is only available in v2.80.0 or later of the . This command set is a and is subject to change. Starting a session You can start a new session with the gh agent-task create command. When you run the command without any arguments, you are asked to enter a prompt. acts on the prompt...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-from-cli.md", "title": "Using Copilot cloud agent from the GitHub CLI" }
Prerequisites Starting a session 1. Open Raycast, search for "," find the Create Task command, then press <kbdEnter</kbd. 1. Click Sign in with , then complete the authentication flow. Raycast will re-open. 1. Type a prompt describing what you want to do. For example, Implement a user friendly message for common ...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-from-raycast.md", "title": "Using Copilot cloud agent from Raycast" }
Starting a session 1. Install the Pull Requests extension for . 1. Open in . 1. Type a prompt explaining what you want to do. For example, Put backticks around file names and variables in output [!TIP] To help , you can select the relevant line(s) of code before submitting your prompt. 1. Submit your prom...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-in-your-ide.md", "title": "Using Copilot cloud agent in your IDE" }
Introduction You can start sessions from several places on . Once a session is running, you can monitor its progress, steer it with follow-up prompts, and iterate on the resulting pull request—all without leaving the browser. For more information about , see AUTOTITLE. You can also start partner-built agents from thes...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-github.md", "title": "Using Copilot cloud agent on GitHub" }
Starting a session 1. In , tap the icon in the bottom right corner of the screen, then tap New Session. 1. Using the dropdown menu in the prompt field, select the repository you want to work in. 1. Enter a prompt describing your request. For example: Implement a user friendly message for common errors. If you ...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-on-mobile.md", "title": "Using Copilot cloud agent on GitHub Mobile" }
You can use the agent tasks API to integrate into your own tools and workflows. For example, you can start a new task, list existing tasks, or check the status of a task. In addition, you can use the REST and GraphQL APIs for issues to assign issues to . Using the agent tasks API [!NOTE] The agent tasks API is in ...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-via-the-api.md", "title": "Using Copilot cloud agent via the API" }
[!NOTE] This capability is only available on the remote MCP Server and host applications where remote MCP Servers are supported. Starting a session 1. Install the MCP Server in your preferred IDE or agentic coding tool. See AUTOTITLE. 1. Ensure the createpullrequestwithcopilot tool is enabled. 1. Open chat. 1. Typ...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/cloud-agent/use-cloud-agent-with-mcp.md", "title": "Using Copilot cloud agent via the GitHub MCP Server" }
Enabling For enterprise- and organization-managed subscriptions, is off by default and must be enabled in the enterprise or organization settings. Once is enabled, the feature is on for users by default. will be used in any repository in which users use supported features, and it will save both repository-level f...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/copilot-memory/manage-as-administrator.md", "title": "Managing Copilot Memory for an organization or enterprise" }
is enabled for your account by default if: You are on a paid, individual plan. Your plan is managed by an enterprise or organization that has allowed you to use . In either case, you can disable or re-enable at any time in your personal settings. Disabling or enabling When enabled, will be used in any repositor...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/copilot-memory/manage-for-yourself.md", "title": "Managing Copilot Memory for your personal account" }
These articles provide instructions on configuring and using . For an introduction to , see AUTOTITLE.
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/request-a-code-review/index.md", "title": "Code review" }
Introduction can review your code and provide feedback. Where possible, 's feedback includes suggested changes which you can apply with a couple of clicks. For a full introduction to , see AUTOTITLE. uses to run agentic capabilities. For more information, see Agentic capabilities for . is also available for organiz...
{ "source": "github-docs/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md", "title": "Using GitHub Copilot code review" }
Replacing the extension The extension for is . It has been replaced by the new . See AUTOTITLE.
{ "source": "github-docs/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-in-the-cli.md", "title": "Using the GitHub CLI Copilot extension" }
Comparison of AI models for supports multiple AI models with different capabilities. The model you choose affects the quality and relevance of responses by and inline suggestions. Some models offer lower latency, while others offer fewer hallucinations or better performance on specific tasks. This guide helps you p...
{ "source": "github-docs/copilot/reference/ai-models/model-comparison.md", "title": "AI model comparison" }
can use a variety of AI models. This article explains how these models are hosted and served. OpenAI models Used for: These models are hosted by OpenAI and 's Azure infrastructure. OpenAI makes the following data commitment: We [OpenAI] do not train models on customer business data. Data processing follows OpenAI's en...
{ "source": "github-docs/copilot/reference/ai-models/model-hosting.md", "title": "Hosting of models for GitHub Copilot" }
supports multiple AI models, each with different strengths. Some prioritize speed and cost-efficiency, while others are optimized for accuracy, reasoning, or multimodal inputs. The right model depends on your task. For a side-by-side comparison to help you choose, see AUTOTITLE. The models available to you depend on yo...
{ "source": "github-docs/copilot/reference/ai-models/supported-models.md", "title": "Supported AI models in GitHub Copilot" }
This version of this article is for on the website. For other versions of this article, click the tabs above. For information about how to get started with in the website, see AUTOTITLE. Mentions Use @ mentions in to attach relevant context directly to your conversations. Type @ in the chat prompt box to display a...
{ "source": "github-docs/copilot/reference/chat-cheat-sheet.md", "title": "GitHub Copilot Chat cheat sheet" }
If your company employs security measures like a firewall or proxy server, you should add the URLs in this article to an allowlist to ensure works as expected. Enable users to sign in to Allowlisting the URLs below is not enough on its own. If your network blocks more broadly, users won't be able to sign in to , ev...
{ "source": "github-docs/copilot/reference/copilot-allowlist-reference.md", "title": "Copilot allowlist reference" }
You can connect an Azure subscription to your organization or enterprise account and pay for through Azure. billing follows the same rules as other products billed through Azure, including billing periods, invoicing, and usage reporting. For details, see AUTOTITLE. -specific usage license usage is measured as the...
{ "source": "github-docs/copilot/reference/copilot-billing/azure-billing.md", "title": "GitHub Copilot billing through Azure" }
uses the same billing cycle as other license-based products. For details about how billing cycles work across all products, see AUTOTITLE. Within that framework: Charges are calculated based on the number of seats (licenses) assigned during the billing cycle. You can add or remove seats at any time. At the end of ea...
{ "source": "github-docs/copilot/reference/copilot-billing/billing-cycle.md", "title": "GitHub Copilot billing cycle" }
follows the same billing rules as other license-based products on . For the general concepts, see: AUTOTITLE – explains how upgrades, downgrades, and seat changes are billed. AUTOTITLE – explains how usage-based billing works compared to volume licensing. This article focuses on how those rules apply specifically to ...
{ "source": "github-docs/copilot/reference/copilot-billing/license-changes.md", "title": "Making changes to your GitHub Copilot license" }
How model pricing works When you use , the interaction consumes tokens: input tokens (what's sent to the model), output tokens (what the model generates), and cached tokens (context the model reuses or stores). Each token is priced based on the model used, and the total is converted into , where 1 = . The cost of an i...
{ "source": "github-docs/copilot/reference/copilot-billing/models-and-pricing.md", "title": "Models and pricing for {% data variables.product.prodname_copilot %}" }
What is a request? A request is any interaction where you ask to do something for you—whether it's generating code, answering a question, or helping you through an extension. Each time you send a prompt in a chat window or trigger a response from , you're making a request. For agentic features, only the prompts you se...
{ "source": "github-docs/copilot/reference/copilot-billing/request-based-billing-legacy/copilot-requests.md", "title": "Requests in GitHub Copilot (legacy)" }
Usage of is measured through a combination of licenses and monthly usage tracking. For more information about how license costs in work, see AUTOTITLE. What are premium requests? Some features use premium requests. Premium requests give you access to advanced models and additional AI features. Examples include: Us...
{ "source": "github-docs/copilot/reference/copilot-billing/request-based-billing-legacy/github-copilot-premium-requests.md", "title": "Overview of request-based billing (legacy)" }
[!IMPORTANT] On June 1, 2026, moved to usage-based billing. The articles in this category, which refer to 's legacy premium request-based billing model, only apply to and subscribers on an existing annual plan who remain on request-based billing after June 1, 2026.
{ "source": "github-docs/copilot/reference/copilot-billing/request-based-billing-legacy/index.md", "title": "GitHub Copilot request-based billing for annual plan subscribers (legacy)" }
[!IMPORTANT] On June 1, 2026, moved to usage-based billing. The model multipliers in this article apply only to and subscribers on an existing annual plan who remained on the legacy premium request-based billing model after June 1, 2026. To learn more about these billing changes, including what your options are as ...
{ "source": "github-docs/copilot/reference/copilot-billing/request-based-billing-legacy/model-multipliers-for-annual-plans.md", "title": "Model multipliers for annual plans on request-based billing (legacy)" }
You can track your monthly usage of premium requests to help you get the most value from your plan. Premium request counters reset on the 1st of each month at 00:00:00 UTC. Viewing premium request usage There are multiple ways to view your premium request usage: View current usage directly within your IDE Viewing a...
{ "source": "github-docs/copilot/reference/copilot-billing/request-based-billing-legacy/monitor-premium-requests.md", "title": "Monitoring your GitHub Copilot usage and entitlements (legacy)" }
What changed with billing? changed how usage is measured and billed. Before June 1, 2026, billing was premium request-based: each model interaction cost one premium request unit (PRU), and a multiplier was applied based on which model you used—more powerful models used more premium requests. Model multipliers are a ...
{ "source": "github-docs/copilot/reference/copilot-billing/request-based-billing-legacy/what-changed-with-billing.md", "title": "What changed with Copilot billing (legacy)" }
This article explains how seat assignment for works in organizations and enterprises. What is a seat? A seat is a license to use , assigned to a unique user account through a or a plan. Users must be assigned a seat to access features under an organization or enterprise plan Seat assignment management Who assi...
{ "source": "github-docs/copilot/reference/copilot-billing/seat-assignment.md", "title": "GitHub Copilot seat assignment" }
[!NOTE] ACP support in is in and subject to change. Overview The Agent Client Protocol (ACP) is a protocol that standardizes communication between clients (such as code editors and IDEs) and agents (such as ). For more details about this protocol, see the official introduction. Use cases IDE integrations: Build ...
{ "source": "github-docs/copilot/reference/copilot-cli-reference/acp-server.md", "title": "Copilot CLI ACP server" }
Command-line commands Command Purpose ---------------------------------------------------------------------------- copilot Launch the interactive user interface. copilot completion SHELL Print a shell script for the chosen shell ...
{ "source": "github-docs/copilot/reference/copilot-cli-reference/cli-command-reference.md", "title": "GitHub Copilot CLI command reference" }
stores its configuration, session history, logs, and customizations in a single directory on your machine. By default, this directory is ~/.copilot (that is, $HOME/.copilot). This article describes the contents of this directory and how you can use them. Directory overview The ~/.copilot directory contains the followi...
{ "source": "github-docs/copilot/reference/copilot-cli-reference/cli-config-dir-reference.md", "title": "GitHub Copilot CLI configuration directory" }
For an overview of what plugins are and how they work across clients, see AUTOTITLE. CLI commands You can use the following commands in the terminal to manage plugins for . copilot plugin and copilot plugins are interchangeable—use whichever reads better for the subcommand. Command ...
{ "source": "github-docs/copilot/reference/copilot-cli-reference/cli-plugin-reference.md", "title": "GitHub Copilot CLI plugin reference" }
In addition to running interactively, you can also pass a prompt directly to the CLI in a single command, without entering an interactive session. This allows you to use programmatically in scripts, CI/CD pipelines, and automation workflows. For more information, see AUTOTITLE. This article describes command-line opt...
{ "source": "github-docs/copilot/reference/copilot-cli-reference/cli-programmatic-reference.md", "title": "GitHub Copilot CLI programmatic reference" }
[!NOTE] The feature matrix is currently in and is subject to change. recommends using the latest stable IDE and extension versions to get the best experience. Key: ✓ = supported ✗ = not supported P = under preview C = closing down <!-- Source for the following tables lives in data/tables/copilot/copilot-matri...
{ "source": "github-docs/copilot/reference/copilot-feature-matrix.md", "title": "Copilot feature matrix" }
The usage metrics dashboard and APIs display and export data using a consistent set of fields. This reference lists all available metrics and describes how to interpret their values in both dashboard visuals and NDJSON or API exports. The usage metrics dashboards are available at the enterprise and organization leve...
{ "source": "github-docs/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md", "title": "Data available in Copilot usage metrics" }
The following are example schemas for the user-level, enterprise-level, and repository-level data returned by the usage metrics endpoints. The actual data returned may vary based on the specific metrics being tracked and the level of aggregation. You can use these examples as a reference for understanding the structur...
{ "source": "github-docs/copilot/reference/copilot-usage-metrics/example-schema.md", "title": "Example schema for Copilot usage metrics" }
After you’ve viewed the usage metrics dashboard, you can use this article to interpret each chart and identify opportunities to increase adoption and engagement. Reviewing overall usage trends Use the main usage charts in the dashboard to understand overall adoption and engagement patterns. These charts help you iden...
{ "source": "github-docs/copilot/reference/copilot-usage-metrics/interpret-copilot-metrics.md", "title": "Interpreting usage and adoption metrics for GitHub Copilot" }
Lines of Code (LoC) metrics provide a directional measure of ’s output by quantifying the lines it suggested, added, or deleted across completions, chat, and agent features. Where LoC metrics appear You may encounter LoC metrics in: Code generation dashboard (enterprise and organization level) — visualizes LoC-based ...
{ "source": "github-docs/copilot/reference/copilot-usage-metrics/lines-of-code-metrics.md", "title": "Lines of Code metrics" }
The usage metrics dashboard, APIs, and export files all use the same underlying telemetry data, but they aggregate and present it differently. Understanding these differences helps you reconcile numbers across sources and trust your analysis when preparing internal reports. The usage metrics dashboards are available...
{ "source": "github-docs/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics.md", "title": "Reconciling Copilot usage metrics across dashboards, APIs, and reports" }
The usage metrics APIs do not publish a single pre-aggregated team report. Team-level metrics are constructed by joining the user-teams report (which lists each user's team memberships for a given day) with the per-user usage metrics report (which contains each user's activity for that day). Aggregating the joined ro...
{ "source": "github-docs/copilot/reference/copilot-usage-metrics/team-level-metrics.md", "title": "Team-level Copilot usage metrics" }
This reference article provides detailed configuration information for . For general information about creating , see AUTOTITLE. YAML frontmatter properties The following table outlines the properties that you can configure for in , the , and supported IDEs (unless otherwise noted). Any environment-specific behavior ...
{ "source": "github-docs/copilot/reference/custom-agents-configuration.md", "title": "Custom agents configuration" }
Prompt with suggestions for behavior and output The mcp-servers property in an is a YAML representation of the JSON configuration format used to configure MCP servers for repositories on . Most sub-properties are the same as the JSON representation. The following sections describe changes from the initial implementati...
{ "source": "github-docs/copilot/reference/custom-agents-configuration.md", "title": "Custom agents configuration" }
This reference article provides details of which types of custom instructions are supported in various environments. For more information about the various types of custom instructions for , see AUTOTITLE. WRITING NOTE: The following tables have been written using HTML rather than Markdown due to the poor column width ...
{ "source": "github-docs/copilot/reference/custom-instructions-support.md", "title": "Support for different types of custom instructions" }
offers several customization features that let you tailor its behavior to your workflow, your team's standards, and your project's needs. Use the tables below to find the right one for your use case. Feature overview This table shows what each customization feature is and where it lives. Feature What it is Filename...
{ "source": "github-docs/copilot/reference/customization-cheat-sheet.md", "title": "Copilot customization cheat sheet" }
The following filters are available for the "Agent sessions" view in your enterprise's AI Controls: Filter Description Example value --- --- --- agent Displays activity from a specific agent. agent:copilot-cloud-agent organization Displays activity within a specific organization. organization:octocat-org...
{ "source": "github-docs/copilot/reference/enterprise-administrators/agent-session-filters.md", "title": "Available filters for agent sessions" }
You can apply the actor:Copilot filter to your enterprise audit log to view agentic activity over the last 180 days. The following key fields can help you interpret agentic events: Field Description Example value --- --- --- action The action performed by the agent, such as creating a pull request. pullreque...
{ "source": "github-docs/copilot/reference/enterprise-administrators/agentic-audit-log-events.md", "title": "Audit log events for agents" }
Use this reference to understand the currently supported keys in . For deployment methods and supported clients, see AUTOTITLE. Precedence rules When multiple settings sources are present, settings earlier in this list take precedence over settings later in the list: 1. MDM-managed settings 1. Server-managed settings ...
{ "source": "github-docs/copilot/reference/enterprise-administrators/enterprise-managed-settings.md", "title": "Enterprise managed settings" }
Current enforcement limitations MCP allowlist enforcement currently has the following limitations: Enforcement is based only on server name/ID matching, which can be bypassed by editing configuration files Strict enforcement that prevents installation of non-registry servers is not yet available For the highest level...
{ "source": "github-docs/copilot/reference/enterprise-administrators/mcp-allowlist-enforcement.md", "title": "MCP allowlist enforcement" }
About delegating policy decisions to organizations Policies can be defined for a whole enterprise, or set at the organization level. See AUTOTITLE. When an enterprise owner delegates control of a policy to organization owners by setting "No policy," some organizations may enable a feature while others disable it. Users...
{ "source": "github-docs/copilot/reference/enterprise-administrators/policy-conflicts.md", "title": "Feature availability when GitHub Copilot policies conflict in organizations" }
This page lists -provided built-in agent skills for the . It does not list agent skills from plugins, repositories, organizations, or personal customizations. Built-in skills in the Some built-in skills are available as slash commands. When available in your current context, you can run them by typing /<skill-id in t...
{ "source": "github-docs/copilot/reference/github-copilot-app-reference/built-in-skills.md", "title": "Built-in skills for the GitHub Copilot app" }
Slash commands are shortcuts you can type in the prompt box. Type / to open the command picker, then select a command or keep typing to filter. Some slash commands invoke skills, such as /orchestrate and /create-canvas. Command availability depends on context and can change depending on whether a session has started. ...
{ "source": "github-docs/copilot/reference/github-copilot-app-reference/slash-commands.md", "title": "Slash commands for the GitHub Copilot app" }
Introduction Hooks are external commands that execute at specific lifecycle points during a session, enabling custom automation, security controls, and integrations. Hooks are supported in two surfaces: and . Most of the configuration format and event payloads are identical, but the execution environment and the set ...
{ "source": "github-docs/copilot/reference/hooks-reference.md", "title": "GitHub Copilot hooks reference" }
You can use the default keyboard shortcuts for inline suggestions in your JetBrains IDE when using . Keyboard shortcuts for macOS Action Shortcut :---:--- Accept an inline suggestion<kbdTab</kbd Dismiss an inline suggestion<kbdEsc</kbd Show next inline suggestion<kbdOption (⌥) or Alt</kbd+<kbd]</kbd Show previous i...
{ "source": "github-docs/copilot/reference/keyboard-shortcuts.md", "title": "Keyboard shortcuts for GitHub Copilot in the IDE" }
lastactivityat [!NOTE] This data is in and subject to change. The timestamp of a user's most recent interaction with functionality. Surfaces This property is consistent across the following surfaces: The CSV report downloaded from the "Access management" page (see AUTOTITLE) The AUTOTITLE Calculation The followi...
{ "source": "github-docs/copilot/reference/metrics-data.md", "title": "Metrics data properties for GitHub Copilot" }
Certain types of files are excluded from . These include dependency management files, log files, SVG files, and files in locations typically reserved for vendor files or automatically generated files. If you include any of these files in a pull request, will not consider the file when carrying out the review. Similarl...
{ "source": "github-docs/copilot/reference/review-excluded-files.md", "title": "Files excluded from {% data variables.copilot.copilot_code-review %}" }
is available across various surfaces: in IDEs, in the CLI, and as multiple agents and chat interfaces on the website. A dedicated policy exists to enable or disable each supported feature or surface. Additionally, you can set various policies to customize or control the experience. However, not every policy applies t...
{ "source": "github-docs/copilot/reference/supported-surfaces-for-policies.md", "title": "Supported surfaces for GitHub Copilot policies" }
What is an Application Card? 1. Overview GitHub Copilot includes several agentic features that go beyond suggestion and conversation—they can review code, take action on your behalf, and build applications. This card covers the following experiences: Copilot code review: Reviews pull request diffs and metadata on Git...
{ "source": "github-docs/copilot/responsible-use/agents.md", "title": "Application card: GitHub Copilot Agents" }
What is an Application Card? 1. Overview GitHub Copilot Chat is a chat interface that lets you interact with GitHub Copilot to ask and receive answers to coding-related questions. GitHub Copilot Chat is available on GitHub.com, in supported IDEs (VS Code, Visual Studio, JetBrains, and Eclipse), on GitHub Mobile, and i...
{ "source": "github-docs/copilot/responsible-use/chat.md", "title": "Application card: GitHub Copilot Chat" }
What is an Application Card? 1. Overview GitHub Copilot inline suggestions provide autocomplete-style suggestions as you work. These suggestions appear inline in your editor or in text fields on GitHub.com, helping you write code and pull request descriptions more quickly. Copilot inline suggestions come in two forms:...
{ "source": "github-docs/copilot/responsible-use/inline-suggestions.md", "title": "Application card: GitHub Copilot inline suggestions" }
Under usage-based billing, your enterprise's included are pooled and shared across all licensed users. Without budget controls in place, a single heavy user or automated agent session can consume a disproportionate share of the pool early in the billing cycle, leaving less for everyone else. Before you begin, make sur...
{ "source": "github-docs/copilot/tutorials/budgets/getting-started-with-budget-controls.md", "title": "Getting started with budget controls" }