Перейти к основному содержанию

​
Общая информация

Nudgen CLI спроектирован с использованием подхода AI-First. Хотя он предлагает удобный интерфейс для людей, каждая команда оптимизирована для взаимодействия между машинами.

​
Агентный паттерн

Когда ИИ-агент (например, Claude, GPT или специализированный агент автоматизации) использует CLI, он должен следовать этим правилам:
  1. Вывод JSON: Добавляйте --json к каждой команде для получения структурированных данных.
  2. Контекст команды: Всегда проверяйте активную команду перед выполнением операций.
  3. Неинтерактивность: Используйте соответствующие флаги, чтобы избежать интерактивных запросов.

​
Автоматизация через JSON

Все команды вывода списков и статусов поддерживают флаг --json. Это возвращает чистую структуру JSON вместо отформатированной таблицы. 
# Получить список кампаний в JSON
nudgen campaigns list --json

# Получить список контактов активной команды
nudgen contacts list --json

​
Работа с несколькими командами для агентов

Поскольку Nudgen поддерживает работу в нескольких командах, агент должен убедиться, что он работает в правильном окружении перед созданием или изменением ресурсов. Рекомендуемый рабочий процесс:
  1. Проверка текущей команды: 
    nudgen teams current --json
  2. Переключение команды (если нужно): Если id в предыдущем шаге не совпадает с целевым, выполните: 
    nudgen teams switch <target-team-id>
  3. Выполнение команд: Продолжайте работу с campaigns, contacts или brand.

​
Лучшие практики для разработчиков агентов

  • Обработка ошибок: Отслеживайте код выхода (Exit Code). Ненулевой код означает ошибку (валидация, сеть или аутентификация).
  • Лимиты запросов (Rate Limiting): CLI взаимодействует с API Nudgen. Убедитесь, что ваши скрипты корректно обрабатывают ограничения частоты запросов.
  • Режим тишины: Если для команды не предусмотрен флаг обхода какого-либо запроса, убедитесь, что агент может корректно обрабатывать потоки stdout/stderr, не зависая в ожидании ввода.