Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinibrsl/commitgen
🧞Ever stared at your Git changes, wondering what to write? Say hello to commitgen.
https://github.com/vinibrsl/commitgen
Last synced: about 2 months ago
JSON representation
🧞Ever stared at your Git changes, wondering what to write? Say hello to commitgen.
- Host: GitHub
- URL: https://github.com/vinibrsl/commitgen
- Owner: vinibrsl
- License: mit
- Created: 2024-09-12T13:28:41.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T13:52:55.000Z (4 months ago)
- Last Synced: 2024-11-02T13:42:16.577Z (2 months ago)
- Language: Shell
- Size: 3.91 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🪄 commitgen
Ever stared at your Git changes, wondering what to write? Say hello to
`commitgen`, your AI-powered commit message genie! 🧞
`commitgen` analyzes your Git changes and crafts concise, purposeful commit
messages. It aims for brevity (under 50 chars), uses imperative tone, and can
provide context on what changed and why – all without you typing a word.
## Quick Start 🚀
1. Install [Ollama](https://ollama.ai/)
2. Download `commitgen`:
```
curl -O https://raw.githubusercontent.com/vinibrsl/commitgen/main/commitgen
chmod +x commitgen
sudo mv commitgen /usr/local/bin/
```
3. In your Git repo:
```
git add your-amazing-changes
commitgen
```
4. Magic!
```
Update ESLint configuration to support latest standards
Updated the ESLint configuration to support the latest JavaScript standards
and best practices. Included new rules for code formatting and improved
error detection.
```
## Options
- Need help? `commitgen --help`
- Feeling nostalgic? `commitgen --version`
- Want a different AI brain? `commitgen --model gemma:2b`
## Troubleshooting
- Nothing happening? Make sure you've staged some changes!
- Make sure you have Ollama and at least llama3.1 installed
## Contribute
Got ideas to make `commitgen` even more magical? PRs welcome! Happy committing! 🎈