OpenBug CLI

Что такое OpenBug CLI?

OpenBug CLI — интеллектуальный инструмент командной строки для отладки запущенных приложений с помощью ИИ. Он сочетает интерактивного терминального помощника с локальным кластером, который захватывает логи во время работы сервисов, а затем использует эти логи и вашу кодовую базу для ответов на вопросы по отладке.

Основная цель — сократить переключение контекста между поведением во время выполнения (логами) и исходным кодом. Вместо ручного поиска по нескольким терминалам и файлам вы можете задавать вопросы о происходящем, и CLI коррелирует релевантные логи с локально доступным кодом.

Ключевые возможности

• Интерактивный ИИ-помощник в терминале (debug): Запустите помощника в одном терминале и задавайте вопросы о проблемах по мере работы сервисов.
• Автоматический захват и потоковая передача логов: При запуске сервисов с debug <command> OpenBug передаёт логи в локальный кластер для использования в ответах ИИ.
• Поиск по кодовой базе на естественном языке: Помощник ищет в вашей кодовой базе в ответ на вопросы, например, где реализован определённый сценарий.
• Отладка нескольких сервисов через общий локальный кластер: Запускайте разные сервисы в отдельных терминалах; все подключаются к одному кластеру, чтобы ИИ мог отслеживать проблемы по всему стеку.
• Локальный доступ и выборное обмена данными: Кодовая база доступна локально и не загружается; на сервер отправляются только конкретные фрагменты, запрошенные ИИ, а логи передаются только при необходимости.
• Аутентифицированные запросы с личным API-ключом: CLI аутентифицирует запросы с помощью вашего API-ключа (как описано в процессе настройки).

Как использовать OpenBug CLI

1. Установите CLI с помощью:

   npm install -g @openbug/cli
   

2. Запустите ИИ-помощника в Терминале 1:

   debug
   

   Вас попросят войти и вставить API-ключ из приложения OpenBug.
3. Запустите сервисы с включённой отладкой в других терминалах. Примеры из репозитория:

   debug npm run dev
   debug python app.py
   debug docker-compose up
   

4. Задавайте вопросы по отладке в Терминале 1 во время работы сервисов. Помощник анализирует захваченные логи и ищет в кодовой базе, чтобы дать целевые рекомендации.

Если вы тестируете без настройки, проект также предлагает интерактивную демо-версию, которая разбирает отладку трёх реалистичных багов.

Сценарии использования

• Диагностика сбоев эндпоинта в локальной разработке: Задайте, например, «Почему не работает auth?», пока работает бэкенд; помощник сослался на релевантные логи и найдёт логику валидации.
• Отслеживание проблем по нескольким сервисам: Запустите бэкенд и фронтенд (или несколько бэкендов) в отдельных терминалах с debug ...; ИИ использует логи с нескольких сервисов, чтобы объяснить распространение ошибки.
• Поиск точек реализации неизвестного поведения: Используйте вопросы на естественном языке вроде «Где обрабатываются webhook'и платежей?», чтобы помощник нашёл в локальном репозитории место реализации.
• Расследование несоответствий данных во время выполнения: Когда логи указывают на несоответствия схем или ошибки конфигурации, попросите ИИ связать строки логов с соответствующими путями кода.
• Отладка незнакомых кодовых баз без поиска в интернете: Помощник ищет в реальной локальной кодовой базе, а не в интернете по общим рекомендациям.

FAQ

• Загружает ли OpenBug всю мою кодовую базу? Нет. В документации указано, что кодовая база доступна локально и никогда не загружается; на сервер отправляются только конкретные фрагменты кода, запрошенные ИИ.

• Когда OpenBug отправляет логи на сервер? Логи передаются на сервер только когда ИИ нужны для ответа на ваши вопросы.

• Как OpenBug поддерживает отладку по нескольким сервисам? Через общий локальный кластер: запускайте несколько сервисов в разных терминалах с debug <command>, и они все подключаются к одному кластеру, чтобы ИИ мог коррелировать логи по стеку.

• Могу ли я развернуть сервер OpenBug самостоятельно? Да. Репозиторий описывает подход к self-hosting: клонируйте репозиторий сервера, настройте его с вашим API-ключом OpenAI, затем укажите CLI на ваш сервер через переменные окружения вроде WEB_SOCKET_URL и API_BASE_URL.

Альтернативы

• Локальная отладка с логами + текстовым поиском (например, grep/ripgrep) + инструментами IDE: Похожие входные данные (логи и исходный код), но рабочий процесс полагается на ручную корреляцию и навигацию вместо AI-помощника с разговорным интерфейсом.
• Платформы для производительности/наблюдаемости приложений (логи и дашборды трассировки): Полезны для просмотра и запросов данных выполнения, но обычно не предоставляют отладку на естественном языке с учетом кода из локального репозитория.
• AI-помощники для кода, ориентированные на Q&A по репозиторию (без захвата логов выполнения): Могут отвечать на вопросы о структуре кода, но не захватывают автоматически логи от запущенных сервисов для обоснования ответов поведением во время выполнения.