Skip to content

Commit 5b0ae2c

Browse files
saritaiCopilotSiaraMist
authored
Docs for GitHub App gated technical preview (#60998)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: SiaraMist <siaramist@github.com> Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
1 parent 6683346 commit 5b0ae2c

12 files changed

Lines changed: 368 additions & 0 deletions

File tree

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: About the GitHub Copilot app
3+
shortTitle: GitHub Copilot app
4+
intro: 'The {% data variables.copilot.github_copilot_app %} is a desktop application for agent-driven development that brings parallel workstreams, {% data variables.product.github %} integration, and PR lifecycle management into one place.'
5+
product: '{% data reusables.gated-features.github-app %}'
6+
versions:
7+
feature: copilot
8+
contentType: concepts
9+
redirect_from:
10+
- /copilot/concepts/agents/github-app
11+
category:
12+
- Learn about Copilot
13+
---
14+
15+
> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change.
16+
>
17+
> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-overview&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}.
18+
> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-overview&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026).
19+
20+
## Introduction
21+
22+
The {% data variables.copilot.github_copilot_app %} is a desktop application purpose-built for agent-driven development. It gives you a single place to direct AI agents across parallel workstreams, work with {% data variables.product.github %} issues and pull requests, and manage the full development lifecycle—without context-switching between terminals, IDEs, and browser tabs.
23+
24+
The app is built on {% data variables.copilot.copilot_cli %} and integrates natively with {% data variables.product.github %}, so your repositories, branches, and CI pipelines work out of the box. It's designed for workflows where you want to run multiple agents in parallel and stay focused on directing work rather than doing it all yourself.
25+
26+
## Supported operating systems
27+
28+
The {% data variables.copilot.github_copilot_app %} supports the following operating systems:
29+
30+
* macOS
31+
* Linux
32+
* Windows
33+
34+
## Benefits of using the {% data variables.copilot.github_copilot_app %}
35+
36+
* **Work in parallel.** Run multiple agent sessions at the same time, each on its own branch, so you can make progress on several tasks without waiting for one to finish.
37+
* **Stay in one place.** Triage issues, direct agents, review changes, and land pull requests without switching between your terminal, IDE, and browser.
38+
* **Start fast.** The app connects to {% data variables.product.github %} natively—your repositories, branches, issues and pull requests work out of the box with no additional setup.
39+
* **Stay in control.** Choose how much autonomy to give agents, from fully collaborative to fully autonomous, and adjust the model and reasoning effort for each session.
40+
41+
## What can I do with the {% data variables.copilot.github_copilot_app %}?
42+
43+
* **Parallel workspaces.** Run multiple isolated agent sessions simultaneously, each with a dedicated git worktree and branch.
44+
* **Session modes.** Choose how you work with agents: Interactive (collaborative), Plan (agent plans, you approve), or Autopilot (fully autonomous).
45+
* **{% data variables.product.github %} integration.** Browse and find issues, start sessions from them, create and close pull requests, review pull requests, and view CI check results—all within the app.
46+
* **Model choice.** Select from multiple LLMs and adjust reasoning effort per session.
47+
* **Customizations.** Configure MCP servers, skills, extensions, and plugins for each session.
48+
* **Scheduled workflows.** Save recurring agent tasks and run them on a schedule or on demand.
49+
* **Quick chats.** Brainstorm in a conversation mode without creating a dedicated branch or workspace.
50+
* **Search.** Search for issues or pull requests across your repositories directly from the app.
51+
52+
## {% data variables.copilot.github_copilot_app %} workflow
53+
54+
A typical workflow in the {% data variables.copilot.github_copilot_app %} looks like this:
55+
56+
1. Browse issues in a repository and pick one up, or start from a blank workspace.
57+
1. Choose a session mode—Interactive, Plan, or Autopilot—and select a model.
58+
1. Describe the task and let the agent create a branch, write code, and run tests.
59+
1. Review the agent's changes, provide feedback, and iterate.
60+
1. Create a pull request, leave a review, check whether CI passed, and merge the PR—all from within the app.
61+
62+
You can run several of these workflows in parallel, each in its own workspace, and switch between them as needed.
63+
64+
## Providing feedback
65+
66+
The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.public_preview %}. To share feedback, click the **Give feedback** icon in the bottom-left corner of the app.
67+
68+
## Further reading
69+
70+
* [AUTOTITLE](/copilot/how-tos/github-copilot-app/getting-started)

