lumen is a free CLI tool that uses AI to summarise git commits without requiring an API key.
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 |
Using Homebrew (MacOS and Linux)
brew tap jnsahaj/lumen
brew install lumen --formula
Using Cargo
cargo install lumen
- git
- fzf (optional): Required for
lumen list
command - mdcat (optional): Required for pretty output formatting
$ lumen --help
# summarise a commit by giving its SHA-1
# eg: lumen explain HEAD
# eg: lumen explain cc50651f
$ lumen explain <commit-sha>
# fuzzy-search (using fzf) commits, and then `explain`
$ lumen list
AI Provider can be configured by using CLI arguments or Environment variables.
-p, --provider <PROVIDER> [env: LUMEN_AI_PROVIDER] [default: phind] [possible values: openai, phind, groq]
-k, --api-key <API_KEY> [env: LUMEN_API_KEY]
-m, --model <MODEL> [env: LUMEN_AI_MODEL]
# eg: lumen --p="openai" --k="<your-api-key>" -m="gpt-4o" explain HEAD
# eg: lumen --p="openai" --k="<your-api-key>" -m="gpt-4o" list