Skip to content

Repository files navigation

Git Reports

CIReleaseRustLicense

Generador de reportes automatizados para repositorios Git con análisis de IA.

📋 Descripción

Git Reports analiza tus commits de Git y genera reportes profesionales en formato Markdown estilo Jira, listos para presentar como parte de tu trabajo.

🚀 Instalación

Opción 1: Descargar ejecutable

Descarga el ejecutable para tu sistema operativo desde Releases:

# Linux
wget https://github.com/madkoding/git-reports/releases/latest/download/git-reports-linux-x64
chmod +x git-reports-linux-x64
./git-reports-linux-x64
# macOS
curl -L https://github.com/madkoding/git-reports/releases/latest/download/git-reports-macos-x64 -o git-reports
chmod +x git-reports
./git-reports
# Windows# Descargar desde releases y ejecutar en PowerShell
.\git-reports-windows-x64.exe

Opción 2: Compilar desde código

git clone https://github.com/madkoding/git-reports.git
cd git-reports
cargo build --release
./target/release/git-reports

⚙️ Configuración

Crea un archivo config.yaml en el mismo directorio que el ejecutable:

# config.yamlprofiles:
- name: "Tu Nombre"email: "tu@email.com"token: "tu-gitlab-token"# Configuración de IA (opcional)ai:
provider: "ollama"# openai, anthropic, ollamaapi_key: ""# no requerido para ollama localmodel: "llama3"base_url: "http://localhost:11434"repos:
- provider: "gitlab"owner: "tu-organizacion"name: "tu-repositorio"

Parámetros de configuración

CampoDescripciónObligatorio
profiles[].nameNombre del perfil
profiles[].emailEmail del desarrollador
profiles[].tokenToken de acceso (GitLab PAT, GitHub PAT, etc.)
profiles[].aiConfiguración de IA (opcional)No
profiles[].ai.providerProvider: openai, anthropic, ollamaSí*
profiles[].ai.api_keyAPI Key del providerNo
profiles[].ai.modelModelo a usarSí*
profiles[].ai.base_urlURL base (para Ollama local)No
profiles[].reposLista de repositorios
repos[].providerProvider: github, gitlab, bitbucket
repos[].ownerOwner/namespace del repo
repos[].nameNombre del repositorio

*Solo obligatorio si usas IA

Providers de IA

ProviderModelos recomendadosNotas
ollamallama3, mistral, ministral-3:8bRequiere Ollama corriendo localmente
openaigpt-4o, gpt-4o-miniRequiere API key de OpenAI
anthropicclaude-3-5-sonnet-20241022Requiere API key de Anthropic

🖥️ Uso

# Generar reporte de las últimas 2 semanas (por defecto)
./git-reports
# Especificar período
./git-reports -p week # última semana
./git-reports -p 2weeks # últimas 2 semanas (default)
./git-reports -p month # último mes
./git-reports -p all # todos los commits# Especificar config diferente
./git-reports -c mi-config.yaml
# Cambiar nombre del reporte
./git-reports -n mi-reporte

Opciones del CLI

OpciónDescripciónDefault
-c, --configArchivo de configuraciónconfig.yaml
-o, --output-dirDirectorio de salidareports
-n, --nameNombre base del reportereport
-p, --periodPeríodo: week, 2weeks, month, all2weeks
-h, --helpMostrar ayuda-

Salida

El ejecutable crea una carpeta reports/ con:

reports/
├── report_2026-02-12_2026-02-26.json
└── report_2026-02-12_2026-02-26.md
  • JSON: Datos crudos con todos los commits
  • Markdown: Reporte formateado estilo Jira con tareas

📊 Ejemplo de reporte

El reporte Markdown incluye:

  • Tareas estilo Jira: Título, descripción, tiempo estimado, tipo, esfuerzo
  • Resumen por área: Backend, frontend, testing, etc.
  • 40 horas semanales: Total distribuido entre tareas

Ver examples/reporte-ejemplo.md para un ejemplo completo.

🛠️ Desarrollo

# Compilar
cargo build --release
# Tests
cargo test# Formato
cargo fmt --check

📄 Licencia

MIT - Ver LICENSE para detalles.


Autor: madkoding

Última actualización: 2026-02-26 15:51:02 -03

About

Git commit analysis engine in Rust. Generates reports for your job or Jira. Automates tracking of your weekly/monthly activity. v1.0.0 - Initial Release.

Topics

Resources

Contributing

Security policy

Stars

6 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages