DebugMate CLI

C/C++ 코드를 AI로 분석하고 디버깅하는 Linux 전용 CLI 도구

🚀 빠른 시작

1. 설치

# 시스템 요구사항 설치
sudo apt update
sudo apt install -y tmux inotify-tools gcc g++ build-essential python3 make

# Node.js 20+ 설치
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs

# CLI 설치
npm install -g @debugmate/cli

2. API 키 설정

방법 1: 환경 변수로 설정 (임시)

export GEMINI_API_KEY="your_api_key_here"
export GEMINI_BASE_URL="https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-pro:generateContent"

방법 2: CLI로 설정 (권장)

# API 키만 설정하면 됩니다 (BASE_URL은 자동으로 설정됨)
debug-mate status --set KEY=your_api_key_here

방법 3: 시스템 전역 설정 (영구)

# ~/.bashrc 또는 ~/.zshrc에 추가
echo 'export GEMINI_API_KEY="your_api_key_here"' >> ~/.bashrc
echo 'export GEMINI_BASE_URL="https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-pro:generateContent"' >> ~/.bashrc
source ~/.bashrc

API 키 발급 방법: Google AI Studio에서 무료로 발급받을 수 있습니다.

3. 사용하기

# 테스트 코드 생성 (test.c 파일 생성)
debug-mate generate

# tmux 분할 화면으로 디버깅 시작
debug-mate debug test.c

# 또는 파일명만 입력 (기본 명령어)
debug-mate test.c

🎯 사용법

기본 워크플로우

1. 시작: debug-mate debug test.c 또는 debug-mate test.c 실행
2. 왼쪽 패널: vi 편집기가 자동으로 열림 (50% 크기)
3. 코드 편집: vi에서 코드 수정
4. 저장: :w 명령어로 저장
5. 자동 분석: 오른쪽에서 자동으로 AI 분석 실행
6. 결과 확인: 오른쪽에서 AI 분석 결과 확인
7. 반복: 다시 편집 → 저장 → 자동 분석 반복

패널 크기 조절

# 기본 50:50 분할
debug-mate debug test.c

# 왼쪽 패널 크기 조절 (예: 30%)
debug-mate debug test.c --left 30

# 왼쪽 패널 크기 조절 (예: 70%)
debug-mate debug test.c --left 70

AI 분석 기능

• 자동 코드 분석: 파일 저장 시 자동으로 코드 분석 실행
• 문제점 진단: 코드의 버그, 메모리 누수, 성능 문제 등 자동 진단
• 개선 제안: 더 효율적인 코드로 개선하는 방법 제안
• 보안 검사: 보안 취약점 및 안전하지 않은 코드 패턴 검사

📋 주요 명령어

| 명령어 | 설명 | 예시 | |--------|------|------| | debug <file> | tmux 분할 화면으로 vi 편집기 + AI 분석 | debug-mate debug test.c | | generate | 테스트 코드 자동 생성 (test.c) | debug-mate generate | | status | 시스템 상태 및 설정 확인 | debug-mate status | | status --set | 환경변수 설정 | debug-mate status --set KEY=your_key_here | | info | 프로그램 정보 | debug-mate info | | --version | 버전 정보 표시 | debug-mate --version | | --help | 도움말 표시 | debug-mate --help |

🎯 주요 기능

• tmux 분할 화면: 왼쪽에서 vi 편집기, 오른쪽에서 AI 분석 결과 (기본 50:50 분할)
• 자동 파일 감시: 파일 저장 시 자동으로 AI 분석 실행
• AI 기반 분석: 코드의 문제점, 개선점, 보안 취약점 자동 진단
• 자동화된 워크플로우: 편집 → 저장 → 자동 분석 반복
• 테스트 코드 생성: 9가지 타입의 테스트 코드 자동 생성
• 간단한 CLI: 중복 없는 깔끔한 명령어 구조

⚠️ 요구사항

• OS: Linux (Ubuntu, Debian 등)
• Node.js: 20.x 이상
• 시스템 패키지: tmux, inotify-tools, gcc/g++, python3, make

🔧 트러블슈팅

tmux가 감지되지 않는 경우

sudo apt install -y tmux

inotify-tools 오류

sudo apt install -y inotify-tools

vi 편집기 사용법

# vi 기본 명령어
i          # 입력 모드
Esc        # 명령 모드
:w          # 파일 저장
:q          # 종료
:wq         # 저장 후 종료
:q!         # 저장하지 않고 종료

환경변수 설정 문제

# CLI로 환경변수 설정 (권장)
debug-mate status --set KEY=your_api_key_here

# 환경변수가 제대로 설정되었는지 확인
echo $GEMINI_API_KEY
echo $GEMINI_BASE_URL

# 또는 CLI로 확인
debug-mate status

Windows/macOS 사용자

• WSL2 (Windows Subsystem for Linux) 사용
• Linux 가상머신 사용
• GitHub Codespaces 사용

📖 자세한 사용법

# 도움말
debug-mate --help

# 특정 명령어 도움말
debug-mate debug --help
debug-mate generate --help
debug-mate status --help

🔗 링크

• GitHub
• Issues
• NPM

📄 라이선스

MIT