CommitAI

CommitAI

CommitAI는 git diff의 출력을 기반으로 커밋 메시지를 자동으로 생성하는 명령줄 인터페이스 애플리케이션입니다. OpenAI의 GPT-3 API 기능을 활용하여 의미 있고 설명이 포함된 커밋 메시지를 생성하므로 코드 변경 사항을 더 쉽게 추적할 수 있습니다. CommitAI를 사용하면 커밋 메시지를 작성하는 대신 시간을 절약하고 코드 작성에 집중할 수 있습니다.

설치하다

$ npm install --global commitai

또는

$ yarn global add commitai

용법

$ npx commitai [OPTIONS]

또는

$ commitai [OPTIONS]

참고: CommitAI를 사용하려면 유효한 OpenAI API 키가 있어야 합니다. 하나의 OpenAI API 키를 얻을 수 있습니다. API 키를 얻은 후에는 이를 환경 변수로 설정하거나 CommitAI를 사용하기 전에 다음 명령을 실행해야 합니다.

OPENAI_API_KEY=sk- < your-api-key > commitai

또는 .bashrc 또는 .zshrc 파일에서 환경 변수로 내보냅니다.

 export OPENAI_API_KEY=sk- < your-api-key > 

옵션

• -h, --help : 도움말 표시
• -v, --version : 버전 번호 표시
• -n [number], --numberOfCommitMessages [number] : 생성할 커밋 메시지 수
• -e, --edit : 커밋하기 전에 커밋 메시지를 편집합니다.
  • --no-e, --no-edit : 커밋하기 전에 커밋 메시지를 편집하라는 메시지를 표시하지 않습니다.
• -c, --confirmation : 커밋하기 전에 커밋 메시지를 확인합니다.
  • --no-c, --no-confirmation : 커밋하기 전에 확인 메시지를 표시하지 않습니다.