Skip to content

Commit fde273b

Browse files
author
Jose Luis Gonzalez
committed
docs: add AI configuration section and update status table
- Document [profile.ai] config with provider/api_key/model/base_url - Add provider comparison table (openai, anthropic, ollama) - Show ai_report JSON output example - Mark AI feature as completed, update milestone to 95%
1 parent cacd500 commit fde273b

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Git Reports es una herramienta construida en Rust que analiza repositorios Git y
1717

1818
## 🎯 Estado del Proyecto
1919

20-
**Milestone Actual**: 90% Complete
20+
**Milestone Actual**: 95% Complete
2121

2222
| Característica | Estado |
2323
|---------------|--------|
@@ -26,6 +26,7 @@ Git Reports es una herramienta construida en Rust que analiza repositorios Git y
2626
| Exportación de reportes (JSON) ||
2727
| Configuración multi-perfil (config.toml) ||
2828
| Soporte providers remotos (GitHub/GitLab/Bitbucket) ||
29+
| Interpretación IA de commits (OpenAI/Anthropic/Ollama) ||
2930
| Visualización web | ⏳ Planificado |
3031

3132
## 🚀 Inicio Rápido
@@ -101,6 +102,44 @@ Ver [config.toml.example](config.toml.example) para un ejemplo completo con todo
101102

102103
> ⚠️ Agrega `config.toml` a tu `.gitignore` para no exponer tokens.
103104
105+
### Configuración de IA
106+
107+
Cada perfil puede tener una sección `[profile.ai]` opcional. Si se omite, el reporte solo contendrá estadísticas de commits.
108+
109+
```toml
110+
[[profile]]
111+
name = "trabajo"
112+
email = "yo@empresa.com"
113+
token = "ghp_..."
114+
115+
[profile.ai]
116+
provider = "openai" # openai | anthropic | ollama
117+
api_key = "sk-..." # API Key del provider
118+
model = "gpt-4o" # modelo a usar
119+
# base_url = "http://localhost:11434" # solo para ollama
120+
```
121+
122+
| Provider | Modelos recomendados | Requiere |
123+
|---|---|---|
124+
| `openai` | `gpt-4o`, `gpt-4o-mini` | API Key de OpenAI |
125+
| `anthropic` | `claude-3-5-sonnet-20241022` | API Key de Anthropic |
126+
| `ollama` | `llama3`, `mistral` | Ollama corriendo localmente |
127+
128+
Con IA activada, el JSON de salida incluye un campo `ai_report` por repo:
129+
130+
```json
131+
{
132+
"ai_report": {
133+
"summary": "Esta semana implementé autenticación JWT y refactorizé el módulo de pagos.",
134+
"report_markdown": "## Reporte de actividad\n\n...",
135+
"hours_by_area": {
136+
"backend": 12.0,
137+
"testing": 3.5
138+
}
139+
}
140+
}
141+
```
142+
104143
## 🖥️ Uso
105144

106145
```bash

0 commit comments

Comments
 (0)