Note
As GitHub Copilot Extensions estão em versão prévia pública e sujeitas a alterações.
A extensão Blackbeard é uma GitHub Copilot Extension criada com um agente simples que responde a solicitações como um pirata usando a API de modelo de linguagem grande (LLM) e solicitações especiais do sistema do Copilot. Este guia usa uma implementação de agente simples, mas o processo é semelhante para conjuntos de habilidades.
Este início rápido foi elaborado para ajudar você a compilar e bater papo com a extensão Blackbeard o mais rápido possível, para que possa desenvolver e testar sua extensão sem implantar a infraestrutura. Para produção, você precisará hospedar o aplicativo para os pontos de extremidade do agente ou do conjunto de habilidades em um servidor acessível publicamente. Para aprender a criar uma GitHub Copilot Extension, confira Configurar extensões do Copilot.
1. Criar e instalar um GitHub App
Nas configurações de desenvolvedor de sua conta do GitHub, crie um GitHub App. O GitHub App precisa ter:
- Um nome
- Uma URL da home page
- Webhooks desmarcados
Depois de criar o aplicativo, clique em Install App na barra lateral e instale o aplicativo em sua conta.
Para obter instruções detalhadas, confira Criar um aplicativo GitHub para sua extensão do Copilot.
2. Clonar e hospedar o agente do Blackbeard localmente
Em vez de implantar o agente do Blackbeard como um aplicativo Web, você pode hospedar o agente localmente para ter um processo de compilação significativamente mais rápido.
- Usando o Terminal integrado ao VS Code, clone o repositório
copilot-extensions/blackbeard-extension. - No mesmo Terminal, execute
npm installpara instalar as dependências necessárias e executenpm startpara iniciar o agente do Blackbeard na porta 3000. - Na guia "Ports" do painel do VS Code, clique em Forward a port ou em Add port e adicione a porta 3000.
- Clique com o botão direito do mouse na porta, defina a visibilidade como "Public" e copie o endereço local.
3. Integrar e testar a extensão Blackbeard
Depois de configurar o GitHub App e o agente do Blackbeard, você pode integrar o agente ao aplicativo e testar a extensão Blackbeard. Você precisa fazer as seguintes alterações em suas configurações do GitHub App:
- Nas configurações "General", no campo "Callback URL", cole o endereço local do agente.
- Nas configurações "Permissions & events", conceda permissões somente leitura a Copilot Chat.
- Nas configurações "Copilot", defina o tipo de aplicativo como "Agent" e preencha os campos restantes.
Depois de atualizar as configurações do GitHub App, você pode começar a bater papo com sua extensão digitando @YOUR-EXTENSION-NAME na janela Copilot Chat e enviando uma solicitação normalmente.
Para obter instruções mais detalhadas, confira Configurar o Aplicativo GitHub para a extensão do Copilot.
2. Clonar e hospedar o agente do Blackbeard em um codespace
Em vez de implantar o agente do Blackbeard como um aplicativo Web, você pode hospedá-lo em um codespace para ter um processo de compilação significativamente mais rápido.
- Navegue até o repositório
copilot-extensions/blackbeard-extension. Selecione o menu suspenso Code e clique em Create codespace on main. - Para encontrar o novo codespace, selecione o menu suspenso Code . Ao lado do novo codespace, selecione e clique em Open in Browser.
- No Terminal integrado, execute
npm startpara iniciar o agente Blackbeard na porta 3000. - Na guia "Ports" do painel do VS Code, clique em Forward a port e adicione a porta 3000.
- Clique com o botão direito do mouse na porta, defina a visibilidade como "Public" e copie o endereço local.
3. Integrar e testar a extensão Blackbeard
Depois de configurar o GitHub App e o agente do Blackbeard, você pode integrar o agente ao aplicativo e testar a extensão Blackbeard. Você precisa fazer as seguintes alterações em suas configurações do GitHub App:
- Nas configurações "General", no campo "Callback URL", cole o endereço encaminhado do agente.
- Nas configurações "Permissions & events", conceda permissões somente leitura a Copilot Chat.
- Nas configurações "Copilot", defina o tipo de aplicativo como "Agent" e preencha os campos restantes.
Depois de atualizar as configurações do GitHub App, você pode começar a bater papo com sua extensão digitando @YOUR-EXTENSION-NAME na janela Copilot Chat de um cliente ou IDE com suporte e enviando uma solicitação normalmente. Para ver uma lista de clientes e IDEs com suporte, confira Sobre a construção de extensões do Copilot.
Note
Não há suporte para bater papo com GitHub Copilot Extensions em GitHub Codespaces.
Para obter instruções mais detalhadas, confira Configurar o Aplicativo GitHub para a extensão do Copilot.
2. Clonar e iniciar o agente do Blackbeard localmente
Em vez de implantar o agente do Blackbeard como um aplicativo Web, você pode hospedar o agente localmente para ter um processo de compilação significativamente mais rápido.
- Usando o aplicativo de linha de comando, clone o repositório
copilot-extensions/blackbeard-extension. - Execute
npm installpara instalar as dependências necessárias e executenpm startpara iniciar o agente do Blackbeard na porta 3000.
3. Expor o servidor local
Para tornar o agente Blackbeard acessível para a plataforma Copilot e o GitHub, você precisa expor o servidor local para que ele possa ser acessado por solicitações HTTP. Você pode usar qualquer serviço de encaminhamento ou túnel de porta para fazer isso. Para as etapas a seguir, usaremos o ngrok.
-
Navegue até a página de download do ngrok e instale a versão apropriada do ngrok para seu sistema operacional.
-
Navegue até a página de configuração e instalação do ngrok e faça logon ou inscreva-se pata obter uma conta do ngrok.
-
Para expor o servidor local, em uma nova janela do aplicativo de linha de comando, execute o seguinte comando:
Shell ngrok http http://localhost:3000
ngrok http http://localhost:3000 -
No aplicativo de linha de comando, ao lado de "Forwarding", copie a URL atribuída pelo ngrok ao servidor.
4. Integrar e testar a extensão Blackbeard
Para integrar seu GitHub App ao agente do Blackbeard, você precisa fazer as seguintes alterações nas configurações do aplicativo:
- Nas configurações "General", no campo "Callback URL", cole a URL do servidor exposto.
- Nas configurações "Permissions & events", conceda permissões somente leitura a Copilot Chat.
- Nas configurações "Copilot", defina o tipo de aplicativo como "Agent" e preencha os campos restantes.
Depois de atualizar as configurações do GitHub App, você pode começar a bater papo com sua extensão digitando @YOUR-EXTENSION-NAME na janela Copilot Chat e enviando uma solicitação normalmente.
Para obter instruções mais detalhadas, confira Configurar o Aplicativo GitHub para a extensão do Copilot.
Próximas etapas
Agora que tem uma GitHub Copilot Extension em funcionamento, você pode tentar aproveitar o agente do Blackbeard para experimentar com o desenvolvimento do agente.
Para aprender sobre implementações de agentes mais complexas, você também pode examinar os seguintes agentes de exemplo e SDK (kit de desenvolvimento de software), todos disponíveis na organização copilot-extensions:
- GitHub Models: um agente mais complexo que permite perguntar e interagir com vários LLMs listados no GitHub Marketplace via Copilot Chat. O agente GitHub Models usa o recurso de chamada de função.
- Chamada de função: um agente de exemplo escrito em Go que demonstra caixas de diálogo de confirmação e chamada de função.
- Extensão RAG: um agente de exemplo escrito em Go que demonstra uma implementação simples de geração aumentada de recuperação.
- SDK de visualização: um SDK que simplifica o desenvolvimento de Copilot Extensions manipulando a verificação de solicitação, a análise de payloads e a formatação automática de resposta. Esse SDK permite que os criadores de extensões se concentrem mais na criação de funcionalidades principais e menos em código clichê.