Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/runekaagaard/git-commit-llm
https://github.com/runekaagaard/git-commit-llm
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/runekaagaard/git-commit-llm
- Owner: runekaagaard
- License: mpl-2.0
- Created: 2024-12-10T12:25:04.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2024-12-10T13:29:42.000Z (29 days ago)
- Last Synced: 2024-12-10T13:29:56.584Z (29 days ago)
- Language: Shell
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-commit-llm
Generate git commit messages using LLMs by analyzing your staged changes.
## Requirements
- git
- Text editor (set in `$EDITOR`)
- llm CLI tool with API key
## Installation
Install dependencies:
```bash
# Install llm CLI tool
pipx install llm
pipx inject llm llm-claude-3
```
Install git-commit-llm:
```bash
curl -o /usr/local/bin/git-commit-llm https://raw.githubusercontent.com/runekaagaard/git-commit-llm/refs/heads/main/git-commit-llm
chmod +x /usr/local/bin/git-commit-llm
```
## Usage
Basic usage:
```bash
# Generate commit message for staged changes
git-commit-llm
# Stage all changes and generate message
git-commit-llm --stage-all
# Generate detailed message for major changes
git-commit-llm --major
```
Available options:
```
-h, --help Show help message
-s, --stage-all Stage all changes first
-m, --major Generate detailed multi-line message
-o, --model MODEL Select LLM model (default: claude-3-sonnet-20240229)
-p, --push Push changes after committing
-d, --diff Show staged changes first
```
## How it works
1. Optionally stages all changes (--stage-all/-s)
2. Optionally shows staged changes for review (--diff/-d)
3. Generates a commit message using an LLM based on the staged diff and branch name
4. Opens your editor to review/modify
5. Creates commit on save, aborts on exit
6. Optionally pushes changes (--push/-p)
## DWIM (Do What I Mean)
For the most common workflow of staging all changes, generating a commit message, and pushing, add this alias to your `.bashrc` or `.zshrc`:
```bash
alias gcl="git-commit-llm -sdp"
```
Now you can simply run `gcl` to stage all changes, see the diff, generate a commit message and push after committing.
## License
Mozilla Public License Version 2.0