MateCommit

module
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 6, 2025 License: MIT

README

MateCommit 🧉

Build Status Report Card codecov

¡Bienvenidos a MateCommit! Un proyecto que busca hacer tu flujo de trabajo con Git más simple, todo acompañado con un buen mate.

¿Qué es esto?

¿Te da paja pensar en el nombre de tu commit? Bueno, MateCommit viene a darte una mano. Este proyecto te sugiere títulos para tus commits de manera inteligente, mientras te tomás unos buenos mates.

Características
  • 🧉 Sugerencias inteligentes: Te ayudamos a elegir los mejores nombres para tus commits
  • 💻 Compatible con GitHub: Se integra perfectamente con tu flujo de trabajo
  • 🤖 Potenciado por IA: Actualmente usa Gemini, con planes de soportar más modelos en el futuro
  • 🌎 Bilingüe: Soporta español e inglés
  • Fácil de usar: Simple y efectivo

Instalación

Usando el binario
  1. Descargá el binario desde la página de releases para tu sistema:

    • Linux: matecommit-linux-amd64
    • Windows: matecommit-windows-amd64.exe
    • Mac: matecommit-darwin-amd64
  2. Dale permisos (Linux/Mac):

    chmod +x matecommit-linux-amd64
    
  3. Movelo al PATH:

    sudo mv matecommit-linux-amd64 /usr/local/bin/matecommit
    
  4. Configuración inicial:

    # Configura tu API key de Gemini
    matecommit config set-api-key --key <tu-api-key>
    
    # Establece tu idioma preferido
    matecommit config set-lang --lang es  # o en para inglés
    
Desde el código fuente
  1. Cloná el repositorio:

    git clone https://github.com/Tomas-vilte/MateCommit.git
    
  2. Instalá las dependencias:

    cd MateCommit
    go mod tidy
    
  3. Compilá:

    go build -o matecommit ./cmd/main.go
    

Documentación de Comandos

Para una guía detallada de todos los comandos disponibles, opciones y ejemplos de uso, consultá el archivo COMMANDS.md. Ahí encontrarás:

  • Configuración completa
  • Comandos principales
  • Ejemplos con salidas
  • Integración con Jira
  • Tips y trucos

Modelos de IA Soportados

Actual
  • 🤖 Gemini: Modelo principal actual
Próximamente
  • 🔄 GPT-4: Integración planificada
  • 🔄 Claude: Integración planificada

Licencia

MateCommit está bajo licencia MIT. Podés ver los detalles en el archivo LICENSE.

Contribuciones

¿Querés contribuir? ¡Genial! Consultá nuestra guía de contribución para empezar.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL