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-2.0.0.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-2.0.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gitmate_ai-2.0.0.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-2.0.0.tar.gz
Algorithm Hash digest
SHA256 1d59ffdb600a9e1dc96e61e4777fba3ecc8680c0b55c7e3966a0b4905d83ce98
MD5 34099fe4c55b1d9b6b3407e38effe748
BLAKE2b-256 d589240c438230145c20d9afed257776a1599432b0d073c873f6590c5ff89fe2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gitmate_ai-2.0.0-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-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 22bd0363204b5c9bb87e60490ab1baa877904b8cebd7db530bd9369ed1c1bac7
MD5 f413edc4ea91771a09d3d98d4805f816
BLAKE2b-256 b1e4043266198d2d464f9a4c0c5e85e79def1895170e9bfb637f05746211170c

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