Документация

Документация/Настройка

Плагины

Плагин добавляет в DevMachine свой экран и инструменты для агента. Как поставить плагин из папки, что проверить на экране установки, как выключить и удалить его.

Плагин — это папка с файлом plugin.json и уже собранными файлами. У плагина две части: экран в центре окна с кнопкой в верхней панели и инструменты для агента. Плагину хватает и одной из них. Ещё он может добавить поля настроек, навыки и короткие инструкции для агента. Сам плагин в сеть не ходит: запросы за него отправляет DevMachine, и только на адреса, которые вы одобрили при установке.

Готовые плагины от DevMachine и из каталога вашей организации лежат в «Настройки → Плагины», в блоке «Можно установить».

Как поставить плагин из папки

  1. Откройте «Настройки → Плагины» (группа «Что умеет агент»).
  2. Нажмите «Добавить из папки…» и выберите папку, где лежит plugin.json.
  3. Откроется экран «Установка плагина». Прочитайте на нём, что получит плагин и что получит агент: каждый блок экрана разобран ниже.
  4. Если плагин даёт агенту инструменты, решите, ставить ли отметку «Дать агенту во всех проектах». У такого плагина свой модуль, и отметка сразу включает его во всех проектах. Без отметки агент получит эти инструменты только в тех проектах, где вы включите модуль плагина в «Настройки → Модули» (подробнее — на странице Модули).
  5. Нажмите «Установить и включить».

Экран плагина появится сразу, а инструменты для агента — со следующего чата.

Экран установки

БлокЧто в нём
«Что вы увидите»Экран плагина в центре окна и кнопка в верхней панели — или «Экрана нет»
«Что получает плагин»Права плагина (таблица ниже)
«Что получает агент»Инструменты: «Читает» — только чтение, «Меняет» — с последствиями. «Каждое изменение вы подтверждаете на карточке.» Здесь же навыки и текст, который войдёт в инструкции агента
«Куда ходит плагин»Адреса, куда плагин может отправлять запросы, и сервисы, в которые он ходит с вашим токеном
«Откуда»Папка плагина, число файлов и размер. У плагина из папки стоит отметка «не подписан»
«Проверка»Ошибки в пакете или то, чего эта версия DevMachine ещё не умеет

Права плагина

ПравоЧто даёт
Без особых правСвоё хранилище до 2 МиБ, уведомления, вставка текста в поле ввода без отправки
«Читать файлы открытого проекта»Плагин читает файлы внутри открытого проекта
«Изменять файлы открытого проекта»Плагин записывает файлы внутри открытого проекта
«Видеть чаты проекта и открывать их»Плагин видит список чатов проекта и может открыть чат
«Отправлять сообщения в открытый чат от вашего имени»Сообщение уходит агенту так, будто его написали вы
«Вызывать небольшую модель»Короткий запрос к модели через DevMachine. Запрос расходует лимит вашей подписки

Даже с правами на файлы плагину закрыты .git, .env и файлы с ключами и паролями — так же, как агенту.

Как пользоваться

  • Экран. Откройте его кнопкой плагина в верхней панели или кнопкой «Открыть» в строке плагина в настройках.
  • Инструменты агента. Агент берёт их сам, когда они подходят к задаче. Если инструмент что-то меняет, перед каждым его вызовом появляется карточка. Варианта «Всегда» у неё нет, и с телефона такую карточку не подтвердить.
  • Токены сервисов. Если плагин ходит в сервис с вашим токеном, задайте токен: строка плагина → «Ещё» → «Настроить» → «Учётные записи». Рядом с сервисом написано «Задан» или «Не задан». Сам плагин токена не видит: DevMachine подставляет его в запрос.

Когда плагин изменился

Одобрение привязано к файлам плагина. Если файлы в папке изменились, DevMachine остановит плагин и покажет «Плагин изменился». Посмотрите, что поменялось, и нажмите «Перезагрузить». Если новая версия просит больше прав, чем вы одобрили, DevMachine напишет: «Новая версия просит больше, чем вы одобрили.» Нажмите «Посмотреть права» и одобрите версию заново.

