Localizando e instalando plug-ins para GitHub Copilot CLI

Estenda Copilot instalando plugins criados pela comunidade ou pela sua organização.

Neste artigo

Plug-ins são pacotes que estendem a funcionalidade de Copilot CLI. Você pode instalar um plug-in de um marketplace registrado na CLI.

Para obter uma visão geral, consulte Plug-ins para GitHub Copilot.

Observação

Você pode encontrar ajuda para usar plug-ins entrando copilot plugin [SUBCOMMAND] --help no terminal.

Localizar plug-ins

Os plug-ins são reunidos em marketplaces. Um marketplace é um registro de plug-ins que você pode navegar e instalar. Copilot CLI inclui o awesome-copilot marketplace por padrão.

Para listar marketplaces registrados, insira:

Shell
copilot plugin marketplace list

Em uma sessão interativa, insira:

Copilot prompt
/plugin marketplace list

Para procurar plug-ins em um marketplace registrado, insira:

Shell
copilot plugin marketplace browse MARKETPLACE-NAME

Substitua MARKETPLACE-NAME pelo nome do marketplace.

Em uma sessão interativa, insira:

Copilot prompt
/plugin marketplace browse MARKETPLACE-NAME

Instale plugins

Para instalar um plug-in de um marketplace registrado, insira:

Shell
copilot plugin install PLUGIN-NAME@MARKETPLACE-NAME

Por exemplo, para instalar database-data-management a partir de awesome-copilot, insira:

Shell
copilot plugin install database-data-management@awesome-copilot

Em uma sessão interativa, insira:

Copilot prompt
/plugin install PLUGIN-NAME@MARKETPLACE-NAME

Você também pode instalar um plug-in de um repositório GitHub, uma URL do Git, um subdiretório de repositório ou um caminho local. Para formatos aceitos, consulte a especificação do Plug-in para o install comando.

Gerenciar plug-ins instalados

Use estes comandos para gerenciar plug-ins instalados:

Shell
copilot plugin list
copilot plugin update PLUGIN-NAME
copilot plugin uninstall PLUGIN-NAME
copilot plugin disable PLUGIN-NAME
copilot plugin enable PLUGIN-NAME

disable desativa um plug-in sem desinstalá-lo. uninstall o remove. Para todos os comandos e opções, consulte referência de plugin da CLI GitHub Copilot.

Adicionar um marketplace

Para registrar um marketplace hospedado em um repositório GitHub, insira:

Shell
copilot plugin marketplace add OWNER/REPOSITORY

Substitua OWNER/REPOSITORY pelo repositório que hospeda o marketplace. Por exemplo:

Shell
copilot plugin marketplace add anthropics/claude-code

Em uma sessão interativa, insira:

Copilot prompt
/plugin marketplace add OWNER/REPOSITORY

Você também pode adicionar um marketplace de um diretório local ou de um repositório Git hospedado em outro lugar. Use o caminho do diretório do marketplace para uma fonte local:

Shell
copilot plugin marketplace add /PATH/TO/MARKETPLACE-DIRECTORY

Para um repositório Git hospedado em outro lugar, use sua URL do Git:

Shell
copilot plugin marketplace add https://gitlab.com/OWNER/REPO.git

Para obter diretrizes sobre como publicar um GitHubmarketplace hospedado, consulte Criando e compartilhando um marketplace de plug-in no GitHub.

Remover marketplace

Para remover o registro de um marketplace, insira:

Shell
copilot plugin marketplace remove MARKETPLACE-NAME

Em uma sessão interativa, insira:

Copilot prompt
/plugin marketplace remove MARKETPLACE-NAME

Ao adicionar um marketplace, você o identifica por sua origem. Ao removê-lo, use o nome do marketplace mostrado na lista do marketplace. O comando falhará se os plug-ins do marketplace ainda estiverem instalados. Adicione --force também para desinstalar esses plug-ins.

Desativar o padrão do repositório

As configurações padrão do repositório são opcionais. Para desativar um plug-in habilitado pelas configurações do repositório, adicione uma false entrada a enabledPlugins em .github/copilot/settings.local.json:

JSON
{
  "enabledPlugins": {
    "PLUGIN-NAME@MARKETPLACE-NAME": false
  }
}

Substitua o identificador pelo nome do plug-in e pelo nome do marketplace. Salve o arquivo e inicie uma nova sessão. Para ativar o plug-in novamente, defina a entrada como true.

Não faça commit deste arquivo de configurações local. As configurações gerenciadas da empresa têm precedência sobre as configurações padrão do repositório e as substituições locais. Para obter detalhes, consulte Diretório de configuração do GitHub Copilot CLI.

Leitura adicional