Les liens profonds aident les utilisateurs à commencer à travailler dans le GitHub application Copilot sans avoir à changer autant de contexte. Par exemple, vous pouvez partager des invites de lancement, inclure des liens vers l’application dans des fichiers Markdown, lancer l’application à partir de scripts de terminal ou ajouter un bouton pour ouvrir l’application dans des outils externes.
Vous pouvez ouvrir le GitHub application Copilot à partir de liens de navigateur qui encapsulent un lien d’application dans le lanceur hébergé. Le lanceur hébergé ouvre l’application lorsque cela est possible et affiche une page de secours si le navigateur ne peut pas se remettre à l’application. Pour obtenir la liste complète des liens d’application pris en charge, consultez Liens d’application disponibles.
Pourquoi utiliser des liens profonds
Utilisez des liens approfondis lorsque vous souhaitez passer d’une page web ou d’un flux de travail directement dans une page ou une tâche spécifique dans l’application. Les cas d’utilisation courants sont les suivants :
- Démarrez des sessions avec une invite de lancement préremplie.
- Partagez des invites d’automatisation afin que les collègues puissent les ouvrir et les réutiliser rapidement.
- Ajoutez des boutons de lancement dans des documents internes ou des fichiers Markdown pour ouvrir des flux de travail courants.
- Lancez l’application à partir de commandes ou de scripts de terminal dans le cadre de flux de travail locaux.
- Ouvrez l’application à partir de produits tiers, comme des systèmes de gestion des incidents ou de tickets.
Format de l’URL du lanceur
Utilisez l’URL du lanceur hébergé avec le lien d’application complet encodé dans le paramètre de open requête. Le lanceur hébergé ouvre l’application lorsque cela est possible et affiche une page de secours si le navigateur ne peut pas se remettre à l’application.
https://github.com/copilot/app/launch?open=ENCODED_APP_LINK
Utilisez encodeURIComponent, ou l’équivalent dans votre langage de programmation, pour encoder le lien complet de l’application. Si le lien d’application inclut des paramètres de requête, encodez ces valeurs de paramètres de requête avant d’encoder le lien d’application complet pour open.
Par exemple, pour ouvrir un référentiel, le lien d’application est :
ghapp://github.com/OWNER/REPO
Encodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO
Les liens publics doivent utiliser le schéma officiel ghapp:// . L’application accepte également les liens github-app:// et gh:// à des fins de compatibilité, mais les liens générés et documentés doivent utiliser ghapp://.
Ouvrir un dépôt ou un élément de travail
Pour ouvrir une page dans le GitHub application Copilot, créez une URL de lancement à l’aide du lien d’application de la page que vous souhaitez ouvrir.
-
Pour ouvrir un référentiel, utilisez ce lien d’application :
ghapp://github.com/OWNER/REPOEncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO -
Pour ouvrir un problème, utilisez ce lien d’application :
ghapp://github.com/OWNER/REPO/issues/NUMBEREncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fissues%2F123 -
Pour ouvrir une pull request, utilisez ce lien de l’application :
ghapp://github.com/OWNER/REPO/pull/NUMBEREncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fpull%2F123 -
Pour reprendre une tâche d’agent, utilisez ce lien d’application :
ghapp://github.com/OWNER/REPO/tasks/TASK_IDEncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Ftasks%2FTASK_IDUtilisez l’ID de tâche GitHub pour
TASK_ID. N’utilisez pas d’ID de session runtime ou d’URL de session locale d’application pour les liens qui reprendnt GitHubCopilot les tâches de l’agent.
Ouvrir des sessions
Pour démarrer une nouvelle session à partir d’un lien direct, utilisez ghapp://session/new avec des paramètres de requête pour préremplir le référentiel, la branche, la pull request, l’instruction ou le mode. Pour connaître les paramètres disponibles, consultez Paramètres de session.
Par exemple, pour démarrer une nouvelle session interactive avec un dépôt et une invite de lancement, utilisez ce lien d’application :
ghapp://session/new?repo=OWNER%2FREPO&mode=interactive&prompt=Investigate%20failing%20tests
Encodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fsession%2Fnew%3Frepo%3DOWNER%252FREPO%26mode%3Dinteractive%26prompt%3DInvestigate%2520failing%2520tests
Paramètres de session
Les liens ghapp://session/new et ghapp://session/new/OWNER/REPO acceptent ces paramètres de requête.
| Paramètre | Obligatoire | Remarques |
|---|---|---|
repo | Obligatoire pour ghapp:/; facultatif pour ghapp:/ | Dépôt au format OWNER/REPO. |
pr | Non | Numéro de pull request positif. Impossible de combiner avec branch. |
branch | Non | Branche de base pour la nouvelle session. Impossible de combiner avec pr. |
prompt | Non | Invite de lancement. N’incluez pas de secrets ou de contenu utilisateur sensible dans les URL. |
mode | Non | Un des plan, interactiveou autopilot. |
Ouvrir les automatisations
Pour ouvrir des automatisations ou créer un brouillon d’automatisation à partir d’un lien profond, utilisez les liens d’application Automation. Pour connaître les paramètres disponibles lors de la création d’un brouillon d’automatisation, consultez paramètres Automation.
-
Pour ouvrir la page Automations, utilisez ce lien d’application :
ghapp://automationsEncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations -
Pour ouvrir un nouveau brouillon d’automatisation, utilisez ce lien d’application :
ghapp://automations/new?name=Daily%20triage&trigger=daily&time=09%3A00&prompt=Summarize%20new%20issuesEncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2Fnew%3Fname%3DDaily%2520triage%26trigger%3Ddaily%26time%3D09%253A00%26prompt%3DSummarize%2520new%2520issues -
Pour ouvrir une automatisation existante, utilisez ce lien d’application :
ghapp://automations/AUTOMATION_IDEncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID -
Pour ouvrir une automatisation cloud, ajoutez-y
mode=cloudle lien d’application avant de l’encoder :ghapp://automations/AUTOMATION_ID?mode=cloudEncodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID%3Fmode%3Dcloud
Paramètres d’automatisation
Le lien ghapp://automations/new ouvre la nouvelle boîte de dialogue d’automatisation. Elle ne crée pas l’automatisation tant que l’utilisateur n’a pas examiné la boîte de dialogue et qu’il confirme dans l’application. N’incluez pas de secrets ou de contenu utilisateur sensible dans les invites incorporées dans les URL.
| Paramètre | S’applique à | Remarques |
|---|---|---|
name | ghapp:/ | Nom de l’automatisation. |
prompt | ghapp:/ | Instruction d’automatisation. N’incluez pas de secrets ou de contenu utilisateur sensible dans les URL. |
trigger | ghapp:/ | Un des manual, , hourly, dailyou weekly. Les valeurs non valides sont ignorées. |
interval est également accepté comme alias. | ||
time | ghapp:/ | Heure HH:mm au format local sur 24 heures. Pris en charge pour les déclencheurs daily et weekly. Les déclencheurs quotidiens acceptent également des heures séparées par des virgules ou répétées lorsque toutes les entrées partagent la même minute, par exemple time=08:00,13:00. Les valeurs non valides sont ignorées. |
day | ghapp:/ | Jour hebdomadaire en tant que 0-6 (0 = dimanche) ou nom de la semaine. Les valeurs non valides sont ignorées. |
schedule_day est également accepté en tant qu’alias, et les déclencheurs hebdomadaires acceptent des valeurs séparées par des virgules ou répétées, telles que schedule_day=1,3,5. | ||
mode | ||
ghapp:/ et ghapp:/ | Utiliser cloud pour les automatisations cloud. Omettez-le ou utilisez-le local pour les automatisations locales. |
Ouvrir des flux de plug-in
Pour ouvrir l’installation du plug-in ou les flux de la Place de marché à partir d’un lien profond, utilisez les liens de l’application de plug-in. Pour connaître les paramètres disponibles, consultez Paramètres du plug-in.
Par exemple, pour ouvrir le formulaire d’installation du plug-in avec une source préremplie, utilisez ce lien d’application :
ghapp://plugins/install?source=my-plugin%40acme
Encodé dans l’URL du lanceur, qui devient :
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fplugins%2Finstall%3Fsource%3Dmy-plugin%2540acme
Paramètres du plug-in
Les liens d’extension ouvrent Paramètres > Plugins avec un formulaire prérempli. Ils n’installent pas de plug-in ou n’ajoutent pas de place de marché tant que l’utilisateur n’a pas confirmé dans l’application.
| Lien | Paramètre | Obligatoire | Remarques |
|---|---|---|---|
ghapp:/ | source | Oui | Source du plug-in au PLUGIN@MARKETPLACE format. Encodez l’URL de la valeur, par exemple source=my-plugin%40acme. |
ghapp:/ | source | Oui | Source Marketplace sous la forme de OWNER/REPO ou d’une URL Git. Encodez l’URL de la valeur, par exemple source=acme%2Fplugins. |
Liens d’application disponibles
Les liens d’application suivants peuvent être encapsulés dans le lanceur hébergé. Les chaînes de requête et les hachages sont conservés lorsque l’application ouvre le lien.
| Forme de lien d’application | S’ouvre | Remarques |
|---|---|---|
ghapp:// | Domicile | Ouvre l’itinéraire d’accueil de l’application. |
ghapp://chats | Conversations | Ouvre les conversations. |
ghapp://mywork | Mon travail | Ouvre des problèmes et des demandes de tirage dans Mon travail. |
ghapp:/ | Configuration du référentiel | Ouvre ou clone le référentiel. |
ghapp:/ | Problème | Ouvre le problème dans Mon travail lorsque le référentiel est déjà ajouté en tant que projet. |
ghapp:/ | Demande de tirage (pull request) | Ouvre la pull request dans Mon travail lorsque le dépôt est déjà ajouté en tant que projet. Les segments de chemin de fin facultatifs sont conservés. |
ghapp:/ | Tâche de l’agent | Reprend la tâche d’un agent GitHubCopilot. Utilisez l’ID de GitHub tâche, et non un ID de session local d’application. |
ghapp:/ | Automations | Ouvre les automatisations. |
ghapp:/ | Nouveau brouillon d’automatisation | Ouvre la nouvelle boîte de dialogue d’automatisation préremplie avec les paramètres de requête pris en charge. Consultez les paramètres d’automatisation. |
ghapp:/ | Automation | Ouvre une automatisation locale par défaut. Ajouter ?mode=cloud pour une automatisation du cloud. |
ghapp:/ | Exécution d’automatisation | Ouvre une automatisation locale exécutée par défaut. Ajouter ?mode=cloud pour une exécution d’automatisation cloud. |
ghapp://recent | Espaces de travail récents | Ouvre les espaces de travail récents. |
ghapp:/ | Session de l’application | Ouvre un espace de travail ou une session local d’application. N’utilisez pas cette forme pour reprendre les tâches de l’agent Copilot GitHub. |
ghapp:/ | Configuration du référentiel | Affiche une confirmation avant le clonage ou l’ouverture de la configuration du référentiel. |
ghapp:/ | Configuration du référentiel | Affiche une confirmation avant le clonage ou l’ouverture de la configuration du référentiel. |
ghapp:/ | Nouvelle session | Affiche une confirmation avant de créer une session. Utilisez les paramètres de requête pour fournir le référentiel, la pull request, la branche, le prompt ou le mode de session. Consultez les paramètres de session. |
ghapp:/ | Nouvelle session pour un référentiel | Affiche une confirmation avant de créer une session pour le référentiel. Consultez les paramètres de session. |
ghapp:/ | Formulaire d’installation du plug-in | Affiche une confirmation, puis ouvre les paramètres > Plug-ins avec le formulaire d’installation prérempli. Consultez les paramètres du plug-in. |
ghapp:/ | Formulaire de la marketplace des plugins | Affiche une confirmation, puis ouvre les paramètres > Plug-ins avec le formulaire place de marché prérempli. Consultez les paramètres du plug-in. |