commitcraft-cli
v1.0.1
Published
AI-powered commit message generator - Craft commits that don't suck
Downloads
171
Maintainers
Readme
🎯 CommitCraft
AI-powered commit message generator using Google Gemini - Craft commits that don't suck!
✨ Features
- 🤖 AI-Generated Commits - Uses Google Gemini to analyze your changes
- ⚡ Lightning Fast - Generate professional commit messages in seconds
- 📝 Conventional Commits - Follows best practices automatically
- 🎨 Beautiful CLI - Clean, colorful interface with spinner animations
- ⚙️ Simple Setup - Just add your Gemini API key and go
🚀 Installation
npm install -g commitcraft-cli📖 Usage
Initial Setup
commitcraft init
# Enter your Google Gemini API keyGet your free API key at: https://aistudio.google.com/app/apikey
Generate Commit Messages
- Stage your changes:
git add .- Generate commit message:
commitcraft- Choose to accept or cancel the generated message
Auto-Commit
Skip the confirmation and commit automatically:
commitcraft --auto
# or
commitcraft -a🎨 Example
$ git add src/features/auth.js
$ commitcraft
🎯 COMMITCRAFT
════════════════════════════════════════════════════════════
✔ Done!
📝 COMMIT MESSAGE:
feat(auth): Add JWT token validation middleware
? Action? ✓ Commit
✓ Committed! 🎉⚙️ Configuration
CommitCraft stores your configuration in ~/.commitcraftrc
Default settings:
- Provider: gemini
- Model: gemini-2.5-flash
- Temperature: 0.7
- Max Tokens: 1000
🔑 API Key
CommitCraft uses Google Gemini API. Get your free API key:
- Visit https://aistudio.google.com/app/apikey
- Create a new API key
- Run
commitcraft initand paste your key
📋 Requirements
- Node.js >= 14.0.0
- Git repository
- Google Gemini API key
🤝 Contributing
Contributions are welcome! Feel free to open issues or submit PRs.
📄 License
MIT
🙏 Credits
Built with ❤️ using:
- Google Gemini AI
- Commander.js
- Inquirer.js
- Chalk
- Ora
Made by developers, for developers 🚀
