CommitAI

КоммитАИ

CommitAI — это приложение с интерфейсом командной строки, которое автоматически генерирует сообщения о фиксации на основе результатов git diff. Он использует возможности API GPT-3 OpenAI для создания осмысленных и описательных сообщений о фиксации, что упрощает отслеживание изменений кода. С CommitAI вы можете сэкономить время и сосредоточиться на написании кода, а не на создании сообщений о коммитах.

Установить

$ npm install --global commitai

или

$ yarn global add commitai

Использование

$ npx commitai [OPTIONS]

или

$ commitai [OPTIONS]

Примечание. Для использования CommitAI у вас должен быть действительный ключ API OpenAI. Вы можете получить один ключ API OpenAI. После того, как у вас есть ключ 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 : не запрашивать подтверждение перед фиксацией.