Criando um marketplace de plugin para CLI do GitHub Copilot

Introdução

Os marketplaces de plug-in são registros de plug-ins para CLI do Copilot. Eles podem estar localizados em GitHub.comqualquer outro serviço de hospedagem git online ou em seu sistema de arquivos local ou compartilhado. Ao criar um marketplace e adicionar seus plug-ins a ele, você pode facilitar a localização e a instalação de seus plug-ins para outros usuários.

Pré-requisito

Você criou um ou mais plug-ins que deseja compartilhar. Confira Criando um plug-in para CLI do GitHub Copilot.

Criando um marketplace de plug-in

1. Crie um marketplace.json arquivo que forneça metadados sobre seu marketplace e liste os plug-ins disponíveis no marketplace.

   Observação

   O marketplace.json arquivo é o único componente necessário de um marketplace de plug-in. Adicioná-lo a um repositório permite CLI do Copilot reconhecer o repositório como um marketplace de plug-in e fornece uma maneira fácil para os usuários instalarem plug-ins.

Arquivo de exemplo marketplace.json

{
  "name": "my-marketplace",
  "owner": {
    "name": "Your Organization",
    "email": "plugins@example.com"
  },
  "metadata": {
    "description": "Curated plugins for our team",
    "version": "1.0.0"
  },
  "plugins": [
    {
      "name": "frontend-design",
      "description": "Create a professional-looking GUI ...",
      "version": "2.1.0",
      "source": "./plugins/frontend-design"
    },
    {
      "name": "security-checks",
      "description": "Check for potential security vulnerabilities ...",
      "version": "1.3.0",
      "source": "./plugins/security-checks"
    }
  ]
}

{
  "name": "my-marketplace",
  "owner": {
    "name": "Your Organization",
    "email": "plugins@example.com"
  },
  "metadata": {
    "description": "Curated plugins for our team",
    "version": "1.0.0"
  },
  "plugins": [
    {
      "name": "frontend-design",
      "description": "Create a professional-looking GUI ...",
      "version": "2.1.0",
      "source": "./plugins/frontend-design"
    },
    {
      "name": "security-checks",
      "description": "Check for potential security vulnerabilities ...",
      "version": "1.3.0",
      "source": "./plugins/security-checks"
    }
  ]
}

Exemplos online:

• marketplace.json no repositório github/copilot-plugins.
• marketplace.json no repositório github/awesome-copilot.

O campo de nível plugins superior é uma matriz de objetos de plug-in, cada um contendo metadados sobre um plug-in, incluindo seu nome, descrição, versão e origem.

O valor do source campo para cada plug-in é o caminho para o diretório do plug-in, em relação à raiz do repositório. Não é necessário usar ./ no início do caminho. Por exemplo, "./plugins/plugin-name" e "plugins/plugin-name" resolvem para o mesmo diretório.

Para obter detalhes do conjunto completo de campos que você pode incluir neste arquivo, consulte referência de plugin da CLI GitHub Copilot.

1. Adicione o arquivo marketplace.json ao diretório .github/plugin de um repositório.

   Observação

   O CLI do Copilot também procura o arquivo marketplace.json no diretório .claude-plugin/.

2. Para cada plug-in definido no marketplace.json arquivo, adicione o diretório de plug-in relevante ao local apropriado no repositório.

   Por exemplo, se o arquivo marketplace.json incluir um plug-in com "source": "./plugins/frontend-design", adicione o diretório do plug-in frontend-design ao diretório plugins na raiz do seu repositório.

3. Compartilhe o repositório com os usuários pretendidos e forneça instruções para adicionar o marketplace ao CLI do Copilot. Por exemplo, se o seu repositório estiver hospedado em GitHub no repositório octo-org/octo-repo, instrua os usuários a inserirem:

   Shell

   copilot plugin marketplace add octo-org/octo-repo
   

Leitura adicional

• Localizando e instalando plug-ins para CLI do GitHub Copilot
• referência de plugin da CLI GitHub Copilot