@tomassalto/commitgpt
v1.0.4
Published
AI-powered conventional commit message generator using Groq
Maintainers
Readme
commitgpt
AI-powered conventional commit message generator. Analyzes your staged changes and generates a commit message using Groq (free, no credit card required).
git add .
commitgpt
# → feat(auth): add JWT refresh token rotationInstall
npm install -g commitgptSetup
Get a free API key at console.groq.com, then:
# macOS / Linux
export GROQ_API_KEY=your_key_here
# Add to ~/.bashrc or ~/.zshrc to persist
# Windows (PowerShell)
$env:GROQ_API_KEY = "your_key_here"
# Or set via System Environment Variables for persistenceUsage
# Generate commit message and print it
commitgpt
# Generate and copy to clipboard
commitgpt --copy
# Generate and run git commit automatically
commitgpt --executeHow it works
- Reads
git diff --staged - Sends the diff to Groq (llama3-8b-8192) with a Conventional Commits prompt
- Prints (or commits) the result
Output follows the Conventional Commits spec:
<type>(<scope>): <description>
feat(auth): add OAuth2 login support
fix(api): handle empty response from payment gateway
refactor(db): extract query builder into service layerTech stack
- TypeScript (strict mode)
- Commander.js — CLI framework
- Groq SDK — AI inference
- GitHub Actions — CI/CD + npm publish
License
MIT
