text stringlengths 12 91.7k | metadata dict |
|---|---|
The network settings for allow you to connect to through an HTTP proxy and use custom certificates.
Proxy settings for
By default, connects to 's server directly from your environment via a secure HTTPS connection. You don't necessarily need to configure any additional network settings to use .
Some networks use a... | {
"source": "github-docs/copilot/concepts/network-settings.md",
"title": "Network settings for GitHub Copilot"
} |
How do policies work?
You will find policies for on your enterprise's AI controls tab or in your organization's settings. Policies control which features, agents, and models your users can access, and how they can use those features. For example, a policy controls whether users can use .
In an enterprise, policies a... | {
"source": "github-docs/copilot/concepts/policies.md",
"title": "GitHub Copilot policies for enterprises and organizations"
} |
A prompt is a request that you make to . For example, a question that you ask , or a code snippet that you ask to complete. In addition to your prompt, uses additional context, like the code in your current file and the chat history, to generate a response.
Follow the tips in this article to write prompts that genera... | {
"source": "github-docs/copilot/concepts/prompting/prompt-engineering.md",
"title": "Prompt engineering for GitHub Copilot Chat"
} |
<!-- START WEB BROWSER TAB --
[!NOTE] This version of this article is about custom instructions on the website. Click the tabs above for other environments. <!-- markdownlint-disable-line MD027 --
About customizing responses
can provide responses that are tailored to your personal preferences, the way your team wo... | {
"source": "github-docs/copilot/concepts/prompting/response-customization.md",
"title": "About customizing GitHub Copilot responses"
} |
Overview
Benefits of using
can provide a wide range of benefits at all stages of app development.
Build apps with natural language or code
You don't need to know how to code to build an app with . You can describe what you want your app to do in natural language, and will generate all the necessary code for you, a... | {
"source": "github-docs/copilot/concepts/spark.md",
"title": "About GitHub Spark"
} |
Overview
can be integrated with various tools and platforms to enhance its functionality and streamline your development workflow. With integrations, you can trigger from within your existing tools, providing the cloud agent with the context it needs to assist you effectively.
For more information about , see AUTOTIT... | {
"source": "github-docs/copilot/concepts/tools/about-copilot-integrations.md",
"title": "About Copilot integrations"
} |
Overview
The use of AI tools is increasingly becoming a standard part of a software developer's daily workflow. To be competitive in the job market, it's important to know which AI tools to use for each task you face as a developer.
's AI tools assist with every phase of the software development lifecycle (SDLC):
Plan... | {
"source": "github-docs/copilot/concepts/tools/ai-tools.md",
"title": "Choosing the right AI tool for your task"
} |
Rate limits
Rate limiting is a mechanism used to control the number of requests a user or application can make in a given time period. uses rate limits to ensure everyone has fair access to and to protect against abuse.
enforces rate limits for several reasons.
Capacity: There is a limited amount of computing power... | {
"source": "github-docs/copilot/concepts/usage-limits.md",
"title": "Usage limits for GitHub Copilot"
} |
Understand 's strengths and weaknesses
is an AI coding assistant that helps you write code faster and with less effort, allowing you to focus more energy on problem solving and collaboration. Before you start working with , it's important to understand when you should and shouldn't use it.
Some of the things does bes... | {
"source": "github-docs/copilot/get-started/best-practices.md",
"title": "Best practices for using GitHub Copilot"
} |
Assistive features
These tools are used synchronously, providing advice or suggestions as people work on a task.
A chat interface that lets you ask coding-related questions. is available on the website, in , in supported IDEs, and in . Users can also use skills with . See AUTOTITLE and AUTOTITLE.
Inline suggestions
... | {
"source": "github-docs/copilot/get-started/features.md",
"title": "GitHub Copilot features"
} |
[!IMPORTANT]
offers several plans for , depending on your needs and whether you're using as an individual or as part of an organization or enterprise.
is available to individual developers who don't have access to through an organization or enterprise. This free plan includes limited access to a selection of fea... | {
"source": "github-docs/copilot/get-started/plans.md",
"title": "Plans for GitHub Copilot"
} |
This quickstart covers using on the website, in IDEs, and in . To try an agent-driven workflow in the , see AUTOTITLE.
Introduction
<!-- --------------------- --
<!-- Web browser --
<!-- --------------------- --
You can use to get answers to coding-related questions, such as how best to code something, how to fix a... | {
"source": "github-docs/copilot/get-started/quickstart.md",
"title": "Quickstart for GitHub Copilot"
} |
is an AI coding assistant that helps you write code faster and with less effort. Then, you can focus more energy on problem solving and collaboration.
Research shows that increases developer productivity and accelerates software development. See Research: quantifying ’s impact on developer productivity and happiness i... | {
"source": "github-docs/copilot/get-started/what-is-github-copilot.md",
"title": "What is GitHub Copilot?"
} |
You can download a CSV report for user activity in your organization. The data in the report allows you to:
Accurately monitor license usage accurately.
Understand patterns in user authentication.
Manage licenses and measure key performance indicators.
Downloading the report for an enterprise
1. At the top of the... | {
"source": "github-docs/copilot/how-tos/administer-copilot/download-activity-report.md",
"title": "Downloading a GitHub Copilot activity report for your organization or enterprise"
} |
Why bring your own API keys?
As an enterprise owner, you may have specific requirements for governance, data security, and compliance. Setting up your own API keys allows you to address:
Adding your key to an enterprise account
[!IMPORTANT] We highly recommend adhering to the principle of least privilege by assigning... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/enable-custom-models.md",
"title": "Enabling custom models for GitHub Copilot in your enterprise"
} |
When you disable for organizations, organization owners cannot assign licenses to members of their organization. Enterprise owners will still be able to assign licenses to users and teams in the enterprise settings.
1. Next to "Organization access", choose whether to disable for all organizations or allow for speci... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access/disable-for-organizations.md",
"title": "Disabling Copilot for organizations in your enterprise"
} |
Assigning licenses to users or teams
You can assign licenses directly to users or enterprise teams.
When you assign licenses to an enterprise team, users receive or lose access to when they are added or removed from the team. If you use , you can sync the team with an identity provider (IdP) group and manage licensin... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access/grant-access.md",
"title": "Granting users access to GitHub Copilot in your enterprise"
} |
If you have a or plan, you can view usage information for in your enterprise. This information includes the number of seats assigned and the total spending for the current billing cycle.
1. Scroll to the bottom of the page and click the Copilot tab.
!Screenshot of the Copilot usage tab in the enterprise billing s... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-access/view-license-usage.md",
"title": "Viewing Copilot license usage in your enterprise"
} |
Most policies only affect users who receive a license from your enterprise or organizations. However, there are dedicated policies to completely disable features in your repositories, including for users who get access to from a personal plan or another enterprise.
Blocking
1. Next to Block in all repositories ow... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/block-agentic-features.md",
"title": "Blocking agentic features in your enterprise"
} |
With enterprise managed settings, enterprise owners can centrally define and distribute configuration settings to supported clients for users on your enterprise's plan, ensuring every member works within the guardrails you define, while letting teams tailor the settings you allow.
The following clients are supported, ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/configure-enterprise-managed-settings.md",
"title": "Configuring enterprise-managed settings"
} |
A .github-private repository can house governance settings for your enterprise's custom agent profiles, client permissions, and plugins.
A repository-based governance approach allows users to open pull request with suggestions to improve the settings, and it allows settings changes to be restricted by codeowners and ru... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/create-github-private-repo.md",
"title": "Creating a `.github-private` repository"
} |
Prerequisites
You may want to run a trial before enabling for the enterprise. See AUTOTITLE.
Enabling
and use of third-party MCP servers are disabled by default. You can enable these features for users who receive a license from your enterprise or organizations.
1. Select a global policy for , then communicate you... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/enable-copilot-cloud-agent.md",
"title": "Enabling GitHub Copilot cloud agent in your enterprise"
} |
can review pull requests in your enterprise. This can save time for human reviewers by detecting bugs or vulnerabilities and enforcing consistent coding standards.
Enabling for your subscribers
The policy for allows your licensed users to request reviews from and use to generate pull request summaries.
1. Scroll ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/enable-copilot-code-review.md",
"title": "Enabling GitHub Copilot code review in your enterprise"
} |
Viewing active and recent agentic sessions in your enterprise
1. Towards the top of the page, in the "Agent sessions" section, you will see the three most recent agent sessions in your enterprise. To view all agent sessions from the last 24 hours, click View all.
1. To filter agent sessions, click the search bar at the... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/monitor-agentic-activity.md",
"title": "Monitoring agentic activity in your enterprise"
} |
Enterprise-level are defined in a .github-private repository within an organization in your enterprise. Preparing your enterprise involves creating that repository, configuring it as your source of governance, protecting your agent files, and deciding who can manage .
Work through the following steps to set up your en... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md",
"title": "Preparing to use custom agents in your enterprise"
} |
As an enterprise owner, you can manage which models are available to people in your enterprise.
An enterprise owner can enable or disable models for everyone in the enterprise. Alternatively, there are two different modes for controlling granular access to models: organizations and enterprise teams.
By default, models... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-availability-of-default-models.md",
"title": "Managing availability of models in your enterprise"
} |
When an organization owner assigns a license to a member of their organization, the availability of features and models is controlled by policies.
If you're setting up for the first time, see AUTOTITLE for guidance on setting a governance posture that balances compliance with developer productivity.
Defining policie... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies.md",
"title": "Managing policies and features for GitHub Copilot in your enterprise"
} |
To cancel your plan for your enterprise account, you need to disable for all organizations in your enterprise. See AUTOTITLE. | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-plan/cancel-plan.md",
"title": "Canceling GitHub Copilot for your enterprise"
} |
1. Click the Organizations tab.
1. Locate the organization for which you want to downgrade .
1. To the right of the organization name, select the dropdown menu, and click Business.
!Screenshot of the Copilot "access management" page. A dropdown menu is selected, and a button labeled "Business" is outlined in orang... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-plan/downgrade-subscription.md",
"title": "Downgrading GitHub Copilot for your enterprise"
} |
[!NOTE]
1. Ensure you are signed in as an enterprise admin on .
1. To purchase for your enterprise, contact 's Sales team.
1. A member of the Sales team will work with you to set up for your enterprise.
Next steps
To finish setting up for your enterprise, see AUTOTITLE.
For billing information, see AUTOTITLE and ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-plan/subscribe.md",
"title": "Subscribing to GitHub Copilot for your enterprise"
} |
[!NOTE]
You must already have a paid plan to upgrade to . Trial plans are not eligible for upgrade.
1. Click the Organizations tab.
1. Locate the organization for which you want to upgrade .
1. To the right of the organization name, select the dropdown menu, and click .
Next steps
After upgrading to , you can assi... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-plan/upgrade-plan.md",
"title": "Upgrading GitHub Copilot for your enterprise"
} |
[!NOTE]
About
allows users to build intelligent applications using natural-language prompts. includes advanced controls and built-in design tools for customization. Once published, applications can be shared with teammates or deployed to production.
For details about benefits, development experience, billing, and e... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-spark.md",
"title": "Managing GitHub Spark in your enterprise"
} |
You can use the audit log to review actions taken in your enterprise. The audit log includes a record of:
Changes to your plan, such as changes to settings and policies or a user losing or receiving a license
Agent activity on the website
The audit log does not include client session data, such as the prompts a use... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-enterprise/review-audit-logs.md",
"title": "Reviewing audit logs for GitHub Copilot"
} |
[!NOTE]
For an introduction to , see AUTOTITLE.
Enabling for your members
[!NOTE]
and use of third-party MCP servers are disabled by default for organization members assigned a or license by your organization.
Organizations with or can enable these features for members on the policies page for their organizat... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent.md",
"title": "Adding GitHub Copilot cloud agent to your organization"
} |
About organization-level runner controls
By default, runs on a standard -hosted runner (ubuntu-latest). As an organization owner, you can change the default runner type for all repositories in your organization, and choose whether individual repositories are allowed to override this default.
This is useful if your or... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent.md",
"title": "Configuring runners for GitHub Copilot cloud agent in your organization"
} |
Why bring your own API keys?
As an organization owner, you may have specific requirements for governance, data security, and compliance. Setting up your own API keys allows you to address:
Prerequisites
An enterprise owner must have enabled the Enable custom models policy.
Adding your key to an organization account
... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/enable-custom-models.md",
"title": "Enabling custom models for GitHub Copilot in your organization"
} |
Configuring access to in your organization
After a enterprise owner enables or for an organization, an owner of that organization can grant access to members of their organization.After setting up a plan, an organization owner can grant access to members of their organization.
Billing for starts when you grant ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/grant-access.md",
"title": "Granting access to GitHub Copilot for members of your organization"
} |
As an organization owner, you can manage requests for from your organization's settings. Additionally, sends you a weekly email with a summary of all pending requests.
If your organization is owned by an enterprise, before you can approve a request, you may need to request that the enterprise owners enable for your ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/manage-requests-for-access.md",
"title": "Managing requests for GitHub Copilot Business in your organization"
} |
About organization-level revocation
Revoking access at the organization level only removes access for people who receive through the organization. If a person also has access through an enterprise team or as an individual, they will retain it.
To remove access for those users, an enterprise owner must remove them from... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/manage-access/revoke-access.md",
"title": "Revoking access to GitHub Copilot for members of your organization"
} |
[!IMPORTANT] If your enterprise has opted in to the enterprise teams model access preview, your organization will not be able to access model settings. See AUTOTITLE.
Which models can I configure?
If your organization is part of an enterprise, the enterprise owner controls which models are available and how they can ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/manage-default-models.md",
"title": "Managing the availability of models in an organization"
} |
[!NOTE]
If your organization was granted access to through an enterprise, your enterprise admin will need to cancel the plan instead. See AUTOTITLE.
To cancel your plan for your organization account, you need to remove all assigned seats. | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/manage-plan/cancel.md",
"title": "Canceling GitHub Copilot for your organization"
} |
Enabling features and models in your organization
1. click .
Click Policies to edit the policies that control privacy and availability of features.
Click Models to edit the policies that control availability of models beyond the basic models provided with , which may incur additional costs.
1. For each polic... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md",
"title": "Managing policies and features for GitHub Copilot in your organization"
} |
Prerequisites
You should understand what are and how they work. See AUTOTITLE.
[!NOTE]
If your organization is part of an enterprise, enterprise owners can configure a ruleset that restricts . Contact your enterprise owners to check whether you can create and manage organization-level .
Preparing your organization ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents.md",
"title": "Preparing to use custom agents in your organization"
} |
1. At the top of the page, under "," you can see an overview of your organization's usage. You can see the number seats assigned through your or plan, and the estimated monthly cost.
!Screenshot of the usage overview.
!Screenshot of the usage overview.
1. Alternatively, under "Access management," you can use... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-for-organization/review-activity/review-user-activity-data.md",
"title": "Reviewing user activity data for GitHub Copilot in your organization"
} |
Prerequisites
Before you create your Model Context Protocol (MCP) registry, you should understand the functionality and benefits of MCP management for your company. See AUTOTITLE.
Option 1: Self-hosting an MCP registry
At its core, an MCP registry is a set of HTTPS endpoints that serve details about the included MCP s... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-mcp-usage/configure-mcp-registry.md",
"title": "Configure an MCP registry for your organization or enterprise"
} |
[!NOTE]
The MCP registry URL and allowlist are in and subject to change.
Prerequisites
Before you can fully configure MCP server access for your company, you need to create an MCP registry. See AUTOTITLE.
Configuring the MCP allowlist policy for an enterprise
To ensure uniform access, you can set and maintain your ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/manage-mcp-usage/configure-mcp-server-access.md",
"title": "Configure MCP server access for your organization or enterprise"
} |
By comparing user-initiated and agent-initiated activity across models, languages, and modes, you can see how teams are adopting AI-assisted and agent-driven development.
The dashboard shows aggregated code generation activity, including:
Lines of code changed with AI. The total lines of code added and deleted across ... | {
"source": "github-docs/copilot/how-tos/administer-copilot/view-code-generation.md",
"title": "Viewing the code generation dashboard"
} |
Instead of a flat active-user count, the impact dashboard groups users into adoption cohorts based on how they engage with , and connects that engagement to pull request throughput. This gives you a more meaningful signal of adoption depth than daily or weekly active user counts alone.
For a detailed explanation of wha... | {
"source": "github-docs/copilot/how-tos/administer-copilot/view-impact-dashboard.md",
"title": "Viewing the Copilot impact dashboard"
} |
After your initial rollout, the usage metrics dashboard helps you monitor how usage evolves over time. By exploring adoption, feature, model, and language trends, you can see how developers are engaging with and identify areas where additional enablement or communication may drive deeper value.
Prerequisite
Accessi... | {
"source": "github-docs/copilot/how-tos/administer-copilot/view-usage-and-adoption.md",
"title": "Viewing the Copilot usage metrics dashboard"
} |
Introduction
This guide describes how to use and agents to automate coding tasks by breaking them into steps, using tools to read files, edit code, and run commands, and self-correcting when something goes wrong. You can also ask general questions about software development, or specific questions about the code in you... | {
"source": "github-docs/copilot/how-tos/chat-with-copilot/chat-in-ide.md",
"title": "Asking GitHub Copilot questions in your IDE"
} |
Prerequisites
Access to . See AUTOTITLE.
Canary installed. For installation instructions, see Installing Canary.
connected to Terminal Chat. See AUTOTITLE.
If you have access to via your organization or enterprise, you cannot use in if your organization owner or enterprise administrator has disabled . See AUTO... | {
"source": "github-docs/copilot/how-tos/chat-with-copilot/chat-in-windows-terminal.md",
"title": "Asking GitHub Copilot questions in Windows Terminal"
} |
You can ask specific questions about your project or general software questions. You can also ask to write code, fix errors, write tests, and document code.
Use the tabs above to select the environment where you are using .
<a href="vscode://GitHub.Copilot-Chat?refproduct=copilot&reftype=engagement&refstyle=button" t... | {
"source": "github-docs/copilot/how-tos/chat-with-copilot/get-started-with-chat-in-your-ide.md",
"title": "Getting started with prompts for GitHub Copilot Chat in your IDE"
} |
About local sandbox configuration
You can use the /sandbox slash command to grant extra paths, adjust network access, or turn sandboxing on or off.
For a conceptual overview of cloud and local sandboxes for , see AUTOTITLE.
Opening the sandbox configuration
1. Start a session.
1. Enter the /sandbox slash command.
... | {
"source": "github-docs/copilot/how-tos/cloud-and-local-sandboxes/configuring-local-sandbox-settings.md",
"title": "Configuring local sandbox settings"
} |
About enabling and disabling cloud sandboxes
Organization owners can control whether members of their organization have access to cloud sandboxes by configuring the cloud sandbox access policy. Enterprise owners can control cloud sandbox access for all organizations in the enterprise. By default, cloud sandbox access i... | {
"source": "github-docs/copilot/how-tos/cloud-and-local-sandboxes/enabling-or-disabling-cloud-sandboxes-for-your-organization.md",
"title": "Enabling or disabling cloud sandboxes for your organization or enterprise"
} |
About local sandboxing
Sandboxing is currently an experimental feature. To use it, start with the ‑‑experimental command line option, or enter /experimental on during a session.
When you enable local sandboxing, runs most of the commands and tools it invokes on your behalf inside an operating-system sandbox. After yo... | {
"source": "github-docs/copilot/how-tos/cloud-and-local-sandboxes/using-local-sandboxing.md",
"title": "Using local sandboxing"
} |
Configuring content exclusion for your repository
You can use your repository settings to specify content in your repository that should ignore.
[!NOTE]
and Agent mode in in IDEs do not support content exclusion. For more information about these features, see AUTOTITLE and AUTOTITLE.
1. click then click Conten... | {
"source": "github-docs/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot.md",
"title": "Excluding content from GitHub Copilot"
} |
Organization and repository settings include the ability to exclude content from being used by . You can review any changes that are made to these content exclusion settings.
Reviewing changes in your repository
1. click .
1. Click the time of the last change.
!Screenshot of the last edited information. The time ... | {
"source": "github-docs/copilot/how-tos/configure-content-exclusion/review-changes.md",
"title": "Reviewing changes to content exclusions for GitHub Copilot"
} |
<!-- START VS CODE TAB --
This version of this article is for using repository custom instructions and prompt files in . Click the tabs above for instructions on using custom instructions in other environments.
Custom instructions must be enabled. This feature is enabled by default. See Enabling or disabling repositor... | {
"source": "github-docs/copilot/how-tos/configure-custom-instructions-in-your-ide/add-repository-instructions-in-your-ide.md",
"title": "Adding repository custom instructions for GitHub Copilot in your IDE"
} |
To use in an IDE or the command line, you must authenticate to an account on that has a license.
If you receive access to through a owned by an enterprise on , you may need to adjust some settings in your IDE before you can authenticate to your account.
Use the tabs at the top of this article to see instructions f... | {
"source": "github-docs/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom.md",
"title": "Using GitHub Copilot with an account on GHE.com"
} |
About in JetBrains IDEs
If you use a JetBrains IDE, can help you with a variety of tasks, including generating code suggestions, explaining how the code in your editor works, and suggesting code fixes. After installation, you can enable or disable , and you can configure advanced settings within your IDE or on . This... | {
"source": "github-docs/copilot/how-tos/configure-personal-settings/configure-in-ide.md",
"title": "Configuring GitHub Copilot in your environment"
} |
You can connect to through an HTTP proxy and use custom certificates. This is useful if you're working on a corporate network that requires a proxy server or if you need to inspect the contents of 's secure connection. See AUTOTITLE.
Configuring proxy settings for
You can configure an HTTP proxy for in your chosen ... | {
"source": "github-docs/copilot/how-tos/configure-personal-settings/configure-network-settings.md",
"title": "Configuring network settings for GitHub Copilot"
} |
brings agentic capabilities to developers' command line. When is enabled, developers can use it to ask to work on tasks locally or delegate work to .
Enabling or disabling
You can control the use of by configuring a policy.
1. To manage policies for , in the sidebar, click .
1. In the " Clients" section, for , se... | {
"source": "github-docs/copilot/how-tos/copilot-cli/administer-copilot-cli-for-your-enterprise.md",
"title": "Administering Copilot CLI for your enterprise"
} |
You can run in a workflow to automate AI-powered tasks as part of your CI/CD process. For example, you can summarize recent repository activity, generate reports, or scaffold project content. runs on the Actions runner like any other CLI tool, so you can install it during a job and invoke it from workflow steps.
Re... | {
"source": "github-docs/copilot/how-tos/copilot-cli/automate-copilot-cli/automate-with-actions.md",
"title": "Automating tasks with Copilot CLI and GitHub Actions"
} |
Overview
You can use to programmatically run Copilot prompts. There are two main ways to do this:
Run a prompt directly from your terminal.
Write a script or automation that leverages .
This guide will walk you through a simple use case for each option.
Run a prompt from the command line
When you want to pass a p... | {
"source": "github-docs/copilot/how-tos/copilot-cli/automate-copilot-cli/quickstart.md",
"title": "Quickstart for automating with {% data variables.copilot.copilot_cli %}"
} |
Introduction
You can pass a prompt directly to in a single command, without entering an interactive session. This allows you to use directly from the terminal, but also allows you to use the CLI programmatically in scripts, CI/CD pipelines, and automation workflows.
To use programmatically you can do either of the f... | {
"source": "github-docs/copilot/how-tos/copilot-cli/automate-copilot-cli/run-cli-programmatically.md",
"title": "Running {% data variables.copilot.copilot_cli %} programmatically"
} |
[!NOTE]
The /every and /after commands are currently experimental features and are only available if you have used the /experimental on slash command, or the ‑‑experimental command line option.
In an interactive session you can schedule a prompt to be submitted automatically. This is useful when you want to repeat a... | {
"source": "github-docs/copilot/how-tos/copilot-cli/automate-copilot-cli/schedule-prompts.md",
"title": "Scheduling prompts in {% data variables.copilot.copilot_cli %}"
} |
Introduction
is a terminal-native AI coding assistant that brings agentic capabilities directly to your command line. can operate like a chatbot, answering your questions, but its true power lies in its ability to work autonomously as your coding partner, allowing you to delegate tasks and oversee its work.
This arti... | {
"source": "github-docs/copilot/how-tos/copilot-cli/cli-best-practices.md",
"title": "Best practices for GitHub Copilot CLI"
} |
Match the layout and spacing exactly
Checklists for complex migrations
For large-scale changes:
Run the linter and write all errors to `migration-checklist.md` as a checklist.
Then fix each issue one by one, checking them off as you go.
Autonomous task completion
Switch into autopilot mode to allow to work autonomou... | {
"source": "github-docs/copilot/how-tos/copilot-cli/cli-best-practices.md",
"title": "Best practices for GitHub Copilot CLI"
} |
Introduction
is a powerful terminal-native AI coding assistant that brings agentic capabilities directly to your command line. The offers deep flexibility, workflow integration, and the ability to work autonomously on complex tasks while maintaining full user control.
This guide will help you start using the CLI.
I... | {
"source": "github-docs/copilot/how-tos/copilot-cli/cli-getting-started.md",
"title": "Getting started with GitHub Copilot CLI"
} |
can provide responses that are tailored to your personal preferences, the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create custom instructions that automatically a... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions.md",
"title": "Adding custom instructions for {% data variables.copilot.copilot_cli %}"
} |
The Model Context Protocol (MCP) is an open standard that defines how applications share context with large language models (LLMs). You can connect MCP servers to to give access to external tools, data sources, and services. For an overview of MCP, see AUTOTITLE.
Adding an MCP server
[!NOTE]
The MCP server is bui... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers.md",
"title": "Adding MCP servers for {% data variables.copilot.copilot_cli %}"
} |
Agent skills are folders of instructions, scripts, and resources that can load when relevant to improve its performance in specialized tasks. For more information, see AUTOTITLE.
1. Start a CLI session, or if you are currently in a CLI session enter /skills reload.
1. Enter /skills info SKILL-NAME to check that the sk... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/add-skills.md",
"title": "Adding agent skills for {% data variables.copilot.copilot_cli %}"
} |
You can use the /settings slash command to view and change your settings from within an interactive CLI session. This command controls user-level settings such as whether updates itself automatically, which color palette the interface uses, what's displayed in the footer, and many other options.
Use /settings to:
Bro... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/change-settings.md",
"title": "Changing settings with the `/settings` command"
} |
Introduction
allow you to tailor 's expertise for specific tasks.
When you prompt to carry out a task it may choose to use one of your , if determines that the agent's expertise is a good fit for the task.
Work performed by a is carried out using a subagent, which is a temporary agent spun up to complete the task. ... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli.md",
"title": "Creating and using custom agents for {% data variables.copilot.copilot_cli %}"
} |
You can download and install , and start using it straight away, without any additional configuration. However, you'll find that you can improve 's responses if you spend a little time providing it with guidelines and context, and giving it access to tools that are relevant to your project. This article introduces the ... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/overview.md",
"title": "Overview of customizing {% data variables.copilot.copilot_cli %}"
} |
Introduction
Plugins are packages that extend the functionality of . See AUTOTITLE.
Plugin structure
A plugin consists of a directory with a specific structure. At minimum, it must contain a plugin.json manifest file at the root of the directory. It can also contain any combination of agents, skills, hooks, and MCP se... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/plugins-creating.md",
"title": "Creating a plugin for {% data variables.copilot.copilot_cli %}"
} |
Introduction
Plugins are packages that extend the functionality of . You can install a plugin from a marketplace that you have registered with the CLI.
For more information, see AUTOTITLE.
Finding plugins
Plugins are collected together in marketplaces. A marketplace is a registry of plugins that you can browse and ins... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/plugins-finding-installing.md",
"title": "Finding and installing plugins for {% data variables.copilot.copilot_cli %}"
} |
Introduction
Plugin marketplaces are registries of plugins for . They can be located on , in any other online Git hosting service, or on your local or shared file system. By creating a marketplace and adding your plugins to it, you can make it easy for other users to find and install your plugins.
Prerequisite
You hav... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/plugins-marketplace.md",
"title": "Creating a plugin marketplace for {% data variables.copilot.copilot_cli %}"
} |
You can configure to use your own LLM provider, also called BYOK (Bring Your Own Key), instead of -hosted models. This lets you connect to OpenAI-compatible endpoints, Azure OpenAI, or Anthropic, including locally running models such as Ollama.
[!NOTE]
This article is for users who want to configure their own LLM pr... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md",
"title": "Using your own LLM models in GitHub Copilot CLI"
} |
Prerequisite
Windows users only: The example hooks in this article are designed to run on Windows, Linux, and macOS. For Windows, they use PowerShell and require you to have PowerShell 7.0 or later installed and in your PATH. You can check your PowerShell version by running pwsh --version in a terminal. To install Powe... | {
"source": "github-docs/copilot/how-tos/copilot-cli/customize-copilot/use-hooks.md",
"title": "Using hooks with {% data variables.copilot.copilot_cli %}"
} |
Introduction
This article explains how to add LSP servers for . For conceptual information about LSP servers, see AUTOTITLE.
Adding an LSP server for is a two-step process:
1. Install the LSP server software on your local machine.
1. Configure the server in a configuration file.
These steps are described in detail in ... | {
"source": "github-docs/copilot/how-tos/copilot-cli/set-up-copilot-cli/add-lsp-servers.md",
"title": "Adding LSP servers for {% data variables.copilot.copilot_cli %}"
} |
About authentication
If you use your own LLM provider API keys (BYOK), authentication is not required.
Authentication is required for any other usage.
When authentication is required, supports three methods. The method you use depends on whether you are working interactively or in an automated environment.
OAuth de... | {
"source": "github-docs/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md",
"title": "Authenticating GitHub Copilot CLI"
} |
Introduction
has several configuration options that control what it can access and do on your behalf.
This article shows you how to set trusted directories, configure access for tools, and grant permissions to file paths and URLs.
Prerequisites
Install the . See AUTOTITLE.
Setting trusted directories
Trusted direct... | {
"source": "github-docs/copilot/how-tos/copilot-cli/set-up-copilot-cli/configure-copilot-cli.md",
"title": "Configuring GitHub Copilot CLI"
} |
To find out about before you install it, see AUTOTITLE.
Prerequisites
An active subscription. See plans.
(On Windows) PowerShell v6 or higher
If you have access to via your organization or enterprise, you cannot use if your organization owner or enterprise administrator has disabled it in the organization or en... | {
"source": "github-docs/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli.md",
"title": "Installing GitHub Copilot CLI"
} |
Authentication errors
If you encounter authentication errors, use the table below to identify the cause and resolution.
Issue Cause Fix ... | {
"source": "github-docs/copilot/how-tos/copilot-cli/set-up-copilot-cli/troubleshoot-copilot-cli-auth.md",
"title": "Troubleshooting GitHub Copilot CLI authentication"
} |
About agentic code review
You can use the /review slash command to have analyze code changes without leaving the CLI. This lets you get quick feedback on your changes prior to committing.
1. Type /review and optionally specify a prompt, path, or file pattern to narrow the review scope, then press <kbdEnter</kbd.
1. If... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/agentic-code-review.md",
"title": "Requesting a code review with {% data variables.copilot.copilot_cli %}"
} |
Introduction
uses a variety of tools to complete tasks for you. It can execute shell commands, read and write files, search your codebase, fetch web content, and delegate tasks to specialized sub-agents.
While read-only operations like searching, reading files, and running read-only shell commands are allowed automati... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools.md",
"title": "Allowing and denying tool use"
} |
By default, interactive sessions for Git repositories have four tabs at the top of the screen:
Session: The regular chat experience where you enter prompts for .
Issues: Open issues in the current repository on .
Pull requests: Open pull requests in the current repository on .
Gists: Your gists on .
The Issues, Pu... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/browse-issues-prs-gists.md",
"title": "Browsing issues, pull requests, and gists from {% data variables.copilot.copilot_cli %}"
} |
stores the data from your CLI sessions locally on your machine, and by default syncs sessions to your account. This session data allows you to:
Resume previous sessions and pick up right where you left off.
Use the /chronicle slash command to generate standup reports, get personalized tips, and receive suggestions f... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle.md",
"title": "Using {% data variables.copilot.copilot_cli %} session data"
} |
Connecting to gives you the best of both environments: the speed and flexibility of a terminal-based workflow, combined with the rich visual tools of your editor. With a connection established, you can:
Use your editor selection as context — Select code in and reference it directly in CLI prompts, without needing t... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/connecting-vs-code.md",
"title": "Connecting {% data variables.copilot.copilot_cli %} to {% data variables.product.prodname_vscode_shortname %}"
} |
Debug this
Alternatively, you can select some code but ask about the whole file: | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/connecting-vs-code.md",
"title": "Connecting {% data variables.copilot.copilot_cli %} to {% data variables.product.prodname_vscode_shortname %}"
} |
Explain this file
Reviewing file changes as diffs
When you ask to make changes to a file in the workspace, displays the proposed changes as a diff in a new editor tab. This makes it easy to see exactly what is proposing. Use the accept (✓) or reject (✗) buttons in the top-right of the diff view to apply or discard ... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/connecting-vs-code.md",
"title": "Connecting {% data variables.copilot.copilot_cli %} to {% data variables.product.prodname_vscode_shortname %}"
} |
offers two ways to have work autonomously: autopilot mode and the /delegate command. Both let you hand off tasks, but they differ in where the work happens:
Autopilot mode runs locally in your CLI session. You give autopilot full permissions and then works on a task without stopping to prompt you for input. Your loc... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/delegate-tasks-to-cca.md",
"title": "Delegating tasks to {% data variables.product.prodname_copilot_short %}"
} |
Use
A is a specialized version of . help handle unique workflows, particular coding conventions, and specialist use cases.
includes a default group of for common tasks:
<table
<thead
<tr
<th style="width:20%"Agent</th
<thDescription</th
</tr
</thead
<tbody
<tr
<tdExplore</td
... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/invoke-custom-agents.md",
"title": "Invoking custom agents"
} |
Overview
The /pr slash command lets you manage the full pull request lifecycle without leaving your terminal. You can check pull request status, create new pull requests, and fix common issues such as review feedback, merge conflicts, and CI failures.
Prerequisite
You must be working in a Git repository that is hosted... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/manage-pull-requests.md",
"title": "Managing pull requests with the /pr command"
} |
The command-line interface (CLI) for allows you to use directly from your terminal. For more information, see AUTOTITLE.
Prerequisite
Install . See AUTOTITLE.
Using
1. In your terminal, navigate to a folder that contains code you want to work with.
1. Enter copilot to start .
will ask you to confirm that you t... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/overview.md",
"title": "Using GitHub Copilot CLI"
} |
Introduction
When you work in an interactive session, can make changes to files, run shell commands, and modify your repository. If the result isn't what you expected, you can rewind to a previous point in the session to undo those changes.
You can trigger a rewind by pressing <kbdEsc</kbd twice, or by using the /und... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/roll-back-changes.md",
"title": "Rolling back changes made during a {% data variables.copilot.copilot_cli %} session"
} |
[!NOTE]
session limits are currently in and subject to change.
An session limit caps the amount of that can spend in a session.
are the unit uses to track the cost of AI model interactions: each credit equals , and usage depends on the model and the number of tokens consumed.
When you set an session limit for ... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/set-session-limit.md",
"title": "Setting an {% data variables.product.prodname_ai_credit_singular %} session limit in {% data variables.copilot.copilot_cli %}"
} |
Where a task involves multiple operations, some or all of which can be worked on in parallel, the /fleet slash command can speed up task completion. When you use this command, assigns separate parts of the work to subagents.
For more information, see AUTOTITLE.
Using the /fleet slash command
To use the /fleet slash c... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/speed-up-task-completion.md",
"title": "Speeding up task completion with the `/fleet` command"
} |
Steer the conversation while is thinking
While is working on a task, you can enter a new prompt at any time. Any input you send while is thinking is treated as steering and is considered in the context of the current task.
There is no separate instruction queue. To provide additional instructions, enter another prom... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/steer-agents.md",
"title": "Steering agents in {% data variables.copilot.copilot_cli %}"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.