xenogit

즉각적인 Git 커밋 메시지를 위한 CLI 친구입니다.

소개

Xenogit 은 OpenAI GPT를 사용하여 기존 커밋 사양을 따르는 커밋 메시지를 빠르게 생성하는 유용한 명령줄 도우미입니다. 커밋 작성에 시간을 낭비하지 말고 손쉽게 Git 저장소 관리를 시작하세요!

️시작하기

설치 중

Xenogit을 설치하는 방법에는 두 가지가 있습니다.

1. Composer 사용: 다음 명령을 실행하여 Xenogit을 전역적으로 설치합니다.

composer global require dotninth/xenogit

2. GitHub에서 다운로드: GitHub의 릴리스 페이지를 방문하여 적절한 바이너리를 다운로드하세요.

용법

Xenogit을 설치한 후 프로그램을 실행하여 사용 가능한 모든 옵션을 사용할 수 있습니다.

$ xenogit

  Xenogit  v1.3.2

  USAGE:  < command > [options] [arguments]

  commit         Automatically generate commit messages

  config:api-key Configure the API key in the .env file

API 키

Xenogit이 제대로 작동하려면 OpenAI의 API 키가 필요합니다. API 키를 제공하는 방법에는 두 가지가 있습니다.

1. xenogit config:api-key <your-api-key> 명령을 사용하세요.

2. 환경 변수 사용: OpenAI API 키가 포함된 API_KEY 라는 환경 변수를 생성합니다.

3. Xenogit 바이너리가 있는 디렉터리에 .env 라는 파일을 만듭니다. 이 파일은 환경 변수를 저장하는 데 사용됩니다. .env 파일에 다음 줄을 추가하고 <YOUR_API_KEY> 실제 OpenAI API 키로 바꿉니다.

API_KEY= < YOUR_API_KEY > 

지불

Xenogit을 사용하면 OpenAI API에 요청할 때마다 비용이 발생합니다. Xenogit은 GPT-4보다 약 15배 저렴한 공식 ChatGPT( gpt-3.5-turbo-16k ) 모델을 사용합니다. OpenAI 계정에 Xenogit 사용 비용을 지불할 만큼 충분한 자금이나 크레딧이 있는지 확인하세요.

OpenAI 서비스 사용 가격에 대해 자세히 알아보려면 OpenAI 가격 페이지에서 가격 페이지를 확인하세요.

기여하다

Xenogit에 기여하시는 것을 환영합니다! 원활한 협업을 위해 프로젝트에 기여할 때 다음 지침을 따르십시오.

1. 저장소를 포크하고 로컬 머신에 복제합니다.
2. 기여를 위한 새 브랜치를 만듭니다: git checkout -b my-contribution .
3. 변경하여 코드가 프로젝트의 코딩 스타일과 규칙을 따르는지 확인하세요.
4. 변경 사항을 철저히 테스트하십시오.
5. Conventional Commit 사양에 따라 설명이 포함된 커밋 메시지로 변경 사항을 커밋합니다.
6. 분기를 포크된 저장소 `git push Origin my-contribution'으로 푸시합니다.
7. Xenogit 저장소의 `main' 브랜치에 대해 풀 요청을 엽니다.
8. 관련 정보나 맥락과 함께 끌어오기 요청의 변경 사항에 대한 명확하고 자세한 설명을 제공하세요.

Xenogit에 기여함으로써 귀하는 MIT 라이센스에 따라 귀하의 기여를 공개하는 데 동의하게 됩니다.

특허

Xenogit은 MIT 라이선스에 따라 출시됩니다. 필요에 따라 자유롭게 수정하고 배포하시기 바랍니다.