| --- |
| title: git-commit-at |
| emoji: 🤖 |
| colorFrom: blue |
| colorTo: indigo |
| sdk: gradio |
| sdk_version: 6.18.0 |
| app_file: app.py |
| tags: |
| - build-small-hackathon |
| pinned: false |
| --- |
| |
| # git-commit-app 🎯 |
|
|
| **A suite of AI-powered git commit tools** for effortless, consistent commit messages. |
|
|
| This monorepo contains multiple projects for generating and managing git commits: |
|
|
| ## Community |
|
|
| - [Reddit: I made a CLI that generates conventional commit messages locally using AI](https://www.reddit.com/user/bhargavi_r/comments/1u6v9uc/i_made_a_cli_that_generates_conventional_commit/) |
| - [dev.to: git-commit-at — Generate conventional commit messages locally with AI, no API key needed](https://dev.to/bhargavirengarajan21/git-commit-at-generate-conventional-commit-messages-locally-with-ai-no-api-key-needed-1nc4) |
|
|
| ## Projects |
|
|
| ### 🚀 [git-commit-at](./git-commit-at) |
|
|
| **AI-powered commit message generator with interactive CLI and web UI** |
|
|
| - Generate conventional commit messages using AI (Ollama) |
| - Interactive selection from 3 AI-suggested options |
| - Web UI for login, commit history, and branch visualization |
| - Session persistence and Redis caching |
| - Docker Compose setup with Ollama, Redis, and Gradio |
|
|
| **Quick start:** |
| ```bash |
| npm install -g git-commit-at |
| git add . |
| git commit-at |
| ``` |
|
|
| **Features:** |
| - ✅ Conventional commit format (`feat:`, `fix:`, `refactor:`, etc.) |
| - ✅ Custom commit format templates |
| - ✅ Ticket number integration |
| - ✅ Live branch graph visualization |
| - ✅ Commit history tracking |
| - 🧠 Fine-tuned model integration (see below) |
|
|
| ## Directory Structure |
|
|
| ``` |
| git-commit-app/ |
| ├── git-commit-at/ # npm package — CLI + bundled web UI |
| │ ├── index.js # Core commit logic (Ollama AI) |
| │ ├── wrapper.js # CLI orchestrator |
| │ ├── docker-compose.yml # All services (Ollama, Redis, Gradio) |
| │ ├── Dockerfile # Node app container |
| │ ├── entrypoint.sh # Docker setup script |
| │ ├── gradio/ # Bundled web UI (Python/Gradio) |
| │ │ ├── app.py # Login + history + branch visualizer |
| │ │ ├── auth_service.py # Redis-based user auth |
| │ │ ├── generate_graph.py |
| │ │ ├── git_graph.py |
| │ │ └── Dockerfile |
| │ └── package.json |
| │ |
| └── README.md # This file |
| ``` |
|
|
| ## Getting Started |
|
|
| ### Prerequisites |
|
|
| - Docker & Docker Compose |
| - Node.js 18+ |
|
|
| ### Installation |
|
|
| ```bash |
| npm install -g git-commit-at |
| ``` |
|
|
| ### First Use |
|
|
| ```bash |
| # Stage your changes |
| git add . |
| |
| # Generate commit message |
| git commit-at |
| |
| # Follow the interactive prompts |
| # - Log in or register |
| # - Select a suggested message |
| # - Confirm and commit |
| ``` |
|
|
| ## Fine-Tuned Model Integration |
|
|
| `git-commit-at` now uses a **custom fine-tuned model** as its primary AI, with automatic fallback to a general model. |
|
|
| ### Model |
|
|
| **[Bhargavi5q1/git-commit-messages](https://huggingface.co/Bhargavi5q1/git-commit-messages)** — Fine-tuned on 2,179 real git diffs using Unsloth + QLoRA on a Qwen2.5-Coder 1.5B base model. Trained to output conventional commit messages in one line with no explanation. |
|
|
| ### How it works |
|
|
| ``` |
| git diff (staged changes) |
| │ |
| ▼ |
| ┌─────────────────────────────────┐ |
| │ Fine-tuned model (primary) │ hf.co/Bhargavi5q1/git-commit-messages |
| │ via Ollama │ |
| └────────────┬────────────────────┘ |
| │ fails? |
| ▼ |
| ┌─────────────────────────────────┐ |
| │ qwen2.5-coder:1.5b (fallback) │ general-purpose model |
| └─────────────────────────────────┘ |
| ``` |
|
|
| - Primary model is pulled automatically on first run (~986 MB) |
| - If unavailable, falls back silently to `qwen2.5-coder:1.5b` |
| - Terminal shows which model was used on each run |
|
|
| ### Training details |
|
|
| | | | |
| |---|---| |
| | Base model | Qwen2.5-Coder 1.5B | |
| | Method | QLoRA (Unsloth) | |
| | Dataset | 2,179 git diff → commit message pairs | |
| | Epochs | 3 | |
| | Format | Conventional Commits | |
| | Export | GGUF Q4_K_M (~986 MB) | |
|
|
| ## Architecture |
|
|
| ``` |
| ┌──────────────────────────────────────────────┐ |
| │ git-commit-at (npm package) │ |
| ├──────────────────────────────────────────────┤ |
| │ │ |
| │ CLI (Node.js) ←→ Docker Compose │ |
| │ ├── Ollama (AI) │ |
| │ ├── Redis (cache) │ |
| │ ├── Gradio (web UI) │ |
| │ └── commit-at (Node) │ |
| │ │ |
| └──────────────────────────────────────────────┘ |
| ``` |
|
|
| ## Features Overview |
|
|
| ### git-commit-at |
|
|
| - 🤖 **AI Suggestions** — 3 smart commit message options |
| - 🎯 **Conventional Format** — Follows commit standards |
| - 🌐 **Web UI** — Login, history, branch visualization |
| - 📝 **Custom Formats** — Define your own commit template |
| - 🔐 **Session Persistence** — Stay logged in |
| - 🐳 **Docker Ready** — One-click setup |
| - 📊 **Branch Visualizer** — See your git graph live |
|
|
| ## Development |
|
|
| ### Project Docs |
|
|
| - **git-commit-at**: [README](./git-commit-at/README.md) — Full setup, troubleshooting, contributing |
|
|
| ### Development Workflow |
|
|
| ```bash |
| # Install all dependencies |
| npm install |
| |
| # Run services |
| docker compose up -d |
| |
| # Access web UI |
| # http://localhost:7860 |
| |
| # Run CLI |
| node wrapper.js |
| ``` |
|
|
| ### File Structure (git-commit-at) |
|
|
| | File | Purpose | |
| |------|---------| |
| | `wrapper.js` | CLI entry; manages Docker services | |
| | `index.js` | Main commit logic | |
| | `diff-parser.js` | Parses git diffs | |
| | `entrypoint.sh` | Docker setup | |
| | `gradio/app.py` | Web UI | |
| | `gradio/git_graph.py` | Branch visualization | |
|
|
| ## Contributing |
|
|
| We welcome contributions! Here's how: |
|
|
| 1. **Fork** the repo |
| 2. **Create a branch** for your feature: `git checkout -b feature/my-feature` |
| 3. **Make changes** and test locally |
| 4. **Use git-commit-at** for your commits 😉 |
| 5. **Push** and open a PR |
|
|
| ### Commit Guidelines |
|
|
| Use [Conventional Commits](https://www.conventionalcommits.org/): |
| - `feat:` — New feature |
| - `fix:` — Bug fix |
| - `docs:` — Documentation |
| - `refactor:` — Code refactor |
| - `test:` — Tests |
| - `chore:` — Build, dependencies, etc. |
|
|
| ## Troubleshooting |
|
|
| ### General Issues |
|
|
| | Problem | Solution | |
| |---------|----------| |
| | Docker won't start | Check if Docker daemon is running | |
| | Port already in use | Change port in `docker-compose.yml` | |
| | "Not a git repo" | Run from inside a git repository | |
|
|
| ### git-commit-at Issues |
|
|
| See [git-commit-at Troubleshooting](./git-commit-at/README.md#troubleshooting) |
|
|
| ## Performance |
|
|
| | Operation | Time | |
| |-----------|------| |
| | First run (download models) | ~30s | |
| | Generate suggestions | ~5-10s | |
| | Web UI load | <1s | |
|
|
| ## Environment Setup |
|
|
| ### Using Docker (Recommended) |
|
|
| Everything runs in containers—no local setup needed! |
|
|
| ```bash |
| docker compose up -d |
| npm start |
| ``` |
|
|
| ### Local Development |
|
|
| ```bash |
| # Set up Node environment |
| node --version # Should be 18+ |
| |
| # Install deps |
| npm install |
| |
| # Start Docker services only |
| docker compose up -d ollama redis gradio |
| |
| # Run app |
| node wrapper.js |
| ``` |
|
|
| ## FAQ |
|
|
| **Q: Do I need Ollama installed locally?** |
| A: No! Ollama runs in a Docker container. Just ensure Docker is running. |
|
|
| **Q: Which AI model does this use? (Inprogress)** |
| A: A custom fine-tuned model ([Bhargavi5q1/git-commit-messages](https://huggingface.co/Bhargavi5q1/git-commit-messages)) trained specifically for git commit messages. Falls back to `qwen2.5-coder:1.5b` if unavailable. |
|
|
| **Q: Does this work offline?** |
| A: After the first run (which downloads the AI model), yes! |
|
|
| **Q: Can I use this without the web UI?** |
| A: Yes! Just run `git-commit-at` from the CLI. |
|
|
| **Q: How do I customize the commit format?** |
| A: You'll be prompted each time. Or edit the format in the Gradio UI after logging in. |
|
|
| ## License |
|
|
| MIT — See [LICENSE](LICENSE) for details |
|
|
| ## Links |
|
|
| - 🐳 Docker Hub: [git-commit-at](https://hub.docker.com) |
| - 🤗 Hugging Face: [Fine-tuned model](https://huggingface.co/Bhargavi5q1/git-commit-messages) · [Spaces](https://huggingface.co/spaces/build-small-hackathon/git-commit-a) |
| - 📦 NPM: [git-commit-at](https://npmjs.com/package/git-commit-at) |
|
|
| ## Support |
|
|
| - 📖 **Docs**: Check individual project READMEs |
| - 🐛 **Issues**: Report on GitHub |
| - 💬 **Discussions**: Ask questions in GitHub Discussions |
|
|
| --- |
|
|
| **Made with ❤️ for developers who want better commits, faster.** |
|
|
| 🚀 Start generating smarter commits today! |
