Os links diretos ajudam as pessoas a iniciar o trabalho no aplicativo GitHub Copilot com menos troca de contexto. Por exemplo, você pode compartilhar prompts de inicialização, incluir links para o aplicativo em arquivos markdown, iniciar o aplicativo a partir de scripts de terminal ou adicionar um botão para abrir o aplicativo em ferramentas externas.
Você pode abrir o aplicativo GitHub Copilot a partir de links do navegador que envolvem um link do aplicativo no inicializador hospedado. O iniciador hospedado abre o aplicativo quando possível e mostra uma página alternativa se o navegador não puder transferir o controle para o aplicativo. Para obter uma lista completa de links de aplicativo com suporte, consulte links de aplicativo disponíveis.
Por que usar links profundos
Use links profundos quando quiser mover de uma página da Web ou fluxo de trabalho diretamente para uma página ou tarefa específica no aplicativo. Os casos de uso comuns incluem:
- Inicie as sessões com um prompt de inicialização pré-preenchido.
- Compartilhe prompts de automação para que os colegas de equipe possam abri-los e reutilizá-los rapidamente.
- Adicione botões de inicialização em documentos internos ou arquivos de markdown para abrir fluxos de trabalho comuns.
- Inicie o aplicativo a partir de comandos de terminal ou scripts como parte de fluxos de trabalho locais.
- Abra o aplicativo de produtos de terceiros, como sistemas de emissão ou tíquetes.
Formato de URL do inicializador
Use a URL do inicializador hospedado com o link completo do aplicativo codificado no parâmetro de consulta open. O iniciador hospedado abre o aplicativo quando possível e mostra uma página alternativa se o navegador não conseguir transferir para o aplicativo.
https://github.com/copilot/app/launch?open=ENCODED_APP_LINK
Use encodeURIComponent, ou o equivalente em sua linguagem de programação, para codificar o link completo do aplicativo. Se o link do aplicativo incluir parâmetros de consulta, codifique esses valores de parâmetro de consulta antes de codificar o link completo do aplicativo.open
Por exemplo, para abrir um repositório, o link do aplicativo é:
ghapp://github.com/OWNER/REPO
Codificado na URL do iniciador, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO
Os links públicos devem usar o esquema oficial ghapp:// . O aplicativo também aceita links github-app:// e gh:// por compatibilidade, mas os links gerados e documentados devem usar ghapp://.
Abrir um repositório ou item de trabalho
Para abrir uma página no aplicativo GitHub Copilot, crie uma URL de inicialização usando o link do aplicativo da página que você deseja abrir.
-
Para abrir um repositório, use este link de aplicativo:
ghapp://github.com/OWNER/REPOCodificado na URL do iniciador, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO -
Para abrir um problema, use este link do aplicativo:
ghapp://github.com/OWNER/REPO/issues/NUMBERCodificado na URL do iniciador, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fissues%2F123 -
Para abrir uma solicitação de pull, use este link do aplicativo:
ghapp://github.com/OWNER/REPO/pull/NUMBERCodificado na URL do iniciador, isso fica assim:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Fpull%2F123 -
Para retomar uma tarefa de agente, use este link de aplicativo:
ghapp://github.com/OWNER/REPO/tasks/TASK_IDCodificado na URL de inicialização, isso fica assim:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fgithub.com%2FOWNER%2FREPO%2Ftasks%2FTASK_IDUse o ID da tarefa GitHub para
TASK_ID. Não use uma ID de sessão de runtime ou uma URL de sessão local do aplicativo para links que retomem GitHubCopilot as tarefas do agente.
Abrir sessões
Para iniciar uma nova sessão a partir de um link profundo, use ghapp://session/new com parâmetros de consulta para preencher previamente o repositório, branch, solicitação de pull, prompt ou modo. Para obter parâmetros disponíveis, consulte os parâmetros de sessão.
Por exemplo, para iniciar uma nova sessão interativa com um repositório e um prompt de inicialização, use este link do aplicativo:
ghapp://session/new?repo=OWNER%2FREPO&mode=interactive&prompt=Investigate%20failing%20tests
Codificada na URL do iniciador, isso fica assim:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fsession%2Fnew%3Frepo%3DOWNER%252FREPO%26mode%3Dinteractive%26prompt%3DInvestigate%2520failing%2520tests
Parâmetros de sessão
Os links ghapp://session/new e ghapp://session/new/OWNER/REPO aceitam os seguintes parâmetros de consulta.
| Parâmetro | Obrigatório | Observações |
|---|---|---|
repo | Obrigatório para ghapp:/; opcional para ghapp:/ | Repositório em OWNER/REPO formato. |
pr | No | Número de solicitação de pull positivo. Não é possível combinar com branch. |
branch | No | Branch de base para a nova sessão. Não é possível combinar com pr. |
prompt | No | Prompt de início. Não inclua segredos ou conteúdo confidencial do usuário em URLs. |
mode | No | Uma opção entre plan, interactive ou autopilot. |
Abrir automações
Para abrir automações ou criar um novo rascunho de automação a partir de um link profundo, use os links do aplicativo de automação. Para obter parâmetros disponíveis ao criar um novo rascunho de automação, consulte os parâmetros de Automação.
-
Para abrir a página Automações, use este link do aplicativo:
ghapp://automationsCodificado na URL do lançador, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations -
Para abrir um novo rascunho de automação, use este link do aplicativo:
ghapp://automations/new?name=Daily%20triage&trigger=daily&time=09%3A00&prompt=Summarize%20new%20issuesCodificado na URL do launcher, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2Fnew%3Fname%3DDaily%2520triage%26trigger%3Ddaily%26time%3D09%253A00%26prompt%3DSummarize%2520new%2520issues -
Para abrir uma automação existente, use este link de aplicativo:
ghapp://automations/AUTOMATION_IDQuando codificado na URL do iniciador, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID -
Para abrir uma automação de nuvem, adicione
mode=cloudao link do aplicativo antes de codificar:ghapp://automations/AUTOMATION_ID?mode=cloudCodificado na URL do iniciador, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID%3Fmode%3Dcloud
Parâmetros de automação
O ghapp://automations/new link abre a nova caixa de diálogo de automação. Ele não cria a automação até que o usuário examine a caixa de diálogo e confirme no aplicativo. Não inclua segredos ou conteúdo confidencial do usuário em prompts inseridos em URLs.
| Parâmetro | Aplica-se a | Observações |
|---|---|---|
name | ghapp:/ | Nome da automação. |
prompt | ghapp:/ | Comando de automação. Não inclua segredos ou conteúdo confidencial do usuário em URLs. |
trigger | ghapp:/ | Um de manual, hourly, dailyou weekly. Valores inválidos são ignorados. |
interval também é aceito como um alias. | ||
time | ghapp:/ | Hora em HH:mm formato local de 24 horas. Aceito para os gatilhos daily e weekly. Gatilhos diários também aceitam tempos separados por vírgulas ou repetidos quando todas as entradas compartilham o mesmo minuto, por exemplo time=08:00,13:00. Valores inválidos são ignorados. |
day | ghapp:/ | Dia semanal como 0-6 (0 = domingo) ou um nome de dia da semana. Valores inválidos são ignorados. |
schedule_day também é aceito como um alias, e gatilhos semanais aceitam valores separados por vírgulas ou repetidos, como schedule_day=1,3,5. | ||
mode | ||
ghapp:/ e ghapp:/ | Use cloud para automações de nuvem. Omita ou use local para automações locais. |
Abrir fluxos do plug-in
Para abrir os fluxos de instalação do plug-in ou do marketplace a partir de um link direto, use os links de app do plug-in. Para parâmetros disponíveis, consulte os parâmetros do Plug-in.
Por exemplo, para abrir o formulário de instalação do plug-in com uma fonte pré-preenchida, use este link de aplicativo:
ghapp://plugins/install?source=my-plugin%40acme
Codificado na URL do launcher, isso se torna:
https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fplugins%2Finstall%3Fsource%3Dmy-plugin%2540acme
Parâmetros de plug-in
Links para plug-ins abrem a tela Configurações > Plug-ins com um formulário pré-preenchido. Eles não instalam um plug-in ou adicionam um marketplace até que o usuário confirme no aplicativo.
| Link | Parâmetro | Obrigatório | Observações |
|---|---|---|---|
ghapp:/ | source | Yes | Origem do plug-in no PLUGIN@MARKETPLACE formato. Codifique o valor usando codificação de URL, por exemplo source=my-plugin%40acme. |
ghapp:/ | source | Yes | Fonte do Marketplace como OWNER/REPO ou uma URL do Git. Codifique o valor em URL, por exemplo source=acme%2Fplugins. |
Links de aplicativo disponíveis
Os links de aplicativo a seguir podem ser encapsulados no inicializador hospedado. Cadeias de caracteres de consulta e hashes são preservados quando o aplicativo abre o link.
| Forma do link do aplicativo | Abre | Observações |
|---|---|---|
ghapp:// | Página Inicial | Abre a rota inicial do aplicativo. |
ghapp://chats | Conversas | Abre chats. |
ghapp://mywork | Meu trabalho | Abre problemas e solicitações de pull em Meu trabalho. |
ghapp:/ | Configuração do repositório | Abre ou clona o repositório. |
ghapp:/ | Issue | Abre o item na seção Meu trabalho se o repositório já foi adicionado como projeto. |
ghapp:/ | Solicitação de pull | Abre a solicitação pull em Meu trabalho quando o repositório já está adicionado como um projeto. Segmentos opcionais de caminho à direita são preservados. |
ghapp:/ | Tarefa do agente | Retoma uma GitHubCopilot tarefa do agente. Use a ID da GitHub tarefa, não uma ID de sessão local do aplicativo. |
ghapp:/ | Automations | Abre Automações. |
ghapp:/ | Novo rascunho de automação | Abre a nova caixa de diálogo de automação com parâmetros de consulta com suporte pré-preenchidos. Consulte os parâmetros de Automação. |
ghapp:/ | Automação | Abre uma automação local por padrão. Adicionar ?mode=cloud para uma automação de nuvem. |
ghapp:/ | Execução automatizada | Abre uma automação local executada por padrão. Adicionar ?mode=cloud para uma execução de automação de nuvem. |
ghapp://recent | Espaços de trabalho recentes | Abre os espaços de trabalho recentes. |
ghapp:/ | Sessão do aplicativo | Abre um espaço de trabalho ou sessão local ao aplicativo. Não use essa forma para retomar GitHub agente do Copilot tarefas. |
ghapp:/ | Configuração do repositório | Mostra uma confirmação antes de clonar ou abrir a instalação do repositório. |
ghapp:/ | Configuração do repositório | Mostra uma confirmação antes de clonar ou abrir a instalação do repositório. |
ghapp:/ | Nova sessão | Mostra uma confirmação antes de criar uma sessão. Use parâmetros de consulta para fornecer o repositório, a solicitação de pull, o branch, o prompt ou o modo de sessão. Consulte os parâmetros de sessão. |
ghapp:/ | Nova sessão para um repositório | Mostra uma confirmação antes de criar uma sessão para o repositório. Consulte os parâmetros de sessão. |
ghapp:/ | Formulário de instalação do plug-in | Mostra uma confirmação e, em seguida, abre Configurações > Plug-ins com o formulário de instalação pré-preenchido. Consulte os parâmetros do Plug-in. |
ghapp:/ | Formulário da loja de plugins | Mostra uma confirmação e, em seguida, abre Configurações > Plug-ins com o formulário do marketplace pré-preenchido. Consulte os parâmetros do Plug-in. |