xenogit

Su amigo CLI para mensajes instantáneos de confirmación de Git.

Introducción

Xenogit es su útil asistente de línea de comandos que utiliza OpenAI GPT para crear rápidamente mensajes de confirmación que siguen la especificación de confirmación convencional. ¡Deja de perder tiempo escribiendo confirmaciones y comienza a administrar tu repositorio Git sin esfuerzo!

️Empezando

Instalación

Hay dos formas de instalar Xenogit:

1. Usando Composer: Ejecute el siguiente comando para instalar Xenogit globalmente:

composer global require dotninth/xenogit

2. Descarga desde GitHub: visite la página Lanzamientos en GitHub y descargue el binario apropiado.

Uso

Después de instalar Xenogit, podrá acceder a todas las opciones disponibles simplemente iniciando el programa:

$ 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

Clave API

Xenogit necesita una clave API de OpenAI para funcionar correctamente. Hay dos opciones para proporcionar la clave API:

1. Utilice el comando xenogit config:api-key <your-api-key> .

2. Uso de la variable de entorno: cree una variable de entorno llamada API_KEY que contenga su clave API de OpenAI.

3. Cree un archivo llamado .env en el directorio donde se encuentra el binario Xenogit. Este archivo se utilizará para almacenar sus variables de entorno. Al archivo .env , agregue la siguiente línea, reemplazando <YOUR_API_KEY> con su clave API OpenAI real:

API_KEY= < YOUR_API_KEY > 

Pago

Usar Xenogit le costará dinero por cada solicitud que realice a la API de OpenAI. Xenogit utiliza el modelo oficial ChatGPT ( gpt-3.5-turbo-16k ), que cuesta aproximadamente 15 veces menos que GPT-4. Asegúrese de tener suficientes fondos o créditos en su cuenta OpenAI para pagar su uso de Xenogit.

Para obtener más información sobre el precio por utilizar los servicios de OpenAI, consulte su página de precios en la página de precios de OpenAI.

Contribuir

¡Eres bienvenido a contribuir a Xenogit! Para una colaboración fluida, siga estas pautas cuando contribuya al proyecto:

1. Bifurca el repositorio y clónalo en tu máquina local.
2. Crea una nueva rama para tu contribución: git checkout -b my-contribution .
3. Realice los cambios y asegúrese de que el código siga el estilo y las convenciones de codificación del proyecto.
4. Pruebe sus cambios a fondo.
5. Confirme sus cambios con un mensaje de confirmación descriptivo, siguiendo la especificación de confirmación convencional.
6. Empuja tu rama a tu repositorio bifurcado: `git push origin my-contribution'.
7. Abra una solicitud de extracción en la rama "principal" del repositorio de Xenogit.
8. Proporcione una descripción clara y detallada de sus cambios en la solicitud de extracción, junto con cualquier información o contexto relevante.

Tenga en cuenta que al contribuir a Xenogit, acepta liberar sus contribuciones bajo la licencia MIT.

Licencia

Xenogit se publica bajo la licencia MIT. Siéntase libre de modificarlo y distribuirlo según sus necesidades.