🧠 GitGossip — AI-Powered Git Commit Summarizer

Install via:

GitGossip turns your commit history into human-readable summaries and merge request descriptions — powered by LLMs like Ollama (local) or OpenAI (cloud).

GitGossip helps developers and managers instantly understand what changed, why it changed, and how large codebases evolve — without reading every diff manually.

---

🚀 Features

✅ Generate smart commit summaries in natural language
✅ Produce Merge Request (MR) titles & descriptions from code diffs
✅ Quickly list recent commit authors within a sprint window (default: 15 days) you may need them to query 😄
✅ Works with local LLMs (Ollama) or cloud APIs (OpenAI / Anyscale)
✅ Fully offline compatible
✅ Configurable system resource awareness
✅ Clean CLI experience with Rich formatting
✅ Ready for cross-platform use (macOS / Linux)

---

⚙️ Installation (macOS / Linux)

🧩 Using uv (recommended)

uv tool install gitgossip

or clone manually:

git clone https://github.com/osmangoninahid/gitgossip.git
cd gitgossip
uv sync
uv run gitgossip --help

🍺 Using Homebrew

brew tap osmangoninahid/gitgossip
brew install gitgossip

🐳 Optional: Run via Docker (Local LLM mode)

If you prefer not to install Ollama on your host:

docker run -d -p 11434:11434 ollama/ollama
docker exec -it $(docker ps -q -f ancestor=ollama/ollama) ollama pull qwen2.5-coder:1.5b

Then configure GitGossip to connect:

gitgossip init
# → Choose provider: local
# → Base URL: http://localhost:11434/v1
# → Model: qwen2.5-coder:1.5b

---

🧠 Usage Examples

1️⃣ Initialize configuration

gitgossip init

This will interactively ask for:

• LLM provider (local or cloud)
• Model name (qwen2.5-coder:1.5b, llama3:8b, etc.)
• API key (if using cloud)
• Auto-detects and warns if your hardware has insufficient memory

Example:

Select LLM provider [local/cloud] (local): local
Detected 3 local models from Ollama.
Select or enter model name: qwen2.5-coder:1.5b
⚠️  Warning: Model may require 8 GB RAM. You have 6.2 GB.
Configuration saved successfully!

---

2️⃣ Summarize commits

gitgossip summarize --path . --since 7days

Example output:

╭─────────────────────────────── AI Summary for gitgossip ───────────────────────────────╮
│                                                                                        │
│  - Added local LLM factory and configuration setup                                     │
│  - Integrated interactive CLI initialization                                           │
│  - Improved summarizer to support chunk-based large diff summarization                 │
│                                                                                        │
╰────────────────────────────────────────────────────────────────────────────────────────╯

---

3️⃣ Generate a Merge Request summary

gitgossip summarize-mr main

Example output:

╭────────────────────────────── Merge Request Summary — gitgossip ───────────────────────╮
│                                                                                        │
│  **Refactor and Optimize LLM Integration**                                             │
│                                                                                        │
│  - Added centralized analyzer factory with memory safety checks                        │
│  - Improved configuration for local vs cloud LLMs                                      │
│  - Enhanced CLI UX with color-coded feedback                                           │
│                                                                                        │
╰────────────────────────────────────────────────────────────────────────────────────────╯

✨ Merge Request summary generated successfully!

4️⃣ List recent commit authors

gitgossip list-authors

By default, this lists all unique authors who have committed within the last 15 days — a typical sprint window. Authors from the last 15 days Example output:

1. Osman Goni Nahid <osman@os.ai>
2. Alice Smith <alice@company.com>

Total unique authors: 2

Total unique authors: 2

---

You can customize the time window or include all commit history:

# Show authors from the last 30 days
gitgossip list-authors --since 30days

# Show authors from all commits
gitgossip list-authors --all-commits

💡 Tip: Use this command to quickly check active contributors before running gitgossip summarize --author ""

☁️ Local vs Cloud Setup

Mode	Description	Base URL	API Key
Local	Uses Ollama or LM Studio for offline models	http://localhost:11434/v1	local
Cloud	Uses OpenAI / Anyscale / Groq APIs	https://api.openai.com/v1	Required

Your configuration lives at:

~/.gitgossip/config.yaml

Example:

llm:
  provider: local
  model: qwen2.5-coder:1.5b
  base_url: http://localhost:11434/v1
  api_key: local
paths:
  prompts: /Users/osman/.gitgossip/prompts (coming soon)
meta:
  version: '1.0'

---

🧩 Optional: Customize Prompts (Coming Soon)

GitGossip will soon allow you to customize LLM prompt templates for commit summarization, diff synthesis, and merge request generation.

This feature will let you:

• Define your own tone (technical, business, casual)

• Control summary structure (bullet points, prose, etc.)

• Override system defaults using .txt files under:

  ~/.gitgossip/prompts/
  ├── chunk.txt
  ├── synthesis.txt
  └── final.txt
  

⚙️ Status: Under development — available in an upcoming release (v0.2).

---

🧰 Troubleshooting

Issue	Cause	Fix
OpenAIError: api_key must be set	API key missing	Re-run gitgossip init or set api_key: local
OSError: Connection refused	Ollama server not running	Run ollama serve or check Docker port 11434
No models found	Ollama empty	ollama pull qwen2.5-coder:1.5b
Output too short	Model truncated due to context	Use smaller chunk_size or larger LLM
Slow generation	Large diffs or small GPU	Use cloud LLM for faster inference

---

🧑‍💻 Contributing

We love community contributions! Please read the CONTRIBUTING.md guide for:

• Local setup instructions
• Coding standards and pre-commit hooks
• Commit message conventions
• Release and publishing workflow

---

🧩 Developer Setup

Clone and install dependencies using uv:

git clone https://github.com/osmangoninahid/gitgossip.git
cd gitgossip
make install

Once installed, you can use the included Makefile to run all development tasks easily:

Command	Description
make install	Install all dependencies
make lint	Run Ruff linter
make format	Format code with Black + Ruff
make test	Run the full pytest suite
make run CMD="summarize-mr main --use-mock"	Run a local CLI command
make clean	Clean build/test artifacts

---

📜 License

MIT License © 2025 Osman Goni Nahid