Skip to main content

Criando um marketplace de plugins para CLI do GitHub Copilot

Você pode tornar os plug-ins da CLI que você criou fáceis de instalar adicionando-os a um marketplace.

Introdução

Os mercados de plugins são registros de plugins para CLI do Copilot. Eles podem estar localizados em GitHub.com, em qualquer 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.

Observação

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

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 que CLI do Copilot reconheça o repositório como um mercado de plug-ins e fornece uma maneira fácil para os usuários instalarem plug-ins.

           **Arquivo de exemplo `marketplace.json`**
    
    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"
        }
      ]
    }
    

    Exemplos online:

    •      [marketplace.json](https://github.com/github/copilot-plugins/blob/main/.github/plugin/marketplace.json) no repositório [github/copilot-plugins](https://github.com/github/copilot-plugins) .
      
    •      [marketplace.json](https://github.com/github/awesome-copilot/blob/main/.github/plugin/marketplace.json) no repositório [github/awesome-copilot](https://github.com/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 do plugin CLI do GitHub Copilot.

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

    Observação

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

  3. 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.

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

    Shell
    copilot plugin marketplace add octo-org/octo-repo
    

Leitura adicional

  •         [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/plugins-finding-installing)
    
  •         [AUTOTITLE](/copilot/reference/cli-plugin-reference)