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

Documentation Index

Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt

Use this file to discover all available pages before exploring further.

​
Обзор

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

​
Паттерн использования агентами

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

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

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

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

​
Многопользовательский (Multi-tenant) воркфлоу для агентов

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

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

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