UStackUStack
OpenBug CLI icon

OpenBug CLI

OpenBug CLI는 실시간 디버깅을 돕는 AI 보조 CLI입니다. 실행 중 로그를 캡처하고 로컬 코드베이스를 검색해 대화형 터미널에서 답변합니다.

OpenBug CLI

OpenBug CLI란?

OpenBug CLI는 AI 보조를 통해 실행 중인 애플리케이션을 디버깅하는 지능형 명령줄 도구입니다. 대화형 터미널 어시스턴트를 로컬 클러스터와 연동해 서비스 실행 중 로그를 캡처한 후, 해당 로그와 코드베이스를 활용해 디버깅 질문을 답변합니다.

핵심 목적은 런타임 동작(로그)과 소스 코드 간의 컨텍스트 전환을 줄이는 것입니다. 여러 터미널과 파일을 수동으로 grep하는 대신, 무슨 일이 일어나고 있는지 질문하면 CLI가 관련 로그를 로컬에서 접근 가능한 코드와 상관지어 줍니다.

주요 기능

  • 대화형 터미널 AI 어시스턴트 (debug): 한 터미널에서 어시스턴트를 시작해 서비스 실행 중 문제에 대해 질문합니다.
  • 자동 로그 캡처 및 스트리밍: debug <command>로 서비스를 실행하면 OpenBug이 로그를 로컬 클러스터로 스트리밍해 AI 응답에 활용합니다.
  • 로컬 코드베이스 전반의 자연어 코드 검색: 주어진 동작이 어디 구현되었는지 등의 질문에 코드베이스를 검색합니다.
  • 공유 로컬 클러스터를 통한 다중 서비스 디버깅: 별도 터미널에서 서로 다른 서비스를 실행; 모두 동일 클러스터에 연결되어 AI가 스택 전반의 문제를 추적합니다.
  • 로컬 우선 접근 및 선택적 데이터 공유: 코드베이스는 로컬에서 접근하며 업로드되지 않음; AI가 쿼리한 특정 스니펫만 서버로 전송되고, 로그는 답변 필요 시에만 스트리밍됩니다.
  • 개인 API 키를 사용한 인증 요청: CLI가 설정 흐름에서 설명된 API 키로 요청을 인증합니다.

OpenBug CLI 사용법

  1. CLI 설치:
    npm install -g @openbug/cli
    
  2. 터미널 1에서 AI 어시스턴트 시작:
    debug
    
    OpenBug 앱에서 API 키를 복사해 로그인하라는 프롬프트가 나타납니다.
  3. 다른 터미널에서 디버깅 활성화해 서비스 실행. 리포지토리 예시:
    debug npm run dev
    debug python app.py
    debug docker-compose up
    
  4. 서비스 실행 중 터미널 1에서 디버깅 질문. 어시스턴트가 캡처된 로그를 분석하고 코드베이스를 검색해 타겟팅된 인사이트를 제공합니다.

설정 없이 테스트 시 프로젝트에서 3개의 현실적인 버그 디버깅을 안내하는 인터랙티브 데모를 제공합니다.

사용 사례

  • 로컬 개발 중 엔드포인트 실패 원인 진단: 백엔드 실행 중 “인증이 왜 실패하나?”처럼 질문; 어시스턴트가 관련 로그를 참조하고 검증 로직을 찾아줍니다.
  • 다중 서비스 간 문제 추적: debug ...로 백엔드와 프론트엔드(또는 다중 백엔드)를 별도 터미널에서 실행; AI가 여러 서비스 로그를 활용해 오류 전파를 설명합니다.
  • 알 수 없는 동작의 구현 지점 찾기: “결제 웹훅을 어디서 처리하나?” 같은 자연어 질문으로 어시스턴트가 로컬 리포지토리를 검색합니다.
  • 런타임에서 보이는 데이터 불일치 조사: 로그가 스키마 불일치나 구성 오류를 암시할 때 AI에 로그 라인을 관련 코드 경로와 상관지어 달라고 요청합니다.
  • 인터넷 검색 없이 낯선 코드베이스 디버깅: 어시스턴트가 인터넷의 일반 가이드 대신 실제 로컬 코드베이스를 검색합니다.

자주 묻는 질문

  • OpenBug이 전체 코드베이스를 업로드하나요? 아니요. 문서에 명시된 대로 코드베이스는 로컬에서 접근되며 절대 업로드되지 않습니다; AI가 쿼리한 특정 코드 스니펫만 서버로 전송됩니다.

  • OpenBug이 언제 로그를 서버로 보내나요? AI가 질문에 답변할 때만 로그를 서버로 스트리밍합니다.

  • OpenBug이 다중 서비스 디버깅을 어떻게 지원하나요? 공유 로컬 클러스터를 사용: debug <command>로 다른 터미널에서 여러 서비스를 실행하면 모두 동일 클러스터에 연결되어 AI가 스택 전반의 로그를 상관지을 수 있습니다.

  • OpenBug 서버를 셀프 호스팅할 수 있나요? 네. 리포지토리에 셀프 호스팅 방법이 설명되어 있습니다: 서버 리포지토리를 클론하고 OpenAI API 키로 구성한 후, WEB_SOCKET_URLAPI_BASE_URL 같은 환경 변수로 CLI를 서버로 연결합니다.

대안

  • 로그 + 텍스트 검색(예: grep/ripgrep) + IDE 도구를 활용한 로컬 디버깅: 유사한 입력(로그와 소스 코드)을 사용하지만, 워크플로는 AI 보조 대화형 인터페이스가 아닌 수동 상관관계와 탐색에 의존합니다.
  • 애플리케이션 성능/관찰성 플랫폼(로그 및 추적 대시보드): 런타임 데이터를 보고 쿼리하는 데 유용하지만, 로컬 리포지토리에서 자연어 기반 코드 인식 디버깅을 제공하지 않습니다.
  • 런타임 로그 캡처 없이 리포지토리 Q&A에 초점을 맞춘 AI 코드 어시스턴트: 코드 구조에 대한 질문을 답할 수 있지만, 실행 중인 서비스의 로그를 자동 캡처해 런타임 동작에 기반한 답변을 제공하지 않습니다.
OpenBug CLI | UStack