Lightning-fast Git workflows with AI-powered commit messages
Project description
Git Quick - Lightning-fast Git workflows
A modern CLI tool and VS Code extension that speeds up repetitive Git commands with smart defaults, AI-powered commit messages, and developer productivity features.
⚡ Quick Install
# npm (All platforms)
npm install -g git-quick-cli
# pip (Python)
pip install git-quick
First Run: gq will automatically guide you through AI setup on first use!
See all installation options →
Features
Core Commands
-
gq- Combinesgit add,commit, andpushwith smart defaults- Auto-detects branch
- AI-generated commit messages from diffs
- Emoji/scope support (gitmoji-style)
- Interactive mode for fine-tuning
-
gq story- Compact, colorized commit summary- Shows commits since last release/tag
- Grouped by author, date, or type
- Export to markdown for changelogs
-
gq time start- Track development time per branch/feature- Automatic time tracking per branch
- Reports with breakdowns
- Integration with time-tracking tools
-
gq sync- Update all local branches safely- Stash uncommitted changes
- Fast-forward all branches
- Conflict detection and reporting
-
gq --setup- Run setup wizard- Configure/Change AI providers
- Configure other settings
VS Code Extension (In Progress)
- Format commit messages with templates
- AI commit message suggestions in editor
- One-click git-quick from command palette
- Status bar integration
Installation
Quick Install (Works immediately with smart fallback)
# npm (All platforms)
npm install -g git-quick-cli
# pip (Python)
pip install git-quick
Note: gq works immediately after installation! It uses intelligent commit message generation based on your changes. For AI-powered messages, optionally install Ollama (see below).
Optional: AI-Powered Messages (Ollama)
For enhanced AI commit messages, install Ollama (free, runs locally):
# macOS/Linux
curl -fsSL https://ollama.ai/install.sh | sh
# Or visit: https://ollama.ai/download
# Pull a model
ollama pull llama3
From Source
git clone https://github.com/vswaroop04/git-quick.git
cd git-quick
pip install -e .
See Installation Guide for detailed instructions.
📚 Documentation
- Quick Start - Get started in 5 minutes
- Installation - Platform-specific installation
- AI Setup - Configure AI providers
- Configuration - All configuration options
- Usage Guide - Complete command reference
- Contributing - How to contribute
Quick Start
# First time: Run setup wizard
gq --setup
# Or just run gq and it will prompt you automatically
gq
# Other commands
gq story # See your commit story
gq time report # Track your time
gq sync # Sync all branches
First-Time Setup
On your first run, gq will ask you to choose an AI provider:
-
Ollama (Recommended) - Free, local, private AI
- Automatically installs and downloads model
- No API keys needed
-
OpenAI - Best quality, requires API key
- Enter your API key when prompted
-
Anthropic (Claude) - Great for technical commits
- Enter your API key when prompted
-
No AI - Smart fallback mode
- Works immediately, no setup needed
You can always reconfigure later with gq --setup
Configuration
Create ~/.gitquick.toml:
[quick]
auto_push = true
emoji_style = "gitmoji"
ai_provider = "ollama" # or "openai", "anthropic"
[story]
default_range = "last-release"
color_scheme = "dark"
[time]
auto_track = true
idle_threshold = 300 # seconds
License
MIT
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file git_quick-1.4.0.tar.gz.
File metadata
- Download URL: git_quick-1.4.0.tar.gz
- Upload date:
- Size: 22.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1af1b0c96b806c815b5631ffd8617cb2bb5bbca95bb1a1086105974283c0fdbb
|
|
| MD5 |
cbace3b46c8910e97ebdd6df7c1750c0
|
|
| BLAKE2b-256 |
c3638e7a94688461b52e75ff937fd58027140bdff5e7dfaced9dec4dc3b650e2
|
File details
Details for the file git_quick-1.4.0-py3-none-any.whl.
File metadata
- Download URL: git_quick-1.4.0-py3-none-any.whl
- Upload date:
- Size: 23.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1dac0b550a2fe061496795cf6e7a4dcfc09cd871269d075180f8ad1652210e1c
|
|
| MD5 |
baabfa321c2b2e6f8bf56fc8927dc7cc
|
|
| BLAKE2b-256 |
3080fb51aec2307f66b18e117bfe92eaf8243cff65c007de9a7019f6edf2d3b5
|