Создание плагина для GitHub Copilot CLI

Введение

Плагины — это пакеты, расширяющие функциональность Интерфейс командной строки Copilot. См . раздел AUTOTITLE.

Примечание.

Помощь по использованию плагинов можно найти copilot plugin [SUBCOMMAND] --help в терминале.

Плагин состоит из каталога с определённой структурой. Минимум он должен содержать plugin.json манифест-файл в корне каталога. Он также может содержать любую комбинацию агентов, навыков, хуков и конфигураций серверов MCP.

Пример структуры плагина

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)

Создание плагина

Создайте папку для вашего плагина.

Добавьте plugin.json файл манифеста в корень каталога.

       **Пример `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"
}

Для подробностей полного набора полей, которые вы можете включить в этот файл, смотрите АВТОЗАГОЛОВОК.

Добавьте некоторые компоненты в плагин, создавая соответствующие файлы и каталоги для агентов, навыков, хуков и конфигураций MCP-серверов.

Рассмотрим пример.
1. Добавьте агента, создав NAME.agent.md файл в подкаталоге agents .
  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. Добавьте навык, создав skills/NAME подкаталог вашей папки плагинов, где NAME находится название вашего навыка. Затем в этой подкаталоге создайте SKILL.md файл, который определяет навык.
  
  Например, чтобы создать навык «развернуть», создайте 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...
```
Установите плагин локально, чтобы тестировать его по ходу разработки.

Например, где ./my-plugin находится путь к вашему каталогу плагинов, введите:
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
Проверьте, что плагин успешно загрузился, просмотрев список установленных плагинов:
Shell
```
copilot plugin list
```
```
copilot plugin list
```
Или вы можете начать новую интерактивную сессию и войти:
Copilot prompt
```
/plugin list
```
```
/plugin list
```
Убедитесь, что агенты, навыки, крючки и конфигурации MCP-серверов, которые вы определили, загружены правильно.

Например, в интерактивной сессии, чтобы проверить, загружены ли пользовательские агенты, определённые в плагине, введите:
Copilot prompt
```
/agent
```
```
/agent
```
Чтобы проверить, что навыки, определённые в плагине, загружены, введите:
Copilot prompt
```
/skills list
```
```
/skills list
```
Используйте функционал, предоставленный компонентами вашего плагина, чтобы убедиться, что каждый компонент работает как следует.
По мере необходимости развивайте плагины.
Внимание

Когда вы устанавливаете плагин, его компоненты кэшуются, и CLI читает данные из кэша для следующих сессий. Чтобы восстановить изменения, внесённые в локальный плагин, установите его снова:
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
После завершения тестирования вы можете удалить локальную версию плагина, введя в:
Shell
```
copilot plugin uninstall NAME
```
```
copilot plugin uninstall NAME
```
Примечание.

Чтобы удалить плагин, используйте имя плагина, указанное в name поле файла манифеста plugin.json плагина, а не путь к папке плагина.

Распространение вашего плагина

Чтобы распространять плагин, вы можете добавить его на маркетплейс. См . раздел AUTOTITLE.

Дополнительные материалы

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

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

В этой статье

Введение

Структура плагинов

Пример структуры плагина

Создание плагина

Распространение вашего плагина

Дополнительные материалы