Deep-Links helfen Menschen, ihre Arbeit im GitHub Copilot App mit weniger Kontextwechsel zu beginnen. Sie können z. B. Startaufforderungen freigeben, Links zur App in Markdowndateien einfügen, die App über Terminalskripts starten oder eine Schaltfläche hinzufügen, um die App in externen Tools zu öffnen.
Sie können GitHub Copilot App über Browser-Links öffnen, die einen App-Link im gehosteten Launcher enthalten. Der gehostete Starter öffnet die App nach Möglichkeit und zeigt eine Fallback-Seite an, wenn der Browser den Aufruf nicht an die App weitergeben kann. Eine vollständige Liste der unterstützten App-Links finden Sie unter "Verfügbare App-Links".
Gründe für die Verwendung von Deep-Links
Verwenden Sie Deep-Links, wenn Sie direkt von einer Webseite oder einem Workflow zu einer bestimmten Seite oder Aufgabe in der App wechseln möchten. Zu den gängigen Anwendungsfällen gehören:
- Starten Sie Sitzungen mit einem vorausgefüllten Kickoff-Prompt.
- Geben Sie Automatisierungsaufforderungen frei, damit Teamkollegen sie schnell öffnen und wiederverwenden können.
- Fügen Sie Startschaltflächen in internen Dokumenten oder Markdowndateien hinzu, um allgemeine Workflows zu öffnen.
- Starten Sie die App über Terminalbefehle oder Skripts als Teil lokaler Workflows.
- Öffnen Sie die App aus Drittanbieterprodukten wie Issue- oder Ticketsystemen.
Startprogramm-URL-Format
Verwenden Sie die gehostete Launcher-URL, in der der vollständige App-Link im Abfrageparameter open codiert ist. Der gehostete Launcher öffnet die App, wenn möglich, und zeigt eine Fallback-Seite an, wenn der Browser die App nicht öffnen kann.
https://github.com/copilot/app/launch?open=ENCODED_APP_LINK
Verwenden Sie encodeURIComponent oder das entsprechende Äquivalent in Ihrer Programmiersprache, um den vollständigen App-Link zu codieren. Wenn der App-Link Abfrageparameter enthält, kodieren Sie deren Werte, bevor Sie den vollständigen App-Link für open kodieren.
Um beispielsweise ein Repository zu öffnen, lautet der App-Link:
ghapp://github.com/OWNER/REPO
In der Launcher-URL codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO
Öffentliche Links sollten das offizielle ghapp:// Schema verwenden. Die App akzeptiert aus Kompatibilitätsgründen auch github-app://- und gh://-Links, aber generierte und dokumentierte Links sollten ghapp:// verwenden.
Öffnen Sie ein Repository oder Arbeitselement
Um eine Seite im GitHub Copilot App zu öffnen, erstellen Sie eine Launcher-URL mithilfe des App-Links der Seite, die Sie öffnen möchten.
-
Um ein Repository zu öffnen, verwenden Sie diesen App-Link:
ghapp://github.com/OWNER/REPOIn der Launcher-URL codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO -
Um ein Issue zu erstellen, verwenden Sie diesen Link zur App:
ghapp://github.com/OWNER/REPO/issues/NUMBERIn der Launcher-URL codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fissues%2F123 -
Verwenden Sie diesen App-Link, um eine Pullanforderung zu öffnen:
ghapp://github.com/OWNER/REPO/pull/NUMBERIn der Launcher-URL codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fpull%2F123 -
Um eine Agentaufgabe fortzusetzen, verwenden Sie diesen App-Link:
ghapp://github.com/OWNER/REPO/tasks/TASK_IDIn der Launcher-URL codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Ftasks%2FTASK_IDVerwenden Sie die GitHub Aufgaben-ID für
TASK_ID. Verwenden Sie keine Laufzeit-Sitzungs-ID oder appinterne Sitzungs-URL für Links, mit denen GitHubCopilot Agentaufgaben fortgesetzt werden können.
Öffnen von Sitzungen
Um eine neue Sitzung über einen Deep-Link zu starten, verwenden Sie ghapp://session/new mit Abfrageparametern, um das Repository, den Branch, den Pull-Request, den Prompt oder den Modus vorab zu füllen. Verfügbare Parameter finden Sie unter Sitzungsparameter.
Um beispielsweise eine neue interaktive Sitzung mit einem Repository und einer Startaufforderung zu starten, verwenden Sie diesen App-Link:
ghapp://session/new?repo=OWNER%2FREPO&mode=interactive&prompt=Investigate%20failing%20tests
In der Launcher-URL codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fsession%2Fnew%3Frepo%3DOWNER%252FREPO%26mode%3Dinteractive%26prompt%3DInvestigate%2520failing%2520tests
Sitzungsparameter
Die Links ghapp://session/new und ghapp://session/new/OWNER/REPO akzeptieren diese Abfrageparameter.
| Parameter | Erforderlich | Hinweise |
|---|---|---|
repo | Erforderlich für ghapp:/; optional für ghapp:/ | Repository in OWNER/REPO-Format. |
pr | No | Positive Pullanforderungsnummer. Kann nicht mit branch kombiniert werden. |
branch | No | Basis-Branch für die neue Sitzung. Kann nicht mit pr kombiniert werden. |
prompt | No | Auftakt-Prompt Schließen Sie keine geheimen oder vertraulichen Benutzerinhalte in URLs ein. |
mode | No | Einer der folgenden Werte: plan, interactive oder autopilot. |
Offene Automatisierungen
Um Automatisierungen zu öffnen oder per Deep-Link einen neuen Automatisierungsentwurf zu erstellen, verwenden Sie die Links der Automatisierungs-App. Verfügbare Parameter beim Erstellen eines neuen Automatisierungsentwurfs finden Sie unter Automatisierungsparameter.
-
Um die Seite "Automatisierungen" zu öffnen, verwenden Sie diesen App-Link:
ghapp://automationsIn der Launcher-URL codiert ergibt sich:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations -
Verwenden Sie diesen App-Link, um einen neuen Automatisierungsentwurf zu öffnen:
ghapp://automations/new?name=Daily%20triage&trigger=daily&time=09%3A00&prompt=Summarize%20new%20issuesIn der Launcher-URL codiert, ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2Fnew%3Fname%3DDaily%2520triage%26trigger%3Ddaily%26time%3D09%253A00%26prompt%3DSummarize%2520new%2520issues -
Verwenden Sie diesen App-Link, um eine vorhandene Automatisierung zu öffnen:
ghapp://automations/AUTOMATION_IDIn der URL des Launchers codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID -
Um eine Cloud-Automatisierung zu öffnen, fügen Sie dem App-Link
mode=cloudhinzu, bevor Sie ihn kodieren:ghapp://automations/AUTOMATION_ID?mode=cloudIn der URL des Launchers kodiert, ergibt sich:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID%3Fmode%3Dcloud
Automatisierungsparameter
Der ghapp://automations/new Link öffnet das neue Automatisierungsdialogfeld. Die Automatisierung wird erst erstellt, wenn der Benutzer das Dialogfeld überprüft und in der App bestätigt. Schließen Sie keine geheimen oder vertraulichen Benutzerinhalte in Eingabeaufforderungen ein, die in URLs eingebettet sind.
| Parameter | Gilt für: | Hinweise |
|---|---|---|
name | ghapp:/ | Automatisierungsname. |
prompt | ghapp:/ | Automatisierungsaufforderung. Schließen Sie keine geheimen oder vertraulichen Benutzerinhalte in URLs ein. |
trigger | ghapp:/ | Einer von manual, hourly, , dailyoder weekly. Ungültige Werte werden ignoriert. |
interval wird auch als Alias akzeptiert. | ||
time | ghapp:/ | Uhrzeit im HH:mm lokalen 24-Stunden-Format. Wird für daily- und weekly-Trigger unterstützt. Tägliche Trigger akzeptieren auch kommagetrennte oder wiederholte Zeiten, wenn alle Einträge dieselbe Minute aufweisen, z. B time=08:00,13:00. . . Ungültige Werte werden ignoriert. |
day | ghapp:/ | Wochentag als 0-6 (0 = Sonntag) oder ein Wochentagsname. Ungültige Werte werden ignoriert. |
schedule_day wird ebenfalls als Alias akzeptiert, und wöchentliche Trigger akzeptieren durch Kommas getrennte oder wiederholte Werte, z. B. schedule_day=1,3,5. | ||
mode | ||
ghapp:/ und ghapp:/ | Verwenden Sie cloud für Cloud-Automatisierungen. Lassen Sie es weg oder verwenden Sie local für lokale Automatisierungen. |
Öffnen von Plug-In-Flüssen
Um Plug-In-Installationen oder Marketplace-Flüsse über einen Deep-Link zu öffnen, verwenden Sie die Plug-In-App-Links. Verfügbare Parameter finden Sie unter Plug-In-Parameter.
Um z. B. das Plug-In-Installationsformular mit einer bereits ausgefüllten Quelle zu öffnen, verwenden Sie diesen App-Link:
ghapp://plugins/install?source=my-plugin%40acme
In der Launcher-URL codiert ergibt das:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fplugins%2Finstall%3Fsource%3Dmy-plugin%2540acme
Plugin-Parameter
Plugin-Links öffnen „Einstellungen“ > „Plugins“ mit einem vorausgefüllten Formular. Sie installieren kein Plug-In oder fügen einen Marketplace hinzu, bis der Benutzer in der App bestätigt.
| Link | Parameter | Erforderlich | Hinweise |
|---|---|---|---|
ghapp:/ | source | Yes | Plug-In-Quelle im PLUGIN@MARKETPLACE Format. URL-kodieren Sie den Wert, z. B. source=my-plugin%40acme. |
ghapp:/ | source | Yes | Marketplace-Quelle als OWNER/REPO oder Git-URL. URL-kodieren Sie den Wert, z. B. source=acme%2Fplugins. |
Verfügbare App-Links
Die folgenden App-Links können in den gehosteten Launcher eingebettet werden. Abfragezeichenfolgen und Hashes bleiben erhalten, wenn die App den Link öffnet.
| App-Link-Form | Öffnet | Hinweise |
|---|---|---|
ghapp:// | Heim | Öffnet die Startseitenroute der App. |
ghapp://chats | Chats | Öffnet Chats. |
ghapp://mywork | Meine Arbeit | Öffnet Probleme und Pullanforderungen in "Meine Arbeit". |
ghapp:/ | Einrichtung des Repositorys | Öffnet oder klont das Repository. |
ghapp:/ | Issue | Öffnet das Problem in "Meine Arbeit", wenn das Repository bereits als Projekt hinzugefügt wurde. |
ghapp:/ | Pull-Anfrage | Öffnet die Pullanforderung in "Meine Arbeit", wenn das Repository bereits als Projekt hinzugefügt wurde. Optionale abschließende Pfadsegmente bleiben erhalten. |
ghapp:/ | Agent-Aufgabe | Setzt die Aufgabe eines GitHubCopilot Agents fort. Verwenden Sie die GitHub Aufgaben-ID, keine app-lokale Sitzungs-ID. |
ghapp:/ | Automations | Öffnet Automatisierungen. |
ghapp:/ | Neuer Automatisierungsentwurf | Öffnet das neue Automatisierungsdialogfeld mit bereits ausgefüllten unterstützten Abfrageparametern. Siehe Automatisierungsparameter. |
ghapp:/ | Automation | Öffnet standardmäßig eine lokale Automatisierung. Hinzufügen ?mode=cloud für eine Cloudautomatisierung. |
ghapp:/ | Automatisierungslauf | Öffnet standardmäßig eine lokale Automatisierungsausführung. |
?mode=cloud für einen Cloud-Automatisierungslauf hinzufügen. | ||
ghapp://recent | Zuletzt verwendete Arbeitsbereiche | Öffnet zuletzt verwendete Arbeitsbereiche. |
ghapp:/ | App-Sitzung | Öffnet einen app-lokalen Arbeitsbereich oder eine App-Sitzung. Verwenden Sie diese Form nicht, um GitHub Copilot-Agent-Aufgaben fortzusetzen. |
ghapp:/ | Einrichtung des Repositorys | Zeigt eine Bestätigung vor dem Klonen oder Öffnen des Repository-Setups an. |
ghapp:/ | Einrichtung des Repositorys | Zeigt eine Bestätigung vor dem Klonen oder Öffnen des Repository-Setups an. |
ghapp:/ | Neue Sitzung | Zeigt eine Bestätigung vor dem Erstellen einer Sitzung an. Verwenden Sie Query-Parameter, um das Repository, den Pull Request, den Branch, den Prompt oder den Sitzungsmodus anzugeben. Siehe Sitzungsparameter. |
ghapp:/ | Neue Sitzung für ein Repository | Zeigt eine Bestätigung vor dem Erstellen einer Sitzung für das Repository an. Siehe Sitzungsparameter. |
ghapp:/ | Plug-In-Installationsformular | Zeigt eine Bestätigung an und öffnet dann Einstellungen > Plugins mit vorausgefülltem Installationsformular. Siehe Plug-In-Parameter. |
ghapp:/ | Plugin-Marktplatzformular | Zeigt eine Bestätigung an und öffnet dann Einstellungen > Plugins mit vorausgefülltem Marktplatzformular. Siehe Plug-In-Parameter. |