lumen/README.md

lumen is a free CLI tool that uses AI to summarise git commits.

Supported providers

Provider	API Key Required	Models
Groq groq	Yes (free)	llama2-70b-4096, mixtral-8x7b-32768 (default: mixtral-8x7b-32768)
OpenAI openai	Yes	gpt-4o, gpt-4o-mini, gpt-4, gpt-3.5-turbo (default: gpt-4o-mini)
Phind phind (Default)	No	Phind-70B

Installation

1. Cargo: cargo install lumen

Prerequisites

1. git
2. fzf (optional): Required for lumen list command
3. mdcat (optional): Required for pretty output formatting

Usage

$ lumen --help

# summarise a commit by giving its SHA-1
# eg: lumen explain HEAD
# eg: lumen explain cc50651f
$ lumen explain <commit-hash>

# fuzzy-search (using fzf) commits, and then `explain`
$ lumen list

Configure AI Provider

Using CLI args:

$ lumen --provider="openai" --api-key="<your-api-key>" --model="gpt-4o" explain HEAD
$ lumen --provider="openai" --api-key="<your-api-key>" list

Using Environment variables:

LUMEN_AI_PROVIDER (default: "phind")
LUMEN_API_KEY (when applicable)
LUMEN_AI_MODEL (when applicable)