Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/in-jun/ai-commit
개발에만 집중하세요! AI-Commit이 당신의 코드 변경사항을 분석하여 명확하고 표준화된 커밋 메시지를 자동으로 생성합니다. 더 이상 커밋 메시지 작성에 시간을 낭비하지 마세요.
https://github.com/in-jun/ai-commit
ai automation commit-message gemini gemini-api git git-commit git-extension
Last synced: 8 days ago
JSON representation
개발에만 집중하세요! AI-Commit이 당신의 코드 변경사항을 분석하여 명확하고 표준화된 커밋 메시지를 자동으로 생성합니다. 더 이상 커밋 메시지 작성에 시간을 낭비하지 마세요.
- Host: GitHub
- URL: https://github.com/in-jun/ai-commit
- Owner: in-jun
- Created: 2024-10-30T15:58:35.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T06:12:12.000Z (4 months ago)
- Last Synced: 2024-12-20T11:28:26.896Z (2 months ago)
- Topics: ai, automation, commit-message, gemini, gemini-api, git, git-commit, git-extension
- Language: Go
- Homepage:
- Size: 22.5 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ai-commit
[](https://goreportcard.com/report/github.com/in-jun/ai-commit)
> 🤖 AI 기반 git 커밋 메시지 생성 도구
---
## 📋 목차
- [Features](#-features)
- [Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [API Key Setup](#api-key-setup)
- [Usage](#-usage)
- [Quick Start](#quick-start)
- [Examples](#examples)
- [Configuration](#configuration)
- [Commands](#commands)
- [Advanced](#-advanced)
- [Best Practices](#best-practices)
- [Templates](#templates)
- [Customization](#customization)
- [Troubleshooting](#-troubleshooting)
- [FAQs](#-faqs)
---
## ✨ Features
ai-commit은 Gemini AI를 활용하여 git 커밋 메시지를 자동으로 생성하는 CLI 도구입니다.
### 핵심 기능
- 🎯 **스마트 분석**
- 스테이징된 변경사항 자동 분석
- 프로젝트 컨텍스트 이해
- 이전 커밋 스타일 학습
- 🤖 **AI 기반 생성**
- Conventional Commits 형식 준수
- 멀티 라인 설명 자동 생성
- 변경 사항에 대한 상세한 설명
- ✏️ **메시지 편집**
- 생성된 메시지 검토 및 수정
- 선호하는 텍스트 에디터 사용
- 커밋 전 완벽한 메시지 조정
- 📝 **커스터마이징**
- 템플릿 기반 커밋 타입
- 다국어 지원
- 설정 가능한 옵션들
- ⚡️ **개발자 경험**
- 간단한 CLI 인터페이스
- 빠른 설치와 설정
- 직관적인 사용법
---
## 🚀 Getting Started
### Prerequisites
시작하기 전에 다음 요구사항을 확인하세요:
| 요구사항 | 최소 버전 | 설치 방법 |
| ------------- | --------- | -------------------------------------------- |
| Go | 1.21+ | [공식 사이트](https://go.dev/dl/) |
| Git | 2.0+ | [공식 사이트](https://git-scm.com/downloads) |
| Gemini API 키 | - | [발급 방법](#api-key-setup) |
### Installation
**Windows**
1. Go 설치
```powershell
# 1. Go 설치 파일 다운로드
# https://go.dev/dl/ 에서 Windows MSI 설치 파일 다운로드
# 2. 설치 파일 실행 후 기본 옵션으로 설치
# 3. PowerShell 또는 명령 프롬프트를 새로 열어 설치 확인
go version
```
2. Git 설치
```powershell
# 1. Git 설치 파일 다운로드
# https://git-scm.com/download/windows 에서 다운로드
# 2. 설치 파일 실행 후 기본 옵션으로 설치
# 3. PowerShell 또는 명령 프롬프트를 새로 열어 설치 확인
git --version
```
3. PATH 설정
```powershell
# PowerShell 관리자 권한으로 실행
$env:Path += ";$env:USERPROFILE\go\bin"
[Environment]::SetEnvironmentVariable(
"Path",
[Environment]::GetEnvironmentVariable("Path", [EnvironmentVariableTarget]::User) + ";$env:USERPROFILE\go\bin",
[EnvironmentVariableTarget]::User
)
```
4. ai-commit 설치
```powershell
go install github.com/in-jun/ai-commit@latest
```
**Linux/Ubuntu**
```bash
# 1. Go 설치
sudo apt install golang-go
# 2. PATH 설정
echo 'export PATH=$PATH:~/go/bin' >> ~/.bashrc
source ~/.bashrc
# 3. ai-commit 설치
go install github.com/in-jun/ai-commit@latest
```
**macOS**
```bash
# 1. Go 설치
brew install go
# 2. PATH 설정
echo 'export PATH=$PATH:~/go/bin' >> ~/.zshrc
source ~/.zshrc
# 3. ai-commit 설치
go install github.com/in-jun/ai-commit@latest
```
### API Key Setup
1. [Google AI Studio](https://aistudio.google.com/app/apikey) 접속
2. Google 계정으로 로그인
3. 'API 키 관리' → '새 API 키 만들기' 클릭
4. 생성된 API 키 복사
---
## 📖 Usage
### Quick Start
```mermaid
graph LR
A[변경사항 스테이징] --> B[ai-commit 실행]
B --> C{메시지 검토}
C -->|승인| D[커밋 완료]
C -->|수정| E[메시지 편집]
C -->|거절| F[취소]
E --> D
```
1. **API 키 설정**
```bash
# 방법 1: 환경 변수
# Windows (PowerShell)
$env:API_KEY="your-gemini-api-key"
ai-commit
# Linux/macOS
API_KEY="your-gemini-api-key" ai-commit
# 방법 2: 설정 파일
ai-commit init # 프롬프트에서 API 키 입력
```
2. **커밋 메시지 생성**
```bash
git add .
ai-commit
```
### Examples
**기능 추가 예시**
```bash
$ git add feature.go
$ ai-commit
=== Generated Commit Message ===
feat: 사용자 인증 미들웨어 구현
JWT 기반 인증 시스템 추가
- 토큰 검증 로직 구현
- 보호된 라우트에 미들웨어 적용
- 401, 403 에러 핸들링 추가
What would you like to do?
[Y]es: Commit with this message
[E]dit: Edit the message
[N]o: Cancel commit
Choice [Y/e/n]:
```
**버그 수정 예시**
```bash
$ git add bug-fix.go
$ ai-commit
=== Generated Commit Message ===
fix: 메모리 누수 문제 해결
백그라운드 작업자의 임시 파일 정리 로직 개선
- 작업 실패 시에도 정리 보장
- 리소스 해제 순서 최적화
- 모니터링 지표 추가
What would you like to do?
[Y]es: Commit with this message
[E]dit: Edit the message
[N]o: Cancel commit
Choice [Y/e/n]:
```
**메시지 편집 예시**
```bash
$ git add feature.go
$ ai-commit
=== Generated Commit Message ===
feat: 사용자 인증 구현
JWT 인증 시스템 추가
- 토큰 검증
- 미들웨어 적용
- 에러 처리
What would you like to do?
[Y]es: Commit with this message
[E]dit: Edit the message
[N]o: Cancel commit
Choice [Y/e/n]: e
# 선택한 에디터에서 메시지 편집 후 저장
```
### Configuration
설정 파일 위치:
- Windows: `%USERPROFILE%\.ai-commit\config.yaml`
- Linux/macOS: `~/.ai-commit/config.yaml`
```yaml
# API 설정
api_key: "your-api-key"
# 성능 설정
max_diff_size: 10000 # 최대 diff 크기 (바이트)
history_depth: 5 # 분석할 이전 커밋 수
# UI 설정
color_enabled: true # 컬러 출력 활성화
# 커밋 템플릿
templates:
- prefix: "feat" # 새 기능
description: "새로운 기능 추가"
- prefix: "fix" # 버그 수정
description: "버그 수정"
# ... 추가 템플릿
```
### Commands
| 명령어 | 설명 | 사용 예시 |
| ---------------- | ---------------- | ---------------- |
| `ai-commit` | 커밋 메시지 생성 | `ai-commit` |
| `ai-commit init` | 설정 초기화/갱신 | `ai-commit init` |
| `ai-commit -h` | 도움말 표시 | `ai-commit -h` |
| `ai-commit -v` | 버전 정보 표시 | `ai-commit -v` |
| 옵션 | 설명 | 사용 시점 |
| -------------- | --------------------- | ----------------------- |
| `Y` 또는 Enter | 생성된 메시지로 커밋 | 메시지가 적절할 때 |
| `E` | 메시지 편집 모드 진입 | 메시지 수정이 필요할 때 |
| `N` | 커밋 취소 | 메시지가 부적절할 때 |
---
## 🔧 Advanced
### Best Practices
| 실천 사항 | 설명 | 예시 |
| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------- |
| 작은 단위로 커밋 | • 하나의 논리적 변경사항만 포함
• 관련 없는 변경사항은 분리 | `bash# 좋은 예git add auth/ai-commit# 나쁜 예git add . # 여러 기능 변경` |
| 메시지 검토 | • 자동 생성된 메시지 검증
• 필요시 메시지 편집으로 정확도 향상 | `bash# 메시지 검토 후 수정What would you like to do?Choice [Y/e/n]: e` |
### Templates
현재 기본 커밋 타입:
| Type | Description | 사용 시점 |
| -------- | ---------------- | ------------------- |
| feat | 새로운 기능 추가 | 기능 개발 완료시 |
| fix | 버그 수정 | 버그 해결시 |
| docs | 문서 수정 | 문서 작업시 |
| style | 코드 스타일 변경 | 포맷팅, 세미콜론 등 |
| refactor | 코드 리팩토링 | 구조 개선시 |
| test | 테스트 추가/수정 | 테스트 작업시 |
| chore | 기타 변경사항 | 빌드 스크립트 등 |
### Customization
커스텀 템플릿 예시:
```yaml
templates:
- prefix: "feature"
description: "새로운 기능 개발"
- prefix: "bugfix"
description: "버그 수정"
- prefix: "hotfix"
description: "긴급 수정"
```
---
## 🔍 Troubleshooting
### 공통 문제
**command not found: ai-commit**
1. Go 설치 확인
```bash
go version
```
2. PATH 설정 확인
```bash
# Windows (PowerShell)
echo $env:Path
# Linux/macOS
echo $PATH | grep go
```
3. Go bin 디렉토리 확인
```bash
# Windows
dir %USERPROFILE%\go\bin
# Linux/macOS
ls ~/go/bin
```
### Windows 특정 문제
1. `go install` 실패 시
```powershell
# Go 환경 변수 확인
go env GOPATH
go env GOBIN
# Go 모듈 캐시 정리
go clean -modcache
```
2. PATH 설정 문제
```powershell
# 현재 PATH 확인
echo $env:Path
# 사용자 환경 변수에서 수동으로 추가
# 제어판 > 시스템 > 고급 시스템 설정 > 환경 변수
# 사용자 변수의 Path에 %USERPROFILE%\go\bin 추가
```
3. Git Bash 사용 시
```bash
# ~/.bashrc 파일 생성 또는 편집
echo 'export PATH=$PATH:~/go/bin' >> ~/.bashrc
source ~/.bashrc
```
4. 권한 문제
```powershell
# PowerShell을 관리자 권한으로 실행
# 실행 정책 확인
Get-ExecutionPolicy
# 필요시 실행 정책 변경
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
```
### Linux/macOS 특정 문제
1. PATH 재설정
```bash
# Linux
echo 'export PATH=$PATH:~/go/bin' >> ~/.bashrc
source ~/.bashrc
# macOS
echo 'export PATH=$PATH:~/go/bin' >> ~/.zshrc
source ~/.zshrc
```
2. 권한 문제
```bash
# 실행 권한 확인
ls -l ~/go/bin/ai-commit
# 권한 부여
chmod +x ~/go/bin/ai-commit
```
### API 키 문제
1. 환경 변수 확인
```bash
# Windows (PowerShell)
echo $env:API_KEY
# Linux/macOS
echo $API_KEY
```
2. 설정 파일 확인
```bash
# Windows
type %USERPROFILE%\.ai-commit\config.yaml
# Linux/macOS
cat ~/.ai-commit/config.yaml
```
3. 설정 초기화
```bash
ai-commit init
```
---
## 💡 FAQs
**Q: API 키는 어디서 얻나요?**
- [Google AI Studio](https://aistudio.google.com/app/apikey)에서 발급
- 무료로 사용 가능
- 일일 요청 제한 있음
**Q: 오프라인에서도 사용 가능한가요?**
- 현재 버전은 Gemini API 연결 필요
- 오프라인 모드는 향후 지원 예정
**Q: 다른 언어는 지원하나요?**
- 프로젝트의 커밋 히스토리 기반으로 언어 자동 선택
- 영어/한국어 기본 지원
**Q: 어떤 에디터로 메시지를 편집할 수 있나요?**
Windows:
- 기본 메모장
- Visual Studio Code
- Notepad++
- Git 설치 시 설정된 기본 에디터
Linux/macOS:
- vim
- nano
- Visual Studio Code
- 시스템의 기본 에디터(VISUAL/EDITOR 환경변수)
설정 방법:
```bash
# Windows (PowerShell)
$env:EDITOR="code --wait"
# Linux/macOS
export EDITOR="vim"
```
**Q: 커밋 메시지 형식을 커스터마이즈할 수 있나요?**
- 설정 파일에서 템플릿 수정 가능
- 기업/팀 커밋 컨벤션에 맞춰 조정 가능
- 커스텀 prefix와 description 추가 가능
**Q: 대규모 변경사항도 처리 가능한가요?**
- 기본적으로 10,000바이트까지의 diff 처리
- 설정에서 `max_diff_size` 조정 가능
- 대규모 변경은 작은 단위로 나누어 커밋 권장
---
**[맨 위로 올라가기](#ai-commit)**
Made with ❤️ by [in-jun](https://github.com/in-jun)