SparkUAPIЭкспериментальноllms.txtEnglish

Разделы · 2/11

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

Включить функцию, поставить sparku и отправить первое значение на островок.

Markdown ↗

1. Включить функцию#

Настройки SparkU → раздел «Интеграции» → внизу блок «Свои интеграции» (бейдж «ЭКСПЕРИМЕНТ») → «Включить…». Появится предупреждение: функция экспериментальная, возможно непредвиденное поведение и повышенный расход процессора и батареи. Кнопка «Включить» не срабатывает по Return — нужно нажать её явно.

После согласия в боковом списке настроек появляется раздел «Свои интеграции» и открывается мастер новой интеграции.

2. Поставить CLI#

В том же разделе настроек — строка «sparku» с кнопкой «Установить…». Она кладёт символическую ссылку /usr/local/bin/sparku, указывающую на утилиту внутри SparkU.app. Если /usr/local/bin недоступен для записи, macOS один раз спросит пароль администратора.

Проверить, что команда доступна:

sparku version

3. Создать интеграцию мастером#

В мастере — пять заготовок: «Задача с прогрессом», «Метрики сервера», «Таймер», «Статус сборки», «Список». Каждая уже содержит поля, индикатор, строку и карточку — остаётся дать название и адрес (slug) или принять предложенный. «Настрою сам» создаёт пустую интеграцию без полей.

Возьмём заготовку «Статус сборки» с адресом build. У неё уже есть поля stage (состояние), branch (текст), started (время), link (ссылка) и кнопка «Открыть» на карточке.

4. Скопировать токен#

В редакторе интеграции — раздел «Подключение»: строка export SPARKU_TOKEN_BUILD=… и готовые примеры на curl, Python, Node, Swift. Скопируйте экспорт и выполните его в терминале, из которого будете тестировать:

export SPARKU_TOKEN_BUILD=spk_ваш_токен

sparku сам найдёт эту переменную по адресу интеграции — передавать токен каждый раз вручную не нужно.

5. Первый push#

sparku push build stage=running branch=main started=+0s

На островке должен обновиться индикатор и строка плашки. Раскройте островок — увидите карточку «Статус сборки» с кнопкой «Открыть».

6. Проверить, что всё работает#

sparku doctor build

Команда по шагам печатает: есть ли сокет, отвечает ли SparkU, найден ли токен, существует ли интеграция и какие у неё поля. Если что-то не так — doctor укажет, на каком шаге.

7. Снять значения#

sparku end build

Очищает все значения интеграции — на островке для неё не останется данных (элементы с видимостью «Пока есть данные» пропадут).

То же самое через curl#

Без CLI, напрямую через UNIX-сокет:

curl --unix-socket ~/.sparku/run/api.sock \
  -H "Authorization: Bearer $SPARKU_TOKEN_BUILD" \
  -d '{"stage": "running", "branch": "main", "started": "+0s"}' \
  http://sparku/v1/integrations/build/fields

Снять значения:

curl --unix-socket ~/.sparku/run/api.sock -X DELETE \
  -H "Authorization: Bearer $SPARKU_TOKEN_BUILD" \
  http://sparku/v1/integrations/build/fields

Дальше#

  • Понятия — как устроены поля, островок, карточка и токены.
  • Типы полей — что можно присылать в push для каждого типа.
  • CLI sparku — все команды и коды выхода.