--- metadata: - name: generator content: Diplodoc Platform v5.54.5 - property: og:type content: article - property: article:section content: Платформа плагинов - property: og:title content: Первый плагин за 5 минут - property: article:tag content: Техническая инструкция alternate: - https://yandex.ru/support/tracker/en/plugins/quickstart.md - https://yandex.ru/support/tracker/ru/plugins/quickstart.md - href: ru/plugins/quickstart.md type: text/markdown title: Markdown version - href: ../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt # Первый плагин за 5 минут {% note alert "" %} Перед началом разработки плагина убедитесь, что: - администратор организации разрешил отладку плагинов. Этот переключатель действует для всех пользователей организации. [Как администратору разрешить отладку плагинов](https://yandex.ru/support/tracker/ru/plugins-admin.md#block-all); - вы включили отладку в Трекере: ![](../_assets/svg/settings-360.svg) **Настройки** → **Эксперименты** → **Отладка плагинов**. Этот переключатель включает отладку только для вашего аккаунта. Без обоих настроек вы не сможете завершить разработку. {% endnote %} > **Коротко — что нужно сделать:** > `npm install -g @weavix/cli ` → `weavix create` → `weavix debug` → откройте Трекер. ## Что мы создадим {#what-we-build} За 5 минут вы создадите работающий плагин, который: - отображается в интерфейсе Трекера; - использует компоненты дизайн-системы Трекера; - готов для расширения под ваши задачи. ![final.gif](../\_assets/plugins/final.gif =686x){.border-yes} ## Шаг 1: Установка {#install} Этот шаг нужно выполнить один раз в начале разработки первого плагина. 1. Установите Node.js версии 22.16.0 или выше. Чтобы проверить установленную версию, выполните команду: `node -v`. На macOS и Linux рекомендуем устанавливать Node.js через [nvm](https://github.com/nvm-sh/nvm): так глобальная установка пакетов работает без `sudo`, а версии Node.js проще переключать и обновлять. На Windows установите Node.js привычным способом или используйте менеджер версий для Windows. 1. Установите CLI. Для этого в командной строке выполните команду: ```bash npm install -g @weavix/cli ``` ## Шаг 2: Создание плагина {#create} В командной строке выполните команду: ```bash weavix create ``` При выполнении команды ответьте на несколько вопросов: - **Шаблон**: выберите подходящий для вашего [слота](https://yandex.ru/support/tracker/ru/plugins/slots/index.md), например `issue.action` для действий с тикетом - **ID плагина**: задайте идентификатор, содержащий только строчные буквы, цифры и дефисы - **Категория**: выберите категорию для отображения плагина в каталоге. Полный список категорий — на странице [Как подготовить плагин к публикации](https://yandex.ru/support/tracker/ru/plugins/publish.md#category) - **Разрешения**: выберите с помощью стрелок и клавиши «Пробел» - **Автор/email**: укажите ваши контактные данные Затем выполните: ```bash cd ваш-плагин-id npm install ``` ## Шаг 3: Запуск и просмотр {#run} Выполните команду: ```bash weavix debug ``` Откройте [Трекер](https://tracker.yandex.ru) и в меню выберите ![](../_assets/svg/settings-360.svg) **Настройки** → **Эксперименты** → **Отладка плагинов** ![debug-settings.png](../\_assets/plugins/debug-settings.png =588x){.border-yes} {% note warning "" %} Отладка в браузере Safari не поддерживается из-за ограничений браузера. Для отладки используйте другой браузер. Если отладка не работает, обратитесь к администратору вашей организации и попросите разрешить отладку плагинов. [Как разрешить отладку](https://yandex.ru/support/tracker/ru/plugins-admin.md#block-all) {% endnote %} При включении отладки браузер может запросить разрешение на доступ сайта к локальной сети. Разрешите доступ: без него отладка не будет работать, так как конфиг и плагины загружаются с `localhost`. Найдите ваш плагин в интерфейсе — в месте, которое соответствует выбранному слоту. Готово. ## Шаг 4: Публикация плагина {#publish} Когда локальная разработка завершена, опубликуйте плагин. Подробно публикация плагина описана на странице [Как подготовить плагин к публикации](https://yandex.ru/support/tracker/ru/plugins/publish.md). 1. Перед отправкой плагина на публикацию подготовьте изображения, описание и справку. 1. Получите токен, выполнив команду: [`weavix login`](https://yandex.ru/support/tracker/ru/plugins/tools/cli.md). 1. Запустите команду: [`weavix submit`](https://yandex.ru/support/tracker/ru/plugins/tools/cli.md) — команда сама зарегистрирует плагин при необходимости, загрузит дистрибутив и отправит версию на модерацию. 4. После отправки отслеживайте статус командой `weavix list`. ## Что дальше? {#what-next} ### Редактирование {#editing} Откройте `src/App.tsx` — изменения видны сразу. Никаких перезапусков не нужно. ### Что уже настроено {#whats-configured} - React + TypeScript - [Gravity UI](https://gravity-ui.com) — компоненты дизайн-системы - Тема Яндекс 360 — ваш плагин будет выглядеть как часть Трекера - SDK — для работы с данными Трекера через [trackerApi](https://yandex.ru/support/tracker/ru/plugins/publicApi.md) ### Примеры кода {#code-examples} Базовая структура плагина уже содержится в файлах. Примеры кода можно посмотреть на странице [Вопросы о платформе плагинов](https://yandex.ru/support/tracker/ru/plugins/examples.md). ## ИИ поможет {#ai-help} Все API типизированы — ИИ легко разберется. Вот пример работающего промпта, с помощью которого можно создать плагин: ``` Напиши плагин для импорта задач в Трекер из файла csv. Для взаимодействия с Трекером используется пакет @weavix/tracker-plugin-sdk-react, в котором есть `trackerApi` — клиент публичного API Трекера. Нужно, чтобы в плагине была форма, в которой есть поиск нужной очереди для импорта, выбор разделителя csv, сам файл csv. Потом нужно, чтобы пользователь мог сопоставить поля из csv с полями задач. Также нужно отобразить индикатор импорта и результат. Плагину нужно указать в манифесте слот navigation, также не забудь добавить права на чтение очередей и полей, используй приложенную схему манифеста ``` {% endnote %} ## Нужна помощь? {#help} - [Примеры плагинов](https://yandex.ru/support/tracker/ru/plugins/examples.md) — посмотрите, что можно сделать - [API и SDK](https://yandex.ru/support/tracker/ru/plugins/publicApi.md) — как работать с данными Трекера - [Слоты и размещение](https://yandex.ru/support/tracker/ru/plugins/slots/index.md) — где может отображаться плагин - [CLI команды](https://yandex.ru/support/tracker/ru/plugins/tools/cli.md) — полный справочник инструментов