Skip to content

Commit 88f15f0

Browse files
basiclinesCopilot
andcommitted
Document Copilot app launcher links
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d19ad45 commit 88f15f0

2 files changed

Lines changed: 93 additions & 3 deletions

File tree

content/copilot/how-tos/github-copilot-app/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
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.'
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."
55
versions:
66
feature: copilot
77
contentType: how-tos
@@ -17,6 +17,7 @@ redirect_from:
1717
- /copilot/how-tos/github-app
1818
children:
1919
- /getting-started
20+
- /open-from-github
2021
- /customize-github-copilot-app
2122
- /agent-sessions
2223
- /working-with-canvas-extensions
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: Opening the GitHub Copilot app from GitHub
3+
shortTitle: Open from GitHub
4+
allowTitleToDifferFromFilename: true
5+
intro: "Use links from {% data variables.product.github %} to open repositories, issues, pull requests, and agent tasks directly in the {% data variables.copilot.github_copilot_app %}."
6+
product: '{% data reusables.gated-features.github-app %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=button&utm_source=docs-open-from-github-signup&utm_medium=docs&utm_campaign=github-copilot-app-ga-2026" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
7+
versions:
8+
feature: copilot
9+
contentType: how-tos
10+
category:
11+
- Author and optimize with Copilot
12+
---
13+
14+
You can open the {% data variables.copilot.github_copilot_app %} from {% data variables.product.github %} links that wrap an app link in the hosted launcher. The hosted launcher opens the app when possible and keeps a fallback page available if the browser cannot hand off to the app.
15+
16+
## Launcher URL format
17+
18+
Use the hosted launcher URL with an `entry_point` value and an encoded app link in `open`.
19+
20+
```text
21+
https://github.com/copilot/app/launch?entry_point=ENTRY_POINT&open=ENCODED_APP_LINK
22+
```
23+
24+
- `entry_point` identifies the source of the link. Use a stable, low-cardinality value, such as the name of the surface that renders the link.
25+
- `open` is the URL-encoded app link to open.
26+
27+
Public examples should use the `ghapp://` scheme. The app also accepts `github-app://` and `gh://` links.
28+
29+
## Repository link
30+
31+
To open a repository in the app, encode an app link in this format.
32+
33+
```text
34+
ghapp://github.com/OWNER/REPO
35+
```
36+
37+
For example:
38+
39+
```text
40+
https://github.com/copilot/app/launch?entry_point=docs_repo_link&open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO
41+
```
42+
43+
## Issue link
44+
45+
To open an issue in the app, encode an app link in this format.
46+
47+
```text
48+
ghapp://github.com/OWNER/REPO/issues/123
49+
```
50+
51+
For example:
52+
53+
```text
54+
https://github.com/copilot/app/launch?entry_point=docs_issue_link&open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fissues%2F123
55+
```
56+
57+
## Pull request link
58+
59+
To open a pull request in the app, encode an app link in this format.
60+
61+
```text
62+
ghapp://github.com/OWNER/REPO/pull/123
63+
```
64+
65+
For example:
66+
67+
```text
68+
https://github.com/copilot/app/launch?entry_point=docs_pull_request_link&open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fpull%2F123
69+
```
70+
71+
## Agent task link
72+
73+
To resume a Copilot agent task in the app, encode an app link in this format.
74+
75+
```text
76+
ghapp://github.com/OWNER/REPO/tasks/TASK_ID
77+
```
78+
79+
For example:
80+
81+
```text
82+
https://github.com/copilot/app/launch?entry_point=docs_agent_task_link&open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Ftasks%2FTASK_ID
83+
```
84+
85+
Use the GitHub task ID for `TASK_ID`. Do not use a runtime session ID or an app-local session URL for links that resume Copilot agent tasks from {% data variables.product.github %}.
86+
87+
## Attribution and privacy
88+
89+
Use `entry_point` to attribute the link source without duplicating details from the `open` target. Keep the value generic and stable, and do not include repository names, issue or pull request numbers, branch names, task IDs, prompts, or raw app links in analytics events.

0 commit comments

Comments
 (0)