lumen is a command-line tool that uses AI to generate summary of your git changes

Features

• Generate summary for changes in a git commit by providing its SHA-1
• Generate summary for changes in git diff (staged/unstaged)
• Fuzzy-search for the commit to generate a summary
• Pretty output formatting enabled by Markdown
• Free and unlimited - no API key required to work out of the box
• Supports multiple AI providers

Usage

Try lumen --help

To summarise a commit, pass in its SHA-1

lumen explain HEAD
# OR
lumen explain cc50651f

To use the interactive fuzzy-finder (requires: fzf)

lumen list

To generate a summary for the current git diff

lumen explain --diff
# OR
lumen explain --diff --staged

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

Supported providers

Installation

Using Homebrew (MacOS and Linux)

brew tap jnsahaj/lumen
brew install lumen --formula

Using Cargo

[!IMPORTANT] cargo is a package manager for rust, and is installed automatically when you install rust. see installation guide

cargo install lumen

Prerequisites

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