Criando um plug-in para CLI do GitHub Copilot

Introdução

Plug-ins são pacotes que estendem a funcionalidade de CLI do Copilot. Confira Sobre plug-ins para CLI do GitHub Copilot.

Observação

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

Um plug-in consiste em um diretório com uma estrutura específica. No mínimo, ele deve conter um plugin.json arquivo de manifesto na raiz do diretório. Ele também pode conter qualquer combinação de agentes, habilidades, ganchos e configurações de servidor MCP.

Estrutura de plug-in de exemplo

my-plugin/
├── plugin.json           # Required manifest
├── agents/               # Custom agents (optional)
│   └── helper.agent.md
├── skills/               # Skills (optional)
│   └── deploy/
│       └── SKILL.md
├── hooks.json            # Hook configuration (optional)
└── .mcp.json             # MCP server config (optional)

Criando um plug-in

Crie um diretório para o plug-in.

Adicione um plugin.json arquivo de manifesto à raiz do diretório.

       **Arquivo de exemplo `plugin.json`**

JSON

{
  "name": "my-dev-tools",
  "description": "React development utilities",
  "version": "1.2.0",
  "author": {
    "name": "Jane Doe",
    "email": "[email protected]"
  },
  "license": "MIT",
  "keywords": ["react", "frontend"],
  "agents": "agents/",
  "skills": ["skills/", "extra-skills/"],
  "hooks": "hooks.json",
  "mcpServers": ".mcp.json"
}

{
  "name": "my-dev-tools",
  "description": "React development utilities",
  "version": "1.2.0",
  "author": {
    "name": "Jane Doe",
    "email": "[email protected]"
  },
  "license": "MIT",
  "keywords": ["react", "frontend"],
  "agents": "agents/",
  "skills": ["skills/", "extra-skills/"],
  "hooks": "hooks.json",
  "mcpServers": ".mcp.json"
}

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

Adicione alguns componentes ao plug-in criando os arquivos e diretórios apropriados para agentes, habilidades, ganchos e configurações de servidor MCP.

Por exemplo:
1. Adicione um agente criando um NAME.agent.md arquivo em um agents subdiretório.
  Markdown
```
---
name: my-agent
description: Helps with specific tasks
tools: ["bash", "edit", "view"]
---

You are a specialized assistant that...
```
```
---
name: my-agent
description: Helps with specific tasks
tools: ["bash", "edit", "view"]
---

You are a specialized assistant that...
```
2. Adicione uma habilidade criando um skills/NAME subdiretório do diretório do plug-in, onde NAME está o nome da sua habilidade. Em seguida, dentro desse subdiretório, crie um SKILL.md arquivo que defina a habilidade.
  
  Por exemplo, para criar uma habilidade de "implantação", crie skills/deploy/SKILL.md:
  Markdown
```
---
name: deploy
description: Deploy the current project to...
---

Instructions for the skill...
```
```
---
name: deploy
description: Deploy the current project to...
---

Instructions for the skill...
```
Instale o plug-in localmente, para que você possa testá-lo à medida que o desenvolve.

Por exemplo, onde ./my-plugin está o caminho para o diretório do plug-in, insira:
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
Verifique se o plug-in foi carregado com êxito exibindo sua lista de plug-ins instalados:
Shell
```
copilot plugin list
```
```
copilot plugin list
```
Ou você pode iniciar uma nova sessão interativa e inserir:
Copilot prompt
```
/plugin list
```
```
/plugin list
```
Verifique se os agentes, as habilidades, os ganchos e as configurações do servidor MCP definidos são carregados corretamente.

Por exemplo, em uma sessão interativa, para verificar se os agentes personalizados definidos no plug-in foram carregados, insira:
Copilot prompt
```
/agent
```
```
/agent
```
Para verificar se as habilidades definidas no plug-in foram carregadas, insira:
Copilot prompt
```
/skills list
```
```
/skills list
```
Use a funcionalidade fornecida pelos componentes do plug-in para verificar se cada componente funciona conforme o esperado.
Faça iterações no desenvolvimento do plug-in, conforme necessário.
Importante

Quando você instala um plug-in, seus componentes são armazenados em cache e a CLI lê do cache para sessões subsequentes. Para pegar as alterações feitas em um plug-in local, instale-o novamente:
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
Depois de concluir o teste, você poderá desinstalar a versão local do plug-in inserindo:
Shell
```
copilot plugin uninstall NAME
```
```
copilot plugin uninstall NAME
```
Observação

Para desinstalar um plug-in, use o nome do plug-in conforme especificado no name campo do arquivo de manifesto do plug-in plugin.json , não o caminho para o diretório do plug-in.

Distribuindo seu plug-in

Para distribuir o plug-in, você pode adicioná-lo a um marketplace. Confira Criando um marketplace de plugins para CLI do GitHub Copilot.

Leitura adicional

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

        [AUTOTITLE](/copilot/reference/cli-plugin-reference)

Neste artigo

Introdução

Estrutura de plug-in

Estrutura de plug-in de exemplo

Criando um plug-in

Distribuindo seu plug-in

Leitura adicional