개발 도구 (Development Tools)/Git

자동 커밋 메시지 생성을 위한 aicommits

BiCute 2023. 6. 15. 08:00
반응형

매번 commit 메시지를 뭘 적어야할지 망설이는 그대들을 위한 Open AI 사용법.

 

 

aicommits

aicommits는 AI로 git 커밋 메시지를 작성하는 CLI 입니다.

사용 방법은 공식 페이지를 통해 그대로 따라만 해도 되지만, 조금 더 간단히 정리해 보았습니다.

 

 

필요한 것

OpenAI의 API keys를 사용하기때문에 공식 페이지에서 API Keys를 발급 받을 필요가 있습니다.

API 키 발급은 이곳에서 >

 

② 이전에는 무료로 사용 가능했지만, 2023.04.01 이후라면 지불 방법에 대한 설정이 필요합니다.

Billing 페이지에서 신용카드를 등록해서 결제가 가능하도록 할 필요가 있습니다.

※ 저의 경험으로 판단해보자면 AI를 이용한 commit 1회당 약 $0.005048 정도 사용되는것 같습니다.

 

 

사용 방법

(1) "aicommits" 패키지를 설치해야 합니다.

(Node.js는 기본적으로 설치되어있다고 가정)

npm install -g aicommits

 

Mac의 경우 설치가 안된다면 앞에 sudo를 붙여주세요

sudo npm install -g aicommits

 

(2) 다음으로, OpenAI에서 발급한 API 키를 사용하여 "aicommits"를 설정해야 합니다.

터미널에서 다음 명령어를 실행하여 API 키를 설정하세요

aicommits config set OPENAI_KEY=********************

위 명령어에서 ******************** 부분에 발급받은 API 키를 입력해야 합니다.

 

 

(3) 이제 자동 커밋을 위한 별칭(alias)을 설정해봅시다.

터미널에서 다음 명령어를 실행하세요

git config --global alias.ac '!git add -A && aicommits -a'

이 명령어는 git ac라고 입력하면 자동으로 변경된 파일들을 스테이징하고, 커밋하고, 푸시해줍니다.

 

이제 모든 설정이 완료되었습니다. 변경된 내용을 커밋하고 푸시하려면 터미널에서 다음 명령어를 사용하세요

git ac

 

AI가 작업한 내용을 기반으로 커밋 메시지를 제안해 줍니다.

 

Yes를 선택합니다.

이렇게 하면 "aicommits" 패키지가 실행되어 커밋 메시지를 자동으로 생성하고, 변경된 내용을 스테이징하고 커밋하고, 푸시까지 완료해줍니다.

 

No를 선택하게 되면 새로운 메시지를 제안받을 수도 있습니다.

 

이제 매번 커밋 메시지를 작성하는 수고를 덜 수 있게 되었습니다.

"aicommits" 패키지를 사용하면 더욱 효율적으로 Git 작업을 처리할 수 있습니다.

 

 

주의사항

설정을 통해 어느정도 커밋 메시지의 제약은 가능하지만,

회사나 업무에서 사용할 경우 그 그룹만의 커밋 방식이 있을테니 주의하시기 바랍니다.

 

저는 개인용 작업에서 사용중인데 매우 만족중입니다.

 

 

반응형