text stringlengths 12 91.7k | metadata dict |
|---|---|
Remote control lets you connect to a running session from any browser or from . You can view session output, respond to permission requests, and continue working in the session without being at the machine where the session is running.
This article explains how to enable and use remote control. For more conceptual inf... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/steer-remotely.md",
"title": "Steering a {% data variables.copilot.copilot_cli %} session from another device"
} |
Voice input lets you dictate prompts to by speaking into your microphone instead of typing on the keyboard. Transcription runs entirely on your local machine. Your audio is not sent over the network. The recognized text is inserted at the cursor position in the prompt input area, where you can edit it before submittin... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli/voice-input.md",
"title": "Use voice input with Copilot CLI"
} |
For background on authentication options and how billing works when running in , see AUTOTITLE.
Enabling the policy
For workflows in your organization to use with GITHUBTOKEN, the policy must be enabled. This policy is enabled by default for organizations with turned on, but you can confirm or change this setting i... | {
"source": "github-docs/copilot/how-tos/copilot-cli/use-copilot-cli-in-actions.md",
"title": "Using Copilot CLI in GitHub Actions with GITHUB_TOKEN"
} |
Submitting a question to
is available from any page on . Some questions work best in a specific context, such as a repository, issue, or pull request.
1. In the prompt box, type a question and press <kbdEnter</kbd.
Some examples of general questions you could ask are:
What are the advantages of the Go programm... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-github.md",
"title": "Asking GitHub Copilot questions in GitHub"
} |
Limitations
The following limitations apply to :
If you're a member of an organization or enterprise, your access to may depend on policies set by your administrator. See AUTOTITLE.
If you purchased , , or through an in-app purchase on iOS or Android, you cannot enable additional . To do so, cancel your mobile subs... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/chat-with-copilot/chat-in-mobile.md",
"title": "Asking GitHub Copilot questions in GitHub Mobile"
} |
<a href="https://github.com/copilot?refproduct=copilot&reftype=engagement&refstyle=button" target="blank" class="btn btn-primary mt-3 mr-3 mb-3 no-underline"
<spanChat with on </span
</a
responds differently depending on where you are on . The following examples show the kinds of questions you can ask in each co... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/chat-with-copilot/get-started-with-chat.md",
"title": "Getting started with prompts for {% data variables.copilot.copilot_chat_short %} on {% data variables.product.github %}"
} |
Generate a pull request summary
can summarize a pull request in the description field or as a comment, helping reviewers quickly understand what changed.
[!NOTE] does not take into account any existing content in the pull request description, so start with a blank description for best results.
1. On , create a pull ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/create-a-pr-summary.md",
"title": "Creating a pull request summary with GitHub Copilot"
} |
[!NOTE]
This feature is in and subject to change.
can create or update issues from a natural-language prompt or a screenshot. It fills in the title, body, labels, assignees, and more—using your repository's issue forms or templates when available. Review and refine every draft before you submit.
Create an issue
1. ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/use-copilot-to-create-or-update-issues.md",
"title": "Using GitHub Copilot to create or update issues"
} |
The MCP server is pre-configured in with a limited set of skills, so you can use it immediately. Instruct to perform tasks like creating branches or merging pull requests on your behalf.
For a full list of available skills, see AUTOTITLE. For more about MCP, see AUTOTITLE.
Use the MCP server
1. Type a request and ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/copilot-for-github-tasks/using-the-github-mcp-server-from-copilot-chat.md",
"title": "Using the GitHub MCP Server from Copilot Chat"
} |
Organization owners can add instructions for , to tailor responses to specific needs and preferences across the organization. For an overview of this, and other types of custom instructions for , see AUTOTITLE.
Adding organization custom instructions
You can add organization custom instructions via your organization s... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-organization-instructions.md",
"title": "Adding organization custom instructions for GitHub Copilot"
} |
You can layer multiple types of custom instructions to shape responses. For an overview, see AUTOTITLE.
About personal custom instructions for
Personal custom instructions apply to every conversation you have on the website, so always responds in your preferred language, tone, and style.
Examples of instructions y... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-personal-instructions.md",
"title": "Adding personal custom instructions for GitHub Copilot"
} |
Introduction
Repository custom instructions let you provide with repository-specific guidance and preferences on . To find out how to set up custom instructions in an IDE, see AUTOTITLE. For more information about custom instructions, see AUTOTITLE.
For , your personal choice of whether to use custom instructions mus... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions.md",
"title": "Adding repository custom instructions for GitHub Copilot"
} |
Prerequisite
Before setting up MCP servers for your repository, read AUTOTITLE and AUTOTITLE.
Introduction
As a repository administrator, you can configure MCP servers for use within your repository. You do this using a JSON-formatted configuration that specifies the details of the MCP servers you want to use. You ent... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md",
"title": "Configure MCP servers for your repository"
} |
Required keys for local and remote MCP servers
tools (string[]): The tools from the MCP server to enable. You may be able to find a list of tools in the server's documentation, or in its code. We strongly recommend that you allowlist specific read-only tools, since the agent will be able to use these tools autonomousl... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md",
"title": "Configure MCP servers for your repository"
} |
Remote MCP specific keys
url (string): Required. The MCP server's URL.
headers (object): Optional. The headers to attach to requests to the server. This object should map the name of header keys to one of the following:
A substitution reference to a secret or variable in your environment, such as $COPILOTMCPAPIKE... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/configure-mcp-servers.md",
"title": "Configure MCP servers for your repository"
} |
let you organize the context that uses to answer your questions. Sharing helps others:
Avoid repeated explanations and handoffs.
Stay aligned on how a system works or what’s expected.
Learn from past work, documentation, and examples.
Get better help from with grounded, curated context.
Use cases for collaborat... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/collaborate-with-others.md",
"title": "Collaborating with others using GitHub Copilot Spaces"
} |
Creating a space
1. To create a space, go to https://github.com/copilot/spaces, and click Create space.
1. Give your space a name.
1. Choose whether the space is owned by you or by an organization you belong to. Organization-owned can be shared using ’s built-in permission model.
1. Click Create Space.
1. Optionally, ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces.md",
"title": "Creating GitHub Copilot Spaces"
} |
[!NOTE]
Agent skills work with , , the , the , and agent mode in .
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.
Managing skills with
[!NOTE]
gh skill is in and subject to change. ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/add-skills.md",
"title": "Adding agent skills for {% data variables.product.prodname_copilot %}"
} |
About secrets and variables for
When you delegate a task to , it works in its own ephemeral development environment, powered by . You may want to pass secrets and variables to the agent to:
Give access to private resources, such as internal package registries, when it builds, tests, or validates your code in the age... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/configure-secrets-and-variables.md",
"title": "Configure secrets and variables for Copilot cloud agent"
} |
allow you to tailor 's expertise for specific tasks. For a conceptual overview of , see AUTOTITLE.
Creating a profile in a repository on
1. Go to the agents tab at https://github.com/copilot/agents.
1. Using the dropdown menu in the prompt box, select the repository you want to create the profile in.
[!NOTE]
... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/create-custom-agents.md",
"title": "Creating custom agents for {% data variables.copilot.copilot_cloud_agent %}"
} |
About customizing 's development environment
While working on a task, has access to its own ephemeral development environment, powered by , where it can explore your code, make changes, execute automated tests and linters and more.
You can customize 's development environment with a setup steps file. You can use a s... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md",
"title": "Configure the development environment"
} |
Introduction
Before you release or update a in your organization or enterprise, you can test the agent privately to ensure it meets your standards. Once you are satisfied, you can then easily change the location of your to make it available across your company.
Prerequisites
Before you can test a , you need to set u... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/test-custom-agents.md",
"title": "Testing and releasing {% data variables.copilot.custom_agents_short %} in your organization or enterprise"
} |
Creating a hook in a repository on
1. Create a new NAME.json file (where NAME describes the purpose of the file) in the .github/hooks/ folder of your repository.
[!IMPORTANT]
The hooks configuration file must be present on your repository's default branch to be used by .
Troubleshooting
Further reading
AUTO... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/use-hooks.md",
"title": "Customize agent workflows with hooks"
} |
This quickstart walks you through customizing for a repository. By the end, will know your project's conventions, have a specialized agent for common tasks, and have curated project context.
Scenario: You work on a team's web application repository with an established test suite, coding conventions, and active issues... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview.md",
"title": "Customize {% data variables.product.prodname_copilot_short %} for your project"
} |
[!NOTE]
Firewall configuration is managed from the "Internet access" settings tab, which covers both and . Previous configurations saved as Actions variables will be maintained on that page.
Overview
By default, 's access to the internet is limited by a firewall.
[!NOTE]
also supports firewall configuration, at b... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/customize-copilot/customize-the-firewall.md",
"title": "Customizing or disabling the firewall for GitHub Copilot"
} |
Your access to models depends on:
Your plan.
The client you use (for example, , , or JetBrains IDEs).
Whether your organization or enterprise restricts access to specific models.
For a list of available AI models, see AUTOTITLE. For information on how serves different AI models, see AUTOTITLE.
Setup for individu... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/configure-access-to-ai-models.md",
"title": "Configuring access to AI models in GitHub Copilot"
} |
Introduction
You can configure to review pull requests automatically. For an overview of automatic pull request reviews, see AUTOTITLE.
Configuring automatic code review for your own pull requests
[!NOTE]
This is only available if you are on the , , or plans.
1. Locate the Automatic option and click the dropdown ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/configure-automatic-review.md",
"title": "Configuring automatic code review by GitHub Copilot"
} |
About usage for code review tools
Organizations in this situation can use self-hosted runners.
You can also upgrade to larger -hosted runners for better performance.
Configure self-hosted runners for code review
Run using self-hosted runners with ARC (Actions Runner Controller). You must first set up ARC-managed s... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/configure-runners.md",
"title": "Configuring runners for GitHub Copilot code review"
} |
With a dedicated enterprise account, you get enterprise-grade identity provider integrations for authentication and provisioning without paying for licenses. See AUTOTITLE.
Create an enterprise account
To create an enterprise account, contact 's sales team. They will provision you with a standard enterprise account w... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-a-dedicated-enterprise-for-copilot-business.md",
"title": "Setting up a dedicated enterprise for GitHub Copilot Business"
} |
Enable
To purchase for your enterprise, contact 's Sales team.
A member of the Sales team will work with you to set up for your enterprise.
Set policies
You will use enterprise policies to manage two aspects of governance:
Availability: Which features, models, and MCP servers are available in your enterprise?
Co... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-enterprise.md",
"title": "Setting up GitHub Copilot for your enterprise"
} |
Enable for your organization through an enterprise account
To enable for your organization, your organization needs to be part of an enterprise account with a subscription. If you don't already have an enterprise account, you can create one specifically for managing licenses. See AUTOTITLE.
If your organization alr... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-organization.md",
"title": "Setting up GitHub Copilot for your organization"
} |
Get access to
gives you up to 2,000 code completions and limited access to select features, allowing you to try AI-powered coding assistance at no cost. Start using .
For higher limits and access to more models, subscribe to , , or . See AUTOTITLE for details on all plans, including free options for students, teache... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-self.md",
"title": "Setting up GitHub Copilot for yourself"
} |
About access
Verified students on get free access to 's features. See AUTOTITLE.
To become a verified student, see AUTOTITLE.
reevaluates your eligibility every month.
Access
1. Navigate to https://github.com/settings/education/benefits.
If you are not yet a verified student, click Start an application and comp... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-students.md",
"title": "Access GitHub Copilot for free as a student"
} |
About free access
There are two ways to qualify for free access to :
As a verified teacher on . To become a verified teacher, see AUTOTITLE.
As a maintainer of a popular open-source repository. To check your eligibility, see Accessing for free.
reevaluates your eligibility every month.
What if I don't qualify for... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-for-teachers-and-os-maintainers.md",
"title": "Access Copilot Pro for free as a teacher or open source maintainer"
} |
is also available for organization members without a license, when enabled by an enterprise administrator or organization owner. See for organization members without a license.
Request a review from
1. On , create or open a pull request.
1. Under "Reviewers" in the right sidebar, next to , click Request.
!Scree... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/use-copilot-agents/copilot-code-review.md",
"title": "Using {% data variables.copilot.copilot_code-review %} on {% data variables.product.github %}"
} |
You can start a task in several ways. Assigning an issue always creates a pull request. Starting with a prompt works on a branch by default, giving you a chance to review, steer, and iterate before you open a pull request. Seeding a repository creates a draft pull request with scaffolded code.
Assign an issue to
Ass... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/use-copilot-agents/kick-off-a-task.md",
"title": "Kick off a task with {% data variables.product.prodname_copilot_short %} agents on {% data variables.product.github %}"
} |
Use the agents panel on to monitor and manage agent sessions across your repositories.
Monitor agent activity
Track sessions from the agents panel (available from any page on ) or from the agents page. Sessions that you started, or that another user prompted to work on, appear in your sessions list.
Click a session ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/use-copilot-agents/manage-and-track-agents.md",
"title": "Managing agent sessions"
} |
Prerequisite
You need a repository where is enabled. For and subscribers, an administrator must enable the agent before you can use it. See AUTOTITLE.
Step 1: Assign an issue to
Pick a repository where is enabled and find an open issue—or create a small one, such as "Add a CONTRIBUTING.md file."
1. In the right s... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/use-copilot-agents/overview.md",
"title": "Get started with {% data variables.product.prodname_copilot_short %} agents on {% data variables.product.github %}"
} |
lets you:
Research a repository by asking questions.
Plan and refine an approach before makes changes.
Iterate on code changes, review a diff, and create a pull request when you're ready.
Sessions do not create pull requests automatically. To create one immediately, include that in your prompt—for example, "Create... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/use-copilot-agents/research-plan-iterate.md",
"title": "Research, plan, and iterate on code changes with {% data variables.copilot.copilot_cloud_agent %}"
} |
Review 's changes
When finishes a coding task and requests your review, check the pull request thoroughly before merging.
[!IMPORTANT]
If your repository requires pull request approvals, your approval of a pull request won't count toward the required number. Another reviewer must approve the pull request before it ... | {
"source": "github-docs/copilot/how-tos/copilot-on-github/use-copilot-agents/review-copilot-output.md",
"title": "Review output from {% data variables.product.prodname_copilot_short %}"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Authentication methods
Method Use Case Copilot Subscription Required
-------------------------------------------------
GitHub Signed-in User Interactive apps where users sign in ... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/auth/authenticate.md",
"title": "Authentication"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Supported providers
Provider Type Value Notes
-----------------------------
OpenAI "openai" OpenAI API and OpenAI-compatible endpoints
Microsoft Foundry / Azure OpenAI "opena... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/auth/byok.md",
"title": "BYOK (bring your own key)"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/auth/index.md",
"title": "Authentication"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
GitHub Actions
For workflows in an organization-owned repository, grant the built-in token permission to make Copilot requests:
permissions:
contents: read
copilot-requests: write
... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/auth/server-to-server-tokens.md",
"title": "Server-to-server authentication"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Architecture
The SDK is a transport layer—it sends your prompt to the Copilot CLI over JSON-RPC and surfaces events back to your app. The CLI is the orchestrator that runs the agentic ... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/agent-loop.md",
"title": "The agent loop"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Prerequisites
Before creating a cloud session, make sure:
The user has Copilot access with cloud-agent entitlement.
The session can authenticate to GitHub, either with a user token o... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/cloud-sessions.md",
"title": "Cloud sessions"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Overview
Custom agents are lightweight agent definitions you attach to a session. Each agent has its own system prompt, tool restrictions, and optional MCP servers. When a user's reque... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/custom-agents.md",
"title": "Custom agents and sub-agent orchestration"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
When to use fleet mode
Fleet mode is useful when the work can be decomposed before execution and each unit can run without waiting for the others.
Good fits include:
Multi-file refact... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/fleet-mode.md",
"title": "Fleet mode"
} |
FROM todos t
WHERE t.status = 'pending'
AND NOT EXISTS (
SELECT 1
FROM todo_deps td
JOIN todos dep ON td.depends_on = dep.id
WHERE td.todo_id = t.id
AND dep.status != 'done'
);
This pattern gives every worker a clear owner and lets the parent session reason about what is ready, runni... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/fleet-mode.md",
"title": "Fleet mode"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Overview
A hook is a callback you register once when creating a session. The SDK invokes it at a well-defined point in the conversation lifecycle, passes contextual input, and optional... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/hooks.md",
"title": "Working with hooks"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
File attachment (type: "file"): provide an absolute path; the runtime reads the file from disk, converts it to base64, and sends it to the LLM.
Blob attachment (type: "blob"): provide... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/image-input.md",
"title": "Image input"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/index.md",
"title": "Features"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
[!NOTE]
This is an evolving feature. See issue 36 for ongoing discussion.
What is MCP?
Model Context Protocol (MCP) is an open standard for connecting AI assistants to external tools... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/mcp.md",
"title": "Using MCP servers with the GitHub Copilot SDK"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
This guide explains the plugin folder layout, how to load a plugin from a directory, when to use plugin directories vs. registering individual extensions, and how to make plugin sets de... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/plugin-directories.md",
"title": "Plugin directories"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
For running sessions on GitHub-hosted compute, see AUTOTITLE.
Prerequisites
The user must be authenticated (GitHub token or logged-in user)
The session's working directory must be a ... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/remote-sessions.md",
"title": "Remote sessions"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Configure a session limit
Set maxAiCredits to the AI Credits soft cap for the session's current accounting window. Usage is checked after model calls return, so one response can exceed... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/session-limits.md",
"title": "Session limits"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
How sessions work
When you create a session, the Copilot CLI maintains conversation history, tool state, and planning context. By default, this state lives in memory and disappears whe... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/session-persistence.md",
"title": "Session resume and persistence"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Overview
A skill is a named directory containing a SKILL.md file—a markdown document that provides instructions to Copilot. When loaded, the skill's content is injected into the sessio... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/skills.md",
"title": "Custom skills"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Overview
When a session is actively processing a turn, incoming messages can be delivered in one of two modes via the mode field on MessageOptions:
Mode Behavior Use case
---------... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/steering-and-queueing.md",
"title": "Steering and queueing"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Overview
When streaming: true is set on a session, the SDK emits ephemeral events in real time (deltas, progress updates) alongside persisted events (complete messages, tool results). ... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/streaming-events.md",
"title": "Streaming session events"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
[!TIP]
Each example is functionally equivalent across languages. The TypeScript snippet is expanded by default; select your language from the collapsible blocks to see the same logic ... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/features/usage-and-billing.md",
"title": "Usage and billing metrics"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
What you'll build:
You: What's the weather like in Seattle?
Copilot: Let me check the weather for Seattle...
Currently 62°F and cloudy with a chance of rain.
Typical S... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/getting-started.md",
"title": "Build your first Copilot-powered app"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Implement custom error logging
Track error patterns
Provide user-friendly error messages
Trigger alerts for critical errors
Hook signature
import type { ErrorOccurredHookInput, Hoo... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/hooks/error-handling.md",
"title": "Error handling hook"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Control tool execution - approve, deny, or modify tool calls
Transform results - modify tool outputs before they're processed
Add context - inject additional information at session s... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/hooks/hooks-overview.md",
"title": "Session hooks"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/hooks/index.md",
"title": "Use hooks"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Transform or filter tool results
Log tool execution for auditing
Add context based on results
Suppress results from the conversation
Failure variant — onPostToolUse only fires for ... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/hooks/post-tool-use.md",
"title": "Post-tool use hook"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Approve or deny tool execution
Modify tool arguments
Add context for the tool
Suppress tool output from the conversation
Hook signature
import type { PreToolUseHookInput, HookInvoc... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/hooks/pre-tool-use.md",
"title": "Pre-tool use hook"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Initialize context when sessions begin
Clean up resources when sessions end
Track session metrics and analytics
Configure session behavior dynamically
Session start hook {session-s... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/hooks/session-lifecycle.md",
"title": "Session lifecycle hooks"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Modify or enhance user prompts
Add context before processing
Filter or validate user input
Implement prompt templates
Hook signature
import type { UserPromptSubmittedHookInput, Hoo... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/hooks/user-prompt-submitted.md",
"title": "User prompt submitted hook"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/index.md",
"title": "Copilot SDK"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/integrations/index.md",
"title": "Integrations"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Overview
The Microsoft Agent Framework is the unified successor to Semantic Kernel and AutoGen. It provides a standard interface for building, orchestrating, and deploying AI agents. D... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/integrations/microsoft-agent-framework.md",
"title": "Microsoft agent framework integration"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/observability/index.md",
"title": "Observability"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Built-in telemetry support
The SDK has built-in support for configuring OpenTelemetry on the CLI process and propagating W3C Trace Context between the SDK and CLI. Provide a TelemetryC... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/observability/opentelemetry.md",
"title": "OpenTelemetry instrumentation for Copilot SDK"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
This guide shows how to use Azure Identity SDK APIs to authenticate with Microsoft Foundry models through the GitHub Copilot SDK. Most languages use DefaultAzureCredential; Rust uses De... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/azure-managed-identity.md",
"title": "Azure managed identity with BYOK"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Best for: Web app backends, API services, internal tools, CI/CD integrations, any server-side workload.
How it works
Instead of the SDK spawning a CLI child process, you run the CLI in... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/backend-services.md",
"title": "Backend services setup"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
The Python SDK recommends a one-time download step after installation:
python -m copilot download-runtime
This downloads the matching runtime and caches it locally. If you skip this ste... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/bundled-cli.md",
"title": "Default setup (bundled CLI)"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Architecture at a glance
Every Copilot SDK integration follows the same core pattern: your application talks to the SDK, which communicates with the Copilot CLI over JSON-RPC. What cha... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/choosing-a-setup-path.md",
"title": "Setup guides"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Best for: Multi-user apps, internal tools with org access control, SaaS products, apps where users have GitHub accounts.
How it works
You create a GitHub OAuth App (or GitHub App), use... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/github-oauth.md",
"title": "GitHub OAuth setup"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/index.md",
"title": "Set up Copilot SDK"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Use when: You need to pin a specific CLI version, or work with the Go SDK (which does not include a CLI automatically).
How it works
By default, the Node.js, Python, and .NET SDKs incl... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/local-cli.md",
"title": "Local CLI setup"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Best for: SaaS products, partner integrations, internal platforms, and backend services that handle concurrent users.
Use this guide when
Use this guide when you are building:
A multi... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/multi-tenancy.md",
"title": "Multi-tenancy and server deployments"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
For SDK-level options and patterns, see AUTOTITLE.
Best for: Platform developers, SaaS builders, any deployment serving more than a handful of concurrent users.
Core concepts
Before ch... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/setup/scaling.md",
"title": "Scaling and multi-tenancy"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Overview
The Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must be explicitly exposed through this protocol to be available in the SDK. Many interactive CLI fea... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/troubleshooting/compatibility.md",
"title": "SDK and CLI compatibility"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Table of contents
Enable Debug Logging
Common Issues
MCP Server Debugging
Connection Issues
Tool Execution Issues
Platform-Specific Issues
Enable debug logging
The first step in... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/troubleshooting/debugging.md",
"title": "Debugging guide"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -- | {
"source": "github-docs/copilot/how-tos/copilot-sdk/troubleshooting/index.md",
"title": "Troubleshooting"
} |
<!-- markdownlint-disable GHD046 GHD005 --
<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) --
Table of contents
Quick Diagnostics
Testing MCP Servers Independently
Common Issues
Platform-Specific Issues
Advanced Debugging
Quick diagnostics
Checklist
Before diving deep, v... | {
"source": "github-docs/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging.md",
"title": "MCP server debugging guide"
} |
This version of this article is for in JetBrains IDEs. For on other platforms, click the appropriate tab above.
This version of this article is for in . For on other platforms, click the appropriate tab above.
This version of this article is for on the website. For on other platforms, click the appropriate tab a... | {
"source": "github-docs/copilot/how-tos/get-code-suggestions/find-matching-code.md",
"title": "Finding public code that matches GitHub Copilot suggestions"
} |
<style
.button-container {
display: flex;
gap: 10px;
}
</style
<div class="button-container"
<a href="https://github.com/copilot?refproduct=copilot&reftype=trial&refstyle=button&refplan=free" target="blank" class="btn btn-primary mt-3 mr-3 no-underline"
<spanGet started for free</span
</a
<... | {
"source": "github-docs/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md",
"title": "Getting code suggestions in your IDE with GitHub Copilot"
} |
INNER JOIN
will automatically suggest a join condition in grayed text. The exact suggestion may vary.
You can also describe something you want to do using natural language within a comment, and will suggest the code to accomplish your goal. For example, type this comment in a SQL file:
SELECT TokenColor, COUNT(UserI... | {
"source": "github-docs/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md",
"title": "Getting code suggestions in your IDE with GitHub Copilot"
} |
INNER JOIN
will show you a suggestion.
Now hover over the suggestion to show the control for choosing suggestions. To display next or previous suggestions, click the forward or back arrow button in the control.
You can also use keyboard shortcuts to show alternative suggestions:
OS See next suggestion ... | {
"source": "github-docs/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md",
"title": "Getting code suggestions in your IDE with GitHub Copilot"
} |
INNER JOIN
will show you a suggestion in grayed text. The exact suggestion may vary.
Now hover over the suggestion to show the control for choosing suggestions. To accept only the next word of the suggestion, click Accept Word in the control.
Alternatively, you can use a keyboard shortcut to accept the next word of a... | {
"source": "github-docs/copilot/how-tos/get-code-suggestions/get-ide-code-suggestions.md",
"title": "Getting code suggestions in your IDE with GitHub Copilot"
} |
About creating
You can create with a coding agent (recommended) or manually. A workflow is a markdown file in .github/workflows/ that contains YAML frontmatter for configuration and natural language instructions for the AI agent.
To create an agentic workflow, you define the workflow in markdown, compile it into a .l... | {
"source": "github-docs/copilot/how-tos/github-agentic-workflows/creating-github-agentic-workflows.md",
"title": "Creating GitHub Agentic Workflows"
} |
Introduction
let you automate repository tasks using AI-powered workflows. For an overview of , see AUTOTITLE.
In this guide, you'll add a pre-built agentic workflow—a daily repository status report—to an existing repository. This takes about 10 minutes and gives you a working example of automated agents running in .
... | {
"source": "github-docs/copilot/how-tos/github-agentic-workflows/quickstart.md",
"title": "Your first agentic workflow"
} |
Starting a session
Each session in the runs in its own isolated workspace, so you can run multiple sessions in parallel and make progress on several tasks without conflicts.
1. In the sidebar next to Sessions, click + to start a new session.
1. Choose a project—you can use a folder already on your machine, choose from... | {
"source": "github-docs/copilot/how-tos/github-copilot-app/agent-sessions.md",
"title": "Working with agent sessions in the GitHub Copilot app"
} |
Tailor the to your workflows so your agents follow your conventions, use your preferred tools, and apply the right expertise to every task.
Setting global and repository instructions
You can set global instructions in the app settings under General.
You can set repository-specific instructions in the app settings, un... | {
"source": "github-docs/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md",
"title": "Customizing the GitHub Copilot app"
} |
For a conceptual overview of the , see AUTOTITLE.
In this quickstart, you will:
1. Install and sign in to the .
1. Connect a repository or local folder.
1. Make code changes in an agent session.
Prerequisites
A account.
A plan, or you can configure your own model provider.
If you use your own model provider, yo... | {
"source": "github-docs/copilot/how-tos/github-copilot-app/getting-started.md",
"title": "Getting started with the GitHub Copilot app"
} |
Browsing your issues and pull requests
Open My work in the sidebar to see your issues and pull requests in one place. The view is organized into sections—by default, All, Active, Review requests, and Done. You can edit the default sections or add new ones with your own filters. Use the search bar within any section to ... | {
"source": "github-docs/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests.md",
"title": "Managing issues and pull requests with the GitHub Copilot app"
} |
Deep links help people start work in the with less context switching. For example, you can share kickoff prompts, include links to the app in markdown files, launch the app from terminal scripts, or add a button to open the app in external tools.
You can open the from browser links that wrap an app link in the hosted... | {
"source": "github-docs/copilot/how-tos/github-copilot-app/open-with-deep-links.md",
"title": "Using deep links to open the GitHub Copilot app"
} |
[!NOTE]
Support to use your own model provider in the is in and subject to change.
You can configure the to use your own LLM provider, also called BYOK (Bring Your Own Key), instead of -hosted models. You can set up your model provider when you first open the app or later in app settings.
You must sign in with a a... | {
"source": "github-docs/copilot/how-tos/github-copilot-app/use-byok-models.md",
"title": "Using your own LLM models in the GitHub Copilot app"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.