mirrors/lumen
1
0
Fork 0
mirror of https://github.com/jnsahaj/lumen.git synced 2025-12-23 05:36:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Sahaj Jain 2024-10-30 12:40:28 +05:30 • committed by GitHub
parent 7b76a3c804
commit 4ac2d40d95
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 26 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,4 +1,28 @@
# lumen
CLI tool to explain/summarise git commits
[WIP] Free and open-source CLI tool to summarise git commits using AI
Work in progress - stay tuned!
Supports OpenAI, Phind, and Groq
## Installation
### Cargo
```bash
cargo install lumen
```
## Usage
```sh
$ lumen --help
$ lumen explain <commit-sha> # eg: lumen explain HEAD
$ lumen list # requires: fzf
```
Default model: `phind`
To use a different model
```sh
$ lumen --provider="openai" --api-key="<your-api-key>" explain HEAD
$ lumen --provider="openai" --api-key="<your-api-key>" list
```
You can also set `LUMEN_AI_PROVIDER` and `LUMEN_API_KEY` env variables and use `lumen` commands without specifying `provider`