comsu

AI-Powered (обертка) генератор сообщений

Comsu -это простой, но мощный инструмент командной строки, который использует Google Generative AI, чтобы предложить высококачественные, краткие сообщения о коммите, основанные на ваших поэтапных изменениях в GIT. Автоматизируйте процесс написания значимых сообщений о коммите и обеспечить согласованность в вашем проекте.

---

Оглавление

• Функции
• Установка
• Использование
• Внося
• Покажите свою поддержку

---

? Функции

• Автоматизированные сообщения о коммите : генерируйте сообщения о коммите на основе ваших поэтапных изменений с использованием модели ИИ Google.
• Auto Commit : он может автоматически совершать ваши изменения с помощью выбранного сообщения о коммите.
• Поддерживает традиционные типы коммита : предложения следуют стандартным типам коммит ( feat , fix , build , chore и т. Д.).
• Легкая настройка : установка с одной командой для начала.
• Настраиваемые подсказки : изменить файл приглашения для адаптации предложений AI к вашим конкретным потребностям проекта.

---

? Установка

Linux

Чтобы настроить Comsu на вашей системе Linux, выполните следующие действия:

1. Клонировать репозиторий :

   git clone https://github.com/ali-hv/comsu.git
   cd comsu

2. Запустите сценарий установки :

   chmod +x install.sh
   sudo ./install.sh

3. Установите свой ключ API :

   Убедитесь, что у вас есть набор ключей Google AI Studio API в качестве переменной среды. Если у вас нет, вы можете создать бесплатный ключ API здесь.

    export GOOGLE_AI_STUDIO_API_KEY= " your_api_key_here "

   Вы можете добавить эту строку в свою ~/.bashrc или ~/.zshrc чтобы сделать ее настойчивой.

Окна

Чтобы настроить Comsu на вашей системе Windows, выполните следующие действия:

1. Клонировать репозиторий : открыть PowerShell в качестве администратора, затем напишите эти команды:

   git clone https: // github.com / ali - hv / comsu.git
   cd comsu

2. Запустите сценарий установки :

   powershell - ExecutionPolicy Bypass - File install.ps1

3. Установите свой ключ API :

   Убедитесь, что у вас есть набор ключей Google AI Studio API в качестве переменной среды. Если у вас нет, вы можете создать бесплатный ключ API здесь.

   set GOOGLE_AI_STUDIO_API_KEY = your_api_key_here

   Вы можете добавить эту линию в свой путь, чтобы сделать ее настойчивым.

---

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

После установки вы можете запустить Comsu из любого каталога, где у вас были изменения:

Linux

git comsu

Окна

Запустите это в CMD:

git-comsu

Если вы живете в странах, ограниченных Google, вы можете использовать VPN или изменить свой DNS.

Это составит список предлагаемых сообщений о коммите на основе ваших изменений, и вы можете выбрать желаемое сообщение, тогда он автоматически совершит ваши изменения с помощью этого сообщения. Если вам не нравится какое -либо из сообщений, вы можете ввести «X» для выхода.

Пример

git add .
git comsu

Выход :

 Generating the commit messages based on your changes ...

1. ref: Refactor the send_email function for efficiency
2. ref: Update the send_email to reduce processing time
3. feat: Use new method for getting the changes in send_email

Write the message number you want to use (write 'x' to exit): 1

[main 6b25961] ref: Refactor the send_email function for efficiency
 1 file changed, 1 deletion(-)

Committed successfully.

---

Конфигурация

Подсказка, используемая для генерации сообщений о коммите, хранится в файле с именем, расположенным по адресу/usr/local/share/git-comsu/ Вы можете изменить этот файл, чтобы изменить способ создания AI -сообщений.

---

? Внося

Взносы, проблемы и запросы на функции приветствуются! Не стесняйтесь проверять страницу проблем.

1. Вилка репозитория.
2. Создайте филиал своей функции (функция/новая функция git cakeout -b).
3. Сделайте свои изменения (git commit -m 'добавить некоторую функцию').
4. Нажмите к ветке (функция GIT Push Origin/New Feature).
5. Откройте запрос на тягу.

---

? Покажите свою поддержку

Если вы найдете этот инструмент полезным, пожалуйста, отдайте репозиторий!