Skip to main content

GitMate - AI Git Assistant for Terminal

Project description

🧠 GitMate — AI Git Terminal Assistant

GitMate is a terminal-based assistant powered by LangChain + your choice of LLM (Gemini, OpenAI, Claude).
It helps you execute Git and shell commands interactively, detects common errors like merge conflicts or fatal errors, and offers AI-powered help — right inside your terminal.


⚙️ Features

  • 💬 Talk to the AI with @bot your question
  • 🧠 Pick your preferred model: OpenAI GPT-4o, Gemini 2.0, or Claude 3
  • 🤖 Auto-detect Git errors and offer intelligent help
  • 💾 Logs the entire terminal session
  • ⚡ Fully automated mode with CLI flags (--model, --api-key)

🚀 Quickstart

1. Install

pip install gitmate-ai

2. Run Interactively

gitmate

You'll be prompted to select an LLM model and enter your API key.


🔧 Command-Line Arguments

Flag Description Example
--model Select LLM: openai, gemini, claude --model gemini
--api-key Provide your API key --api-key sk-...

Skip all prompts:

gitmate --model claude --api-key YOUR_KEY

🤖 Usage Examples

Ask the bot directly:

@bot how do I revert the last commit?

Handle errors interactively:

If GitMate detects an error (like a merge conflict), it will ask:

🚨 I noticed a merge conflict. Do you want help resolving it?

📓 Session Logs

All terminal activity is logged automatically as:

git_session_YYYYMMDD_HHMMSS.log

Useful for reviewing your Git workflow or debugging sessions.


🧩 Future Ideas

  • --command flag: Run a single Git command with AI help and exit
  • Task Performer Agent
  • Markdown output formatting
  • Live Git watch mode for auto-analysis
  • API key manager / config file support

🛡️ Disclaimer

This tool runs Git and shell commands using Python’s subprocess. Always review AI suggestions before executing potentially destructive commands.


👨‍💻 Author

Built by Tejas Raundal


📄 License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitmate_ai-1.0.3.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitmate_ai-1.0.3-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file gitmate_ai-1.0.3.tar.gz.

File metadata

  • Download URL: gitmate_ai-1.0.3.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for gitmate_ai-1.0.3.tar.gz
Algorithm Hash digest
SHA256 ae48d99b4631386c0e315d0646a477f5b498fac95a53d55dc142f05d7664c341
MD5 e300f5592b9646e616a2c9f556f7c58d
BLAKE2b-256 1bd12b7500b120ee93a06069487876108afc4a3262275f8ec68ec4c1934f031c

See more details on using hashes here.

File details

Details for the file gitmate_ai-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: gitmate_ai-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for gitmate_ai-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 32747c3a3b02d8871079c6d86311d858b877487a0474062348d2649ab7d7fda5
MD5 d3d017aa1cbbcafef2c903b1f92ca7a0
BLAKE2b-256 c479e2082ebd6e1cd747b8807d4ac05b6d1efb374d766524893d96a701bd0df2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page