Skip to content

Commit 866ea00

Browse files
basiclinesCopilot
basiclines
and
Copilot
committed
Document available Copilot app links
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 0485c5a commit 866ea00

1 file changed

Lines changed: 68 additions & 2 deletions

File tree

‎content/copilot/how-tos/github-copilot-app/open-from-github.md‎

Lines changed: 68 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Opening the GitHub Copilot app from GitHub
2+
title: Opening the GitHub Copilot app from links
33
shortTitle: Open from GitHub
44
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 %}."
5+
intro: "Use links to open repositories, issues, pull requests, automations, agent tasks, sessions, and setup flows directly in the {% data variables.copilot.github_copilot_app %}."
66
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>'
77
versions:
88
feature: copilot
@@ -26,6 +26,72 @@ https://github.com/copilot/app/launch?entry_point=ENTRY_POINT&open=ENCODED_APP_L
2626

2727
Public examples should use the `ghapp://` scheme. The app also accepts `github-app://` and `gh://` links.
2828

29+
## Available app links
30+
31+
The following app links can be wrapped in the hosted launcher. Query strings and hashes are preserved when the app opens the link.
32+
33+
| App link shape | Opens | Notes |
34+
| --------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
35+
| `ghapp://` | Home | Opens the app home route. |
36+
| `ghapp://chats` | Chats | Opens Chats. |
37+
| `ghapp://mywork` | My work | Opens issues and pull requests in My work. |
38+
| `ghapp://github.com/OWNER/REPO` | Repository setup | Opens or clones the repository. |
39+
| `ghapp://github.com/OWNER/REPO/issues/NUMBER` | Issue | Opens the issue in My work when the repository is already added as a project. |
40+
| `ghapp://github.com/OWNER/REPO/pull/NUMBER` | Pull request | Opens the pull request in My work when the repository is already added as a project. Optional trailing path segments are preserved. |
41+
| `ghapp://github.com/OWNER/REPO/tasks/TASK_ID` | Agent task | Resumes a Copilot agent task from {% data variables.product.github %}. Use the GitHub task ID, not a runtime session ID. |
42+
| `ghapp://automations` | Automations | Opens Automations. |
43+
| `ghapp://automations/new` | New automation draft | Opens the new automation dialog with any supported query parameters pre-filled. |
44+
| `ghapp://automations/AUTOMATION_ID` | Automation | Opens a local automation by default. Add `mode=cloud` for a cloud automation. |
45+
| `ghapp://automations/AUTOMATION_ID/RUN_ID` | Automation run | Opens a local automation run by default. Add `mode=cloud` for a cloud automation run. |
46+
| `ghapp://workflows` | Automations | Legacy compatibility path for `ghapp://automations`. Generate new links with `/automations`. |
47+
| `ghapp://workflows/new` | New automation draft | Legacy compatibility path for `ghapp://automations/new`. Generate new links with `/automations/new`. |
48+
| `ghapp://workflows/AUTOMATION_ID` | Automation | Legacy compatibility path for `ghapp://automations/AUTOMATION_ID`. Generate new links with `/automations`. |
49+
| `ghapp://workflows/AUTOMATION_ID/RUN_ID` | Automation run | Legacy compatibility path for `ghapp://automations/AUTOMATION_ID/RUN_ID`. Generate new links with `/automations`. |
50+
| `ghapp://recent` | Recent workspaces | Opens Recent Workspaces. |
51+
| `ghapp://sessions/SESSION_ID` | App session | Opens an app-local workspace or session. Do not use this shape for Copilot agent tasks from {% data variables.product.github %}. |
52+
| `ghapp://clone/OWNER/REPO` | Repository setup | Shows a confirmation before cloning or opening repository setup. |
53+
| `ghapp://repo/OWNER/REPO` | Repository setup | Shows a confirmation before cloning or opening repository setup. |
54+
| `ghapp://session/new` | New session | Shows a confirmation before creating a session. Use query parameters to provide the repository, pull request, branch, prompt, or session mode. |
55+
| `ghapp://session/new/OWNER/REPO` | New session for a repository | Shows a confirmation before creating a session for the repository. |
56+
| `ghapp://plugins/install` | Plugin install form | Shows a confirmation, then opens Settings > Plugins with the install form pre-filled. |
57+
| `ghapp://plugins/marketplace/add` | Plugin marketplace form | Shows a confirmation, then opens Settings > Plugins with the marketplace form pre-filled. |
58+
59+
## Session creation parameters
60+
61+
The `ghapp://session/new` and `ghapp://session/new/OWNER/REPO` links accept these query parameters.
62+
63+
| Parameter | Required | Notes |
64+
| --------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
65+
| `repo` | Required for `ghapp://session/new`; optional for `ghapp://session/new/OWNER/REPO` | Repository in `OWNER/REPO` format. |
66+
| `pr` | No | Positive pull request number. Cannot be combined with `branch`. |
67+
| `branch` | No | Base branch for the new session. Cannot be combined with `pr`. |
68+
| `prompt` | No | Kickoff prompt. Do not include secrets or sensitive user content in generated URLs. |
69+
| `mode` | No | One of `plan`, `interactive`, or `autopilot`. |
70+
71+
## Automation parameters
72+
73+
Automation links open local automations by default. Add `mode=cloud` to open a cloud automation task or run. Legacy `ghapp://workflows` links accept the same parameters, but new links should use `ghapp://automations`.
74+
75+
The `ghapp://automations/new` link opens the new automation dialog. It does not create the automation until the user reviews the dialog and confirms in the app.
76+
77+
| Parameter | Required | Notes |
78+
| --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
79+
| `name` | No | Automation name. |
80+
| `prompt` | No | Automation prompt. Do not include secrets or sensitive user content in generated URLs. |
81+
| `trigger` | No | One of `manual`, `hourly`, `daily`, or `weekly`. Invalid values are ignored. `interval` is also accepted as an alias. |
82+
| `time` | No | `HH:mm` in 24-hour local time. Only accepted for `daily` and `weekly` triggers. Daily triggers also accept comma-separated or repeated times when all entries share the same minute, for example `time=08:00,13:00`. Invalid values are ignored. |
83+
| `day` | No | Weekly day as `0`-`6` (`0` = Sunday) or a weekday name. Invalid values are ignored. `schedule_day` is also accepted as an alias, and weekly triggers accept comma-separated or repeated values, such as `schedule_day=1,3,5`. |
84+
| `mode` | No | For `ghapp://automations/AUTOMATION_ID` and `ghapp://automations/AUTOMATION_ID/RUN_ID`, use `cloud` for cloud automations. Omit it or use `local` for local automations. |
85+
86+
## Plugin parameters
87+
88+
Plugin links open Settings > Plugins with a form pre-filled. They do not install or add anything until the user confirms in the app.
89+
90+
| Link | Parameter | Required | Notes |
91+
| --------------------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
92+
| `ghapp://plugins/install` | `source` | Yes | Plugin source in `PLUGIN@MARKETPLACE` format. Always URL-encode the value, for example `source=my-plugin%40acme`. |
93+
| `ghapp://plugins/marketplace/add` | `source` | Yes | Marketplace source as `OWNER/REPO` or a Git URL. Always URL-encode the value, for example `source=acme%2Fplugins`. |
94+
2995
## Repository link
3096

3197
To open a repository in the app, encode an app link in this format.

0 commit comments

Comments
 (0)