| Name | gitmate-ai JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | GitMate - AI Git Assistant for Terminal |
| upload_time | 2025-08-10 18:55:36 |
| maintainer | None |
| docs_url | None |
| author | Tejas Raundal |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🧠 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
```bash
pip install gitmate-ai
````
### 2. Run Interactively
```bash
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:
```bash
gitmate --model claude --api-key YOUR_KEY
```
---
## 🤖 Usage Examples
### Ask the bot directly:
```bash
@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](https://github.com/TejasRaundal)
---
## 📄 License
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "gitmate-ai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Tejas Raundal",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7b/b9/a0c39a05321ca0270565393650b86a73bc075849dac516fac31d68bc16b1/gitmate_ai-1.0.4.tar.gz",
"platform": null,
"description": "\r\n# \ud83e\udde0 GitMate \u2014 AI Git Terminal Assistant\r\n\r\nGitMate is a terminal-based assistant powered by **LangChain + your choice of LLM (Gemini, OpenAI, Claude)**. \r\nIt helps you execute Git and shell commands interactively, detects common errors like merge conflicts or fatal errors, and offers AI-powered help \u2014 right inside your terminal.\r\n\r\n---\r\n\r\n## \u2699\ufe0f Features\r\n\r\n- \ud83d\udcac Talk to the AI with `@bot your question`\r\n- \ud83e\udde0 Pick your preferred model: OpenAI GPT-4o, Gemini 2.0, or Claude 3\r\n- \ud83e\udd16 Auto-detect Git errors and offer intelligent help\r\n- \ud83d\udcbe Logs the entire terminal session\r\n- \u26a1 Fully automated mode with CLI flags (`--model`, `--api-key`)\r\n\r\n---\r\n\r\n## \ud83d\ude80 Quickstart\r\n\r\n### 1. Install\r\n\r\n```bash\r\npip install gitmate-ai\r\n````\r\n\r\n### 2. Run Interactively\r\n\r\n```bash\r\ngitmate\r\n```\r\n\r\nYou'll be prompted to select an LLM model and enter your API key.\r\n\r\n---\r\n\r\n## \ud83d\udd27 Command-Line Arguments\r\n\r\n| Flag | Description | Example |\r\n| ----------- | ---------------------------------------- | ------------------ |\r\n| `--model` | Select LLM: `openai`, `gemini`, `claude` | `--model gemini` |\r\n| `--api-key` | Provide your API key | `--api-key sk-...` |\r\n\r\nSkip all prompts:\r\n\r\n```bash\r\ngitmate --model claude --api-key YOUR_KEY\r\n```\r\n\r\n---\r\n\r\n## \ud83e\udd16 Usage Examples\r\n\r\n### Ask the bot directly:\r\n\r\n```bash\r\n@bot how do I revert the last commit?\r\n```\r\n\r\n### Handle errors interactively:\r\n\r\nIf GitMate detects an error (like a merge conflict), it will ask:\r\n\r\n```\r\n\ud83d\udea8 I noticed a merge conflict. Do you want help resolving it?\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udcd3 Session Logs\r\n\r\nAll terminal activity is logged automatically as:\r\n\r\n```\r\ngit_session_YYYYMMDD_HHMMSS.log\r\n```\r\n\r\nUseful for reviewing your Git workflow or debugging sessions.\r\n\r\n---\r\n\r\n## \ud83e\udde9 Future Ideas\r\n\r\n* `--command` flag: Run a single Git command with AI help and exit\r\n* Task Performer Agent\r\n* Markdown output formatting\r\n* Live Git watch mode for auto-analysis\r\n* API key manager / config file support\r\n---\r\n\r\n## \ud83d\udee1\ufe0f Disclaimer\r\n\r\nThis tool runs Git and shell commands using Python\u2019s `subprocess`.\r\nAlways review AI suggestions before executing potentially destructive commands.\r\n\r\n---\r\n\r\n## \ud83d\udc68\u200d\ud83d\udcbb Author\r\n\r\nBuilt by [Tejas Raundal](https://github.com/TejasRaundal)\r\n\r\n---\r\n\r\n## \ud83d\udcc4 License\r\n\r\nMIT License\r\n",
"bugtrack_url": null,
"license": null,
"summary": "GitMate - AI Git Assistant for Terminal",
"version": "1.0.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "65558ed1767ad275af06b200817d8d7f7577cfdb4a40081f1b029b8721511797",
"md5": "d79e60a1fb7783efc237d87c4152c507",
"sha256": "c661cf47e952a34428a3b8815e7efc7ce02d12cb6fd7e5db6d9064ca21ad62b9"
},
"downloads": -1,
"filename": "gitmate_ai-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d79e60a1fb7783efc237d87c4152c507",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6134,
"upload_time": "2025-08-10T18:55:35",
"upload_time_iso_8601": "2025-08-10T18:55:35.054628Z",
"url": "https://files.pythonhosted.org/packages/65/55/8ed1767ad275af06b200817d8d7f7577cfdb4a40081f1b029b8721511797/gitmate_ai-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7bb9a0c39a05321ca0270565393650b86a73bc075849dac516fac31d68bc16b1",
"md5": "75f5b8d408b044a64b192faaed28341d",
"sha256": "ff7cf58a0ec2503478167430865c3955c9d436a9924bbb57c4b2025bbc6eb6b3"
},
"downloads": -1,
"filename": "gitmate_ai-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "75f5b8d408b044a64b192faaed28341d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5665,
"upload_time": "2025-08-10T18:55:36",
"upload_time_iso_8601": "2025-08-10T18:55:36.205865Z",
"url": "https://files.pythonhosted.org/packages/7b/b9/a0c39a05321ca0270565393650b86a73bc075849dac516fac31d68bc16b1/gitmate_ai-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-10 18:55:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gitmate-ai"
}
