git-mood

The AI-powered Git assistant that understands your code's "mood".
Generate conventional commits, perform deep code reviews, and push to GitHub—all with Google Gemini.

---

🚀 Key Features

🧠 Smart Commits

Analyzes staged diffs and writes perfect Conventional Commits.

---

🔍 Deep Review

Senior-level feedback on bugs, security, and clean code patterns.

---

⚡ Flash Models

Powered by the latest Gemini Flash models (Lite 2.5, 2.5, and 3).

---

📘 AI README Generator

Instantly generate a beautiful README.md for your project with smart context selection.

---

📦 Installation

# Install globally
npm install -g git-mood

# Or run instantly with npx
npx git-mood commit

---

🛠️ Getting Started

1. Setup Your AI

Run the setup once to securely store your Google Gemini API Key and select your preferred model.

git-mood setup

Tip

Get your free API Key at Google AI Studio.

2. The Daily Workflow

✨ Smart Commits & Auto-Push

Stop struggling with commit messages. git-mood reads your diff, suggests a message, commits, and even handles pushing/pulling for you.

git add .
git-mood commit

🛡️ Instant Code Review

Before you push, get a second pair of eyes. Identify logic errors or exposed secrets instantly.

git-mood review

📚 AI README Generator

Need documentation? Let AI analyze your project and generate a professional README.

git-mood readme

---

🎮 Commands

• git-mood setup — Initial configuration (API Key & Model choice).
• git-mood commit — Generate message, commit locally, and optional push.
• git-mood review — AI analysis of your current diff (unstaged + staged).
• git-mood model — Quickly swap between Gemini 2.5 Flash-Lite, Flash 2.5, or Flash 3.
• git-mood readme — Generate a professional README.md for your project.

---

🔒 Security & Privacy

• Local Storage: Your API key is stored locally on your machine using the conf package.
• Direct API: Your code diffs are sent directly to Google's Gemini API via an encrypted connection and are not stored or processed by any other middleman service.
• Config Location:
  • macOS/Linux: ~/.config/git-mood/
  • Windows: %APPDATA%\git-mood\config.json

---

🏗️ Requirements

• Node.js v18.0.0 or higher.
• Git installed and initialized in your project folder.

---

Made by Eyuel Engida