Começar¶
Requisitos¶
- Node.js 20 ou superior, dentro de um repositório git
- Opcional: Ollama com um modelo puxado para o
--model
Uso básico¶
npx gitscribe # desde a última tag, modo template
npx gitscribe v1.0.0..HEAD # intervalo explícito
npx gitscribe --version v1.1.0 # define o título
npx gitscribe HEAD~20..HEAD # últimos 20 commits
Os intervalos são ranges de revisão git normais. Sem intervalo, o gitscribe usa
<última tag>..HEAD, ou todo o histórico se não houver tags.
Polir com um LLM local¶
ollama pull llama3.2
npx gitscribe v1.0.0..HEAD --model llama3.2
npx gitscribe v1.0.0..HEAD --model llama3.2 --host http://localhost:11434
Os commits são agrupados primeiro e só depois o resumo categorizado é enviado ao modelo — por isso até um modelo local pequeno produz boas notas, e não consegue inventar alterações que não estão no teu histórico.
Melhores resultados¶
- Usa Conventional Commits (
feat:,fix:,feat(scope)!:…). Commits fora do padrão aparecem à mesma em "Other". - Marca releases com tags para o intervalo por defeito funcionar (
git tag v1.0.0).