🤖 CommitWhisper (Ssshh 💤 )

Whisper From LLMs For Your Commit Msg

CommitWhisper utilizes LLMs generate git commit messages based on code diff information.

✨ Features

• 🔍 Get Diff Info From Staged Files
• 🌈 Interactive configuration selection for easy model switching.
• 🚀 Especially supports Chinese AI providers, Such as:
  • DeepSeek From DeepSeek
    • deepseek-chat
    • deepseek-reasoner
  • Tongyi Qianwen(通义千问) From Alibaba
  • Doubao(豆包) From ByteDance
  • 💤 More
• 🌅 Supports Mainstream AI providers, Such as:
  • ChatGPT From OpenAI
  • 💤 Claude From Anthropic
  • 💤 Gemini From Google
  • 💤 More
• 💬 [TODO] Interactive prompts allow the model to refine generated messages.
• ⏳ Coming Soon More

🧩 Supported Ai Provider

LLMs	Refer To Get API KEY
Qianwen	✅ Get Your Key
OpenAI	✅ Get Your Key
Doubao	✅ Get Your Endpoint and Key
DeepSeek	✅ Get Your Key
Claude	💤 Coming Soon

🔥 Status

Warning

This CLI is beta quality. Expect breaking changes and many bugs

⚡️ Requirements

• Nerd Font
• Git
• Go

📦 Installation

Git Version（Under Dev）

go install github.com/Coien-rr/CommitWhisper@latest
ln -s $(go env GOPATH)/bin/CommitWhisper $(go env GOPATH)/bin/cw
cw # Using Commit Whisper in Git-Repo

Release Version (Recommend)

1. DownLoad Released Package Based On Your System From Release Page

2. Extract the package to obtain the CLI cw

3. sudo ln -s ./cw /usr/local/bin/
   cw # Using Commit Whisper in Git-Repo

⚙️ Configuration

Cofig File Locates ~/.commitwhisper

When you first start cw, it will prompt you interactively to select configurations, including

• AI provider,
• LLMs,
• API key, and other related information.

Also, You Can Use cw rc to reconfig.

Demo Config:

AiProvider: Qwen
ModelName: qwen2.5-coder-32b-instruct
APIUrl: https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions
APIKey: [Please Put Your API Key Here]

🔮 RoadMap

💡 Ideas to explore

• Interactive prompts allow the model to refine generated messages.
• Support More AiProvider, Such as OpenAI✅, Claude💤, etc.(In Process)
• Generate more detailed commit descriptions(multi-lines commit).
• Explain the purpose of code changes compare two commit.
• Integrate commitlint to evaluate the quality of commit messages generated by LLMs.
• And More