Быстрый старт

Эта инструкция поможет вам создать пустой плагин в нужном слоте и открыть его в интерфейсе сервиса в режиме отладки.

В результате вы получите плагин-заготовку, который:

  • отображается в интерфейсе;
  • использует компоненты дизайн-системы;
  • готов для дальнейшей разработки.

TLDR

  1. npm install -g @weavix/cli
  2. weavix create
  3. weavix debug
  4. Откройте интерфейс сервиса и src/App.tsx — изменения видны сразу без перезапусков

Шаг 1. Установка Node.js и CLI

Этот шаг нужно выполнить один раз в начале разработки первого плагина.

Установите Node.js версии 22.16.0 или выше. Чтобы проверить установленную версию, выполните команду: node -v.

На macOS и Linux рекомендуем устанавливать Node.js через nvm: так глобальная установка пакетов работает без sudo, а версии Node.js проще переключать и обновлять. На Windows установите Node.js привычным способом или используйте менеджер версий для Windows.

Установите CLI. Для этого в командной строке выполните команду:

npm install -g @weavix/cli

Шаг 2. Создание плагина

В командной строке выполните команду:

weavix create

При выполнении команды ответьте на несколько вопросов:

  • Сервис: выберите сервис, для которого создается плагин, например Трекер.
  • Шаблон: выберите подходяще место встраивания, например issue.action для действий с задачей Трекера. Подробнее о местах встраивания
  • ID плагина: задайте идентификатор, содержащий только строчные буквы, цифры и дефисы.
  • Категория: выберите категорию для отображения плагина в каталоге. Полный список категорий
  • Разрешения: выберите с помощью стрелок и клавиши «Пробел».
  • Автор/email: укажите вашу почту, чтобы пользователи могли задавать вопросы и сообщать об ошибках.

Затем выполните:

cd ваш-плагин-id
npm install

Шаг 3. Запуск и просмотр

Выполните команду:

weavix debug

CLI выведет URL сервиса, соответствующий выбранному шаблону. Открывайте именно этот URL: для некоторых сервисов он содержит параметр slotPluginsConfigUrl со ссылкой на локальный config.json.

Браузер Safari не поддерживает режим отладки, используйте другой браузер.

Если отладка не работает, обратитесь к администратору вашей организации и попросите разрешить отладку плагинов. Как разрешить отладку

При включении отладки браузер может запросить разрешение на доступ к локальной сети. Разрешите доступ: без него отладка не будет работать, так как конфиг и плагины загружаются с localhost.

Найдите ваш плагин в интерфейсе — в месте, которое соответствует выбранному слоту. Готово!

Шаг 4. Редактирование плагина

Откройте src/App.tsx — изменения видны сразу, без перезапусков.

Базовая структура плагина уже содержится в файлах.

Что уже настроено:

  • React + TypeScript;
  • Gravity UI — компоненты дизайн-системы;
  • Тема Яндекс 360 — ваш плагин будет выглядеть как часть сервиса.

Для работы с API подключите пакеты нужных сервисов.

Что еще понадобится:

ИИ поможет

Все API типизированы — ИИ легко разберется. Вот пример работающего промпта, с помощью которого можно создать плагин:

Напиши плагин для импорта задач в Трекер из файла csv.
Для вызовов Tracker Public API используйте trackerApi из пакета @weavix/tracker-plugin-sdk-react — это типизированный прокси, который выполняет запросы через хост.
Нужно, чтобы в плагине была форма, в которой есть поиск нужной очереди для импорта, выбор разделителя csv, сам файл csv.
Потом нужно, чтобы пользователь мог сопоставить поля из csv с полями задач.
Также нужно отобразить индикатор импорта и результат.
Плагину нужно указать в манифесте слот navigation, также не забудь добавить права на чтение очередей и полей, используй приложенную схему манифеста

Шаг 5. Публикация плагина

Когда локальная разработка завершена, опубликуйте плагин:

  1. Подготовьте изображения, описание и справку.

  2. Получите токен, запустив команду weavix login.

  3. Запустите команду weavix submit. CLI сама зарегистрирует плагин при необходимости, загрузит дистрибутив и отправит версию на проверку.

  4. После отправки отслеживайте статус командой weavix list.

Подробнее о публикации плагина