ai-commit-sense

Documentation

Welcome! This guide will help you set up ai-commit-sense in less than 2 minutes. Stop wasting time thinking of commit messages, and let AI do the heavy lifting.

🤔 Exactly what does this tool do?

Without this tool

You type manually and guess a good message:

git commit -m "fixed header bug again"
With ai-commit-sense

AI generates a clean, standard message instantly:

fix(ui): resolve alignment issue in header navigation

1. Installation

This tool is a simple, standalone file. You do not need Node.js, Python, or Go.

sudo curl -L https://github.com/Dharam-IN/ai-commit-sense/releases/latest/download/ai-commit-sense-mac -o /usr/local/bin/ai-commit-sense && sudo chmod +x /usr/local/bin/ai-commit-sense

🪟 Windows Users: Adding to PATH (Step-by-step)

Windows needs to know where your downloaded file lives so you can use it in any project folder.

  1. Download the .exe file and rename it to ai-commit-sense.exe.
  2. Move it to a safe folder, e.g., C:\Tools\ai-commit-sense\.
  3. Press the Windows Key, search for "Environment Variables" and hit Enter.
  4. Click "Environment Variables..." at the bottom.
  5. Under "System variables", select Path and click Edit.
  6. Click New, paste your folder path (C:\Tools\ai-commit-sense\), and click OK.
  7. Restart your terminal. Done!

2. First-Time Setup (API Key)

This tool uses your own free Google Gemini API key. You only need to do this once.

  1. Go to Google AI Studio.
  2. Sign in with any Google account.
  3. Click the Create API key button.
  4. Copy the generated key to your clipboard.
🔒 Privacy PromiseYour API key is saved safely on your own computer in a hidden file. Your code is directly sent to Google's API. No middleman, no tracking.

3. Daily Workflow (How to use)

Whenever you are ready to save your code, just follow these two steps instead of writing a commit message manually.

1

Tell Git what to save

Add your changed files just like you normally do.

git add .
2

Run the AI Tool

Run the command. It will show you a message, press y to confirm!

ai-commit-sense

4. Troubleshooting

How do I change my API key?

If you entered the wrong key or it expired, just delete the hidden config file from your computer. The next time you run the tool, it will ask for a new key.

Mac / Linuxrm ~/.ai-commit-sense.json
Windowsdel %USERPROFILE%\.ai-commit-sense.json