content/copilot/concepts/agents/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ versions:
88
children:
99
- /cloud-agent
1010
- /copilot-cli
11+
- /github-copilot-app
1112
- /code-review
1213
- /copilot-memory
1314
- /hooks
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Working with agent sessions in the GitHub Copilot app
3+
shortTitle: Agent sessions
4+
intro: 'Run multiple isolated agent sessions simultaneously, each with its own branch, and steer them using different session modes, models, and tools.'
5+
allowTitleToDifferFromFilename: true
6+
product: '{% data reusables.gated-features.github-app %}'
7+
versions:
8+
feature: copilot
9+
contentType: how-tos
10+
redirect_from:
11+
- /copilot/how-tos/github-app/agent-sessions
12+
category:
13+
- Author and optimize with Copilot
14+
---
15+
16+
> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change.
17+
>
18+
> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-agent-sessions&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}.
19+
> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-agent-sessions&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026).
20+
21+
## Starting a session
22+
23+
Each session in the {% data variables.copilot.github_copilot_app %} runs in its own isolated workspace, so you can run multiple sessions in parallel and make progress on several tasks without conflicts.
24+
25+
1. In the sidebar under **Sessions**, click **+** to start a new session.
26+
1. Choose a repository—you can use a local folder, choose from {% data variables.product.github %}, or clone from a URL.
27+
1. Choose whether the session should run in a new working tree or in your local repository.
28+
1. Select a session mode, model, and reasoning effort from the dropdowns above the prompt field.
29+
1. Describe the task in the prompt field. You can reference issues with `#`, add files with `@`, or use `/` for commands.
30+
31+
The agent starts working. Your active sessions appear in the sidebar grouped by repository—click any session to switch to it.
32+
33+
## Choosing a session mode
34+
35+
The session mode controls how much autonomy the agent has. You can set the mode from the dropdown above the prompt field and change it at any time.
36+
37+
* **Interactive**: You and the agent work together. The agent suggests changes and waits for your input before proceeding.
38+
* **Plan**: The agent creates a plan first. You review and approve the plan before the agent executes it.
39+
* **Autopilot**: The agent works fully autonomously—writing code, running tests, and iterating without waiting for input.
40+
41+
## Choosing a model
42+
43+
You can select a model and reasoning effort from the dropdowns above the prompt field. Higher reasoning effort gives the agent more time to think through complex problems but may take longer. You can change both settings at any time during a session.
44+
45+
## Using quick chats
46+
47+
**Quick chats** in the sidebar opens a conversation mode without creating a dedicated branch or worktree. Use it for brainstorming, asking questions, or exploring ideas before starting a session. Your chat history is saved and listed by conversation name.
48+
49+
## Keyboard shortcuts
50+
51+
The {% data variables.copilot.github_copilot_app %} supports keyboard shortcuts to help you navigate sessions, switch between workspaces, and perform common actions. To see available shortcuts, open the app, go to **Help**, then **Keyboard Shortcuts**.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Customizing the GitHub Copilot app
3+
shortTitle: Customize the GitHub Copilot app
4+
intro: 'Customize the {% data variables.copilot.github_copilot_app %} so it works the way you and your team do.'
5+
allowTitleToDifferFromFilename: true
6+
product: '{% data reusables.gated-features.github-app %}'
7+
versions:
8+
feature: copilot
9+
contentType: how-tos
10+
redirect_from:
11+
- /copilot/how-tos/github-app/customize-github-app
12+
category:
13+
- Author and optimize with Copilot
14+
- Configure Copilot
15+
---
16+
17+
> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change.
18+
>
19+
> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-customize-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}.
20+
> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-customize-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026).
21+
22+
Tailor the {% data variables.copilot.github_copilot_app %} to your workflows so your agents follow your conventions, use your preferred tools, and apply the right expertise to every task.
23+
24+
## Setting global instructions
25+
26+
You can set instructions that apply to every session across all projects in the app settings under **General**.
27+
28+
## Adding agent skills
29+
30+
Agent skills are folders of instructions, scripts, and resources that {% data variables.product.prodname_copilot_short %} can load when relevant to improve its performance in specialized tasks. Any skills configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}. You can also add and manage skills in the app settings under **Skills**.
31+
32+
For more information about agent skills, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills).
33+
34+
## Configuring MCP servers
35+
36+
MCP servers connect the agent to external tools and data sources. Any MCP servers configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}. You can also add and manage additional MCP servers in the app settings under **MCP Servers**. The app includes a catalog of popular servers, or you can add a custom server.
37+
38+
For more information about MCP, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers).
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: Getting started with the GitHub Copilot app
3+
shortTitle: Quickstart
4+
allowTitleToDifferFromFilename: true
5+
intro: 'Sign in to the {% data variables.copilot.github_copilot_app %}, ask your first question in a quick chat, and then create a full agent session to make changes to your code.'
6+
product: '{% data reusables.gated-features.github-app %}'
7+
versions:
8+
feature: copilot
9+
contentType: how-tos
10+
redirect_from:
11+
- /copilot/how-tos/github-app/getting-started
12+
category:
13+
- Quickstarts
14+
- Author and optimize with Copilot
15+
---
16+
17+
> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change.
18+
>
19+
> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-getting-started&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}.
20+
> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-getting-started&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026).
21+
22+
## Prerequisites
23+
24+
* Access to the {% data variables.copilot.github_copilot_app %}. The app is currently in {% data variables.release-phases.technical_preview %}.
25+
* **{% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} users**: You have access, as long as your organization or enterprise has enabled preview features and enabled {% data variables.copilot.copilot_cli_short %}. No waitlist is required, so you can download the app directly from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026).
26+
* **{% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} users**: You must join the [waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) and be accepted into the preview to get access. Once accepted, you'll receive a link to download the app.
27+
* The {% data variables.copilot.github_copilot_app %} installed on macOS, Windows, or Linux. Once you have access, you can download and install the application from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026).
28+
29+
## Opening the {% data variables.copilot.github_copilot_app %} for the first time
30+
31+
1. Open the {% data variables.copilot.github_copilot_app %}.
32+
1. Click **Sign in to {% data variables.product.github %}** and follow the prompts to authenticate.
33+
1. The app walks you through onboarding. When prompted, select one or more repositories based on your recent {% data variables.product.github %} activity, or choose a sample project. You can also skip this step and add repositories later.
34+
1. Choose a theme, then complete onboarding.
35+
36+
## Connecting a repository
37+
38+
To work on code, you need at least one repository connected to the app. If you skipped repository setup during onboarding, or want to add more repositories later:
39+
40+
1. Click the **+** button in the sidebar next to "Sessions".
41+
1. Under **Add project from**, choose one of the following:
42+
* **Local folder or repository** — Select a folder already on your machine.
43+
* **{% data variables.product.github %} repository** — Browse and clone a repository from {% data variables.product.github %}.
44+
* **Repository URL** — Clone from any Git URL.
45+
46+
## Orienting yourself
47+
48+
The sidebar gives you access to the main areas of the app:
49+
50+
* **Inbox** - Browse and filter issues and pull requests from your repositories, check CI status, and leave reviews.
51+
* **Workflows** — Saved agent tasks that run on a schedule or on demand.
52+
* **Search** — Search across your repositories directly from the app.
53+
* **Sessions** — Active agent sessions, grouped by repository. This also includes **Quick chats**, which are general chat conversations.
54+
55+
## Starting a quick chat
56+
57+
The fastest way to try the {% data variables.copilot.github_copilot_app %} is with a quick chat. Quick chats let you ask questions and brainstorm without creating a branch or worktree.
58+
59+
1. In the sidebar, click **+** next to "Quick chats" to open a new chat.
60+
1. Type a question or prompt—for example, "Give me an overview of the octocat repository."
61+
1. The agent responds in the conversation view. You can continue the conversation, ask follow-up questions, or start a new chat.
62+
63+
## Creating your first session
64+
65+
When you are ready to make changes to code, create a session. You can start from an issue or describe a task directly.
66+
67+
### Starting from an issue
68+
69+
1. Click **Inbox** in the sidebar.
70+
1. Browse or filter to find an issue, then click it to view its details.
71+
1. Click **Start a session**. The app creates a new session with the issue context already loaded and automatically uses **Plan** mode.
72+
1. The agent proposes a plan. Review the plan, then you can choose to let the agent start working on a pull request or have it propose changes that you can then manually apply.
73+
1. If you've told it to, the agent creates a branch, makes changes, and even creates a pull request that you can then review and iterate on.
74+
75+
### Starting from a task
76+
77+
If you do not have an issue to work from, you can describe a task directly.
78+
79+
1. In the sidebar, click **+** to start a new session and select a repository.
80+
1. Select a session mode from the dropdown above the prompt field—for example, **Interactive** to work collaboratively with the agent.
81+
1. Describe a task—for example, "Fix the failing test in `utils.test.ts`" or "Add input validation to the signup form."
82+
1. The agent will make changes based on your direction. Follow along in the conversation view and provide feedback to steer the agent.
83+
84+
## Next steps
85+
86+
Find out more about using the {% data variables.copilot.github_copilot_app %}:
87+
88+
* [AUTOTITLE](/copilot/how-tos/github-copilot-app/agent-sessions)
89+
* [AUTOTITLE](/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests)
90+
* [AUTOTITLE](/copilot/how-tos/github-copilot-app/using-scheduled-workflows)
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: '{% data variables.copilot.github_copilot_app %}'
3+
shortTitle: '{% data variables.copilot.github_copilot_app %}'
4+
intro: 'A desktop application for agent-driven development that brings parallel workstreams, {% data variables.product.github %} integration, and PR lifecycle management into one place.'
5+
versions:
6+
feature: copilot
7+
contentType: how-tos
8+
layout: bespoke-landing
9+
heroImage: /assets/images/banner-images/hero-4
10+
introLinks:
11+
overview: /copilot/concepts/agents/github-copilot-app
12+
quickstart: /copilot/how-tos/github-copilot-app/getting-started
13+
redirect_from:
14+
- /copilot/how-tos/github-app
15+
children:
16+
- /getting-started
17+
- /customize-github-copilot-app
18+
- /agent-sessions
19+
- /managing-issues-and-pull-requests
20+
- /using-scheduled-workflows
21+
---

0 commit comments

Comments
 (0)