Как выключить и удалить

  • Выключить — переключатель в строке плагина в «Настройки → Плагины». Экран и инструменты плагина пропадут, а включить их обратно можно тем же переключателем.
  • Удалить — «Ещё» → «Удалить». DevMachine переспросит: «Удалить плагин и его данные?»

Плагин от DevMachine

В блоке «Можно установить» есть плагины с отметкой «От DevMachine»: они идут вместе с приложением. Сейчас это «Заметки для агента». В плагине есть экран «Заметки», где вы записываете договорённости команды и ход задачи, и инструмент, которым агент эти заметки читает. Чтобы поставить его, нажмите «Установить».

Плагин пишет агент

Агент умеет писать плагины сам: за это отвечает модуль «Plugins», по умолчанию он включён. Попросите: «Сделай плагин, который показывает…». Агент может предложить плагин и сам: если в одном чате вы в третий раз просите о той же ручной работе, агент её сделает, а в конце ответа одной фразой предложит написать плагин. Писать его он начнёт только после вашего согласия.

  1. Агент создаёт файлы плагина, проверяет их и предлагает плагин вам.
  2. В «Настройки → Плагины» появляется блок «Предложения агента».
  3. Нажмите «Посмотреть»: откроются код, права и разница с прошлой версией. Затем нажмите «Установить и включить» или «Отклонить».

Сам агент ничего не ставит.

Для авторов: plugin.json

Минимальный плагин с одним экраном:

acme.hello/
  plugin.json
  ui/index.html
  ui/main.js
{
  "apiVersion": 1,
  "id": "acme.hello",
  "version": "1.0.0",
  "engines": { "devmachine": ">=2" },
  "title": "Hello",
  "description": "Показывает название открытого проекта",
  "author": { "name": "ACME" },
  "files": ["ui/**"],
  "ui": { "view": { "entry": "ui/index.html", "title": "Hello" } },
  "permissions": ["files.read"]
}
  • id — <автор>.<имя>: строчные латинские буквы, цифры и -, до 31 знака в каждой части.
  • version — версия вида 1.2.3.
  • title — до 60 знаков, description — до 500.
  • files — какие файлы входят в плагин; plugin.json входит всегда.
  • permissions — права: files.read, files.write, sessions, prompt, model.
  • Инструменты агента описывают в разделе agent, адреса для запросов — в network, поля настроек — в ui.settings.

В плагине может быть до 500 файлов, каждый до 5 МиБ, всего до 20 МиБ. Символические ссылки не допускаются, .git и node_modules в плагин не входят. Быстрее всего начать так: попросите агента, он соберёт и проверит заготовку.

Ограничения

  • Windows. Экран плагина работает, инструменты для агента — пока нет: «На Windows инструменты агента пока не работают. Экран будет работать.»
  • Linux. Для инструментов агента нужен bubblewrap — программа-песочница, внутри которой они работают. Поставить её можно командой sudo apt install bubblewrap, подробнее — на странице Ограничения агента. Без bubblewrap экран установки предупредит: «На этом компьютере нет bubblewrap. Инструменты агента не запустятся.»
  • Проект на сервере (SSH). Экран плагина открывается, но к файлам проекта у него доступа нет. Инструментов плагина у агента в таком проекте тоже нет.
  • Связка ключей. Системная связка ключей — хранилище паролей операционной системы. Обычно её нет только на Linux, когда на компьютере не отвечает служба паролей. Без неё DevMachine не сохраняет одобрения: «Связки ключей нет. Плагины работают до перезапуска DevMachine.»
  • Стоимость. В «Модулях» у инструментов своего плагина написано «Личный плагин. Стоимость не измеряется.»
  • Сеть. Страница и процесс плагина сами в сеть не выходят. Запросы отправляет DevMachine, и только на адреса из plugin.json: по https, а по http — только на локальные и внутренние адреса и с предупреждением.
  • Журнал. Вызовы инструментов и запросы плагина попадают в «Журнал действий», без содержимого и токенов. Подробнее — на странице Аварийная остановка и журнал действий.

Что дальше

Обновлено · Нашли неточность? Напишите на support@devmachine.ai или в Telegram.