Skip to content

πŸ€– Git Whisper - an intelligent CLI tool that generates meaningful and consistent commit messages using AI ✨. Stop struggling with commit message writing and let AI help you create clear, concise, and conventional commits πŸ“. βœ…

License

Notifications You must be signed in to change notification settings

mathieuletyrant/git-whisper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

86 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Git Whisper πŸ€–βœ¨

Meet Git Whisper, your AI-powered companion for crafting perfect Git commit messages. This intelligent CLI tool eliminates the hassle of writing commit messages by generating clear, conventional, and contextually relevant commits automatically.

✨ Key Features

  • πŸ€– Smart commit message generation powered by AI
  • πŸ’‘ Flexibility to choose your preferred LLM (GPT-4, Claude, and more)
  • πŸ“ Full compliance with conventional commit standards
  • πŸš€ Clean and user-friendly CLI interface
  • πŸ”„ Intelligent code change analysis for context-aware messaging

🎯 Why Git Whisper?

Git Whisper revolutionizes your Git workflow by automating commit message creation. It helps developers maintain professional commit histories while reducing mental overhead and saving valuable time.

πŸš€ Getting Started

  1. Install globally via npm:
npm install git-whisper -g
  1. Set up with OpenRouter:
# Set your APIKey of OpenRouter
gw config set apikey

# Choose LLM
gw config set model

Your settings will be saved automatically to ~/.git-whisper/config.json.

  1. Start Using Git Whisper ❀️
Command Description
gw Generate and execute commit message
gw --model anthropic/claude-3.5-sonnet Use a specific LLM for message generation
gw --interactive --commit-count 5 --dry-run Generate 5 commit messages interactively (preview only)
gw --language french Generate commit in french
gw --auto-add Add all staged changes
gw --auto-push Push on remote repository
gw config view apiKey View your current API key configuration
gw config view model View your current model configuration

πŸ§ͺ Local Development

To set up Git Whisper for local testing:

  1. Build the project:

    npm run build:watch
  2. Run the CLI

    node ./dist/index.js

πŸ› οΈ Built With

  • Node.js
  • OpenRouter API

πŸ“‹ TODO

Here are some exciting features we're planning to add:

  • 🎨 Custom commit message templates
  • πŸ”„ Git hook integration for automated commits
  • ⚑ Batch commit processing for multiple changes

About

πŸ€– Git Whisper - an intelligent CLI tool that generates meaningful and consistent commit messages using AI ✨. Stop struggling with commit message writing and let AI help you create clear, concise, and conventional commits πŸ“. βœ…

Resources

License

Stars

Watchers

Forks