xenogit

Ваш помощник по CLI для мгновенных сообщений о коммитах Git.

Введение

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 требуется ключ API от OpenAI. Есть два варианта предоставления ключа API:

1. Используйте команду xenogit config:api-key <your-api-key> .

2. Использование переменной среды: создайте переменную среды с именем API_KEY , которая будет содержать ваш ключ API OpenAI.

3. Создайте файл с именем .env в каталоге, где находится двоичный файл Xenogit. Этот файл будет использоваться для хранения переменных среды. В файл .env добавьте следующую строку, заменив <YOUR_API_KEY> фактическим ключом API OpenAI:

API_KEY= < YOUR_API_KEY > 

Оплата

Использование Xenogit будет стоить вам денег за каждый запрос к OpenAI API. Xenogit использует официальную модель ChatGPT ( gpt-3.5-turbo-16k ), которая стоит примерно в 15 раз дешевле, чем GPT-4. Убедитесь, что на вашей учетной записи OpenAI достаточно средств или кредитов для оплаты использования Xenogit.

Чтобы узнать больше о цене на использование услуг OpenAI, посетите страницу цен на странице цен OpenAI.

Способствовать

Приглашаем вас внести свой вклад в Xenogit! Для беспрепятственного сотрудничества, пожалуйста, следуйте этим правилам при участии в проекте:

1. Создайте форк репозитория и клонируйте его на свой локальный компьютер.
2. Создайте новую ветку для вашего вклада: git checkout -b my-contribution .
3. Внесите изменения, убедившись, что код соответствует стилю и соглашениям проекта.
4. Тщательно протестируйте свои изменения.
5. Зафиксируйте изменения с помощью описательного сообщения о фиксации в соответствии со спецификацией стандартной фиксации.
6. Отправьте свою ветку в раздвоенный репозиторий: `git push origin my-contribution'.
7. Откройте запрос на включение в «основную» ветку репозитория Xenogit.
8. Предоставьте четкое и подробное описание ваших изменений в запросе на включение, а также любую соответствующую информацию или контекст.

Обратите внимание, что, внося свой вклад в Xenogit, вы соглашаетесь опубликовать свой вклад в соответствии с лицензией MIT.

Лицензия

Xenogit выпускается под лицензией MIT. Не стесняйтесь изменять и распространять его в соответствии с вашими потребностями.