synqit 0.2.0

AI-powered Git assistant. Sync your code with intent.

Synqit — Sync your code with intent.

AI-powered Git assistant in your terminal. Instant commit messages. Smart PR descriptions.

---

What is Synqit?

Synqit reads your git diff, understands what changed, and writes a clean conventional commit message in under 3 seconds. You focus on code. Synqit writes the message.

---

Install

pip install synqit

Setup

Synqit works out-of-the-box with free models via Hugging Face. Run the interactive setup to choose your AI provider and set your API keys:

synqit setup

Alternatively, set your keys manually in your environment or a .env file:

• HUGGINGFACE_API_KEY (Free default)
• OPENAI_API_KEY
• ANTHROPIC_API_KEY

---

Usage

Generate a commit message

git add .
synqit commit

Add your intent (context-aware)

synqit commit -c "fix login timeout bug"

Auto-commit (no copy-paste)

synqit commit --apply

Combine everything

synqit commit -c "refactor user auth module" --apply

Generate a PR description

synqit pr

Against a different base branch:

synqit pr --base develop

Higher quality output

If you have configured OpenAI or Anthropic, you can request higher quality models for complex changes:

synqit commit --quality
synqit pr --quality

Configuration

View or modify your configuration directly:

synqit config
synqit config ai_provider openai

---

Output example

╭─ ✦ Commit Message ─────────────────────────────────────────╮
│                                                              │
│  fix(auth): resolve login timeout caused by session expiry  │
│                                                              │
│  - Improve session token validation on every request        │
│  - Handle edge case where token expiry is not checked       │
│  - Add fallback to refresh token when session expires       │
│                                                              │
╰──────────────────────────────────────────────────────────────╯

---

Options

synqit commit

Option	Short	Description
--context TEXT	-c	Developer intent — WHY the change was made
--apply	-a	Auto-run git commit -m after generation
--quality	-q	Use premium models (GPT-4o or Claude Sonnet)

synqit pr

Option	Short	Description
--base TEXT	-b	Base branch to compare (default: main)
--quality	-q	Use premium models (GPT-4o or Claude Sonnet)

---

How it works

1. Read — Synqit reads your staged diff (git diff --cached) or commit log
2. Understand — The diff + your intent is sent to Claude AI
3. Generate — Claude returns a structured Conventional Commit message
4. Apply — Optionally commits directly with --apply

---

Requirements

• Python 3.10+
• Git repository
• ANTHROPIC_API_KEY set in your environment

---

Tech Stack

• Typer — CLI framework
• GitPython — Git interaction
• Hugging Face Hub — Default AI Engine
• OpenAI & Anthropic SDKs
• Rich — Terminal formatting

---

Development

git clone https://github.com/pranavkp71/synqit
cd synqit
pip install -e .

---

License

MIT — built by Pranav KP

---

Ship fast. Solve real pain. Improve through usage.