| Name | git-quick JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Lightning-fast Git workflows with AI-powered commit messages |
| upload_time | 2025-11-03 12:39:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
git
cli
productivity
ai
commit
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Git Quick - Lightning-fast Git workflows
[](https://pypi.org/project/git-quick/)
[](https://www.npmjs.com/package/git-quick-cli)
[](LICENSE)
[](https://www.python.org/)
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
```bash
# npm (All platforms)
npm install -g git-quick-cli
# pip (Python)
pip install git-quick
```
**First Run:** git-quick will automatically guide you through AI setup on first use!
[See all installation options →](docs/INSTALLATION.md)
## Features
### Core Commands
- **`git-quick`** - Combines `git add`, `commit`, and `push` with smart defaults
- Auto-detects branch
- AI-generated commit messages from diffs
- Emoji/scope support (gitmoji-style)
- Interactive mode for fine-tuning
- **`git-quick story`** - Compact, colorized commit summary
- Shows commits since last release/tag
- Grouped by author, date, or type
- Export to markdown for changelogs
- **`git-quick time start`** - Track development time per branch/feature
- Automatic time tracking per branch
- Reports with breakdowns
- Integration with time-tracking tools
- **`git-quick sync`** - Update all local branches safely
- Stash uncommitted changes
- Fast-forward all branches
- Conflict detection and reporting
- **`git-quick --setup`** - Run setup wizard
- Configure 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)
```bash
# npm (All platforms)
npm install -g git-quick-cli
# pip (Python)
pip install git-quick
```
**Note:** git-quick 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):
```bash
# macOS/Linux
curl -fsSL https://ollama.ai/install.sh | sh
# Or visit: https://ollama.ai/download
# Pull a model
ollama pull llama3
```
### From Source
```bash
git clone https://github.com/vswaroop04/git-quick.git
cd git-quick
pip install -e .
```
**See [Installation Guide](docs/INSTALLATION.md) for detailed instructions.**
## 📚 Documentation
- **[Quick Start](QUICKSTART.md)** - Get started in 5 minutes
- **[Installation](docs/INSTALLATION.md)** - Platform-specific installation
- **[AI Setup](docs/setup/AI_SETUP.md)** - Configure AI providers
- **[Configuration](docs/setup/CONFIGURATION_GUIDE.md)** - All configuration options
- **[Usage Guide](docs/USAGE.md)** - Complete command reference
- **[Contributing](CONTRIBUTING.md)** - How to contribute
**[📖 View All Documentation →](docs/README.md)**
## Quick Start
```bash
# First time: Run setup wizard
git-quick --setup
# Or just run git-quick and it will prompt you automatically
git-quick
# Other commands
git-story # See your commit story
git-time report # Track your time
git-sync-all # Sync all branches
```
### First-Time Setup
On your first run, git-quick will ask you to choose an AI provider:
1. **Ollama** (Recommended) - Free, local, private AI
- Automatically installs and downloads model
- No API keys needed
2. **OpenAI** - Best quality, requires API key
- Enter your API key when prompted
3. **Anthropic (Claude)** - Great for technical commits
- Enter your API key when prompted
4. **No AI** - Smart fallback mode
- Works immediately, no setup needed
You can always reconfigure later with `git-quick --setup`
## Configuration
Create `~/.gitquick.toml`:
```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
Raw data
{
"_id": null,
"home_page": null,
"name": "git-quick",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "git, cli, productivity, ai, commit",
"author": null,
"author_email": "Vishnu Swaroop <vswaroop04@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3f/7a/674f77d0b54fbd531d76a7621b16fac17c81886b31d8daba6fecc92a0d23/git_quick-1.0.0.tar.gz",
"platform": null,
"description": "# Git Quick - Lightning-fast Git workflows\n\n[](https://pypi.org/project/git-quick/)\n[](https://www.npmjs.com/package/git-quick-cli)\n[](LICENSE)\n[](https://www.python.org/)\n\nA modern CLI tool and VS Code extension that speeds up repetitive Git commands with smart defaults, AI-powered commit messages, and developer productivity features.\n\n## \u26a1 Quick Install\n\n```bash\n# npm (All platforms)\nnpm install -g git-quick-cli\n\n# pip (Python)\npip install git-quick\n```\n\n**First Run:** git-quick will automatically guide you through AI setup on first use!\n\n[See all installation options \u2192](docs/INSTALLATION.md)\n\n## Features\n\n### Core Commands\n\n- **`git-quick`** - Combines `git add`, `commit`, and `push` with smart defaults\n\n - Auto-detects branch\n - AI-generated commit messages from diffs\n - Emoji/scope support (gitmoji-style)\n - Interactive mode for fine-tuning\n\n- **`git-quick story`** - Compact, colorized commit summary\n\n - Shows commits since last release/tag\n - Grouped by author, date, or type\n - Export to markdown for changelogs\n\n- **`git-quick time start`** - Track development time per branch/feature\n\n - Automatic time tracking per branch\n - Reports with breakdowns\n - Integration with time-tracking tools\n\n- **`git-quick sync`** - Update all local branches safely\n\n - Stash uncommitted changes\n - Fast-forward all branches\n - Conflict detection and reporting\n\n- **`git-quick --setup`** - Run setup wizard\n - Configure AI providers\n - Configure other settings\n\n### VS Code Extension (In Progress)\n\n- Format commit messages with templates\n- AI commit message suggestions in editor\n- One-click git-quick from command palette\n- Status bar integration\n\n## Installation\n\n### Quick Install (Works immediately with smart fallback)\n\n```bash\n# npm (All platforms)\nnpm install -g git-quick-cli\n\n# pip (Python)\npip install git-quick\n```\n\n**Note:** git-quick works immediately after installation! It uses intelligent commit message generation based on your changes. For AI-powered messages, optionally install Ollama (see below).\n\n### Optional: AI-Powered Messages (Ollama)\n\nFor enhanced AI commit messages, install Ollama (free, runs locally):\n\n```bash\n# macOS/Linux\ncurl -fsSL https://ollama.ai/install.sh | sh\n\n# Or visit: https://ollama.ai/download\n\n# Pull a model\nollama pull llama3\n```\n\n### From Source\n\n```bash\ngit clone https://github.com/vswaroop04/git-quick.git\ncd git-quick\npip install -e .\n```\n\n**See [Installation Guide](docs/INSTALLATION.md) for detailed instructions.**\n\n## \ud83d\udcda Documentation\n\n- **[Quick Start](QUICKSTART.md)** - Get started in 5 minutes\n- **[Installation](docs/INSTALLATION.md)** - Platform-specific installation\n- **[AI Setup](docs/setup/AI_SETUP.md)** - Configure AI providers\n- **[Configuration](docs/setup/CONFIGURATION_GUIDE.md)** - All configuration options\n- **[Usage Guide](docs/USAGE.md)** - Complete command reference\n- **[Contributing](CONTRIBUTING.md)** - How to contribute\n\n**[\ud83d\udcd6 View All Documentation \u2192](docs/README.md)**\n\n## Quick Start\n\n```bash\n# First time: Run setup wizard\ngit-quick --setup\n\n# Or just run git-quick and it will prompt you automatically\ngit-quick\n\n# Other commands\ngit-story # See your commit story\ngit-time report # Track your time\ngit-sync-all # Sync all branches\n```\n\n### First-Time Setup\n\nOn your first run, git-quick will ask you to choose an AI provider:\n\n1. **Ollama** (Recommended) - Free, local, private AI\n\n - Automatically installs and downloads model\n - No API keys needed\n\n2. **OpenAI** - Best quality, requires API key\n\n - Enter your API key when prompted\n\n3. **Anthropic (Claude)** - Great for technical commits\n\n - Enter your API key when prompted\n\n4. **No AI** - Smart fallback mode\n - Works immediately, no setup needed\n\nYou can always reconfigure later with `git-quick --setup`\n\n## Configuration\n\nCreate `~/.gitquick.toml`:\n\n```toml\n[quick]\nauto_push = true\nemoji_style = \"gitmoji\"\nai_provider = \"ollama\" # or \"openai\", \"anthropic\"\n\n[story]\ndefault_range = \"last-release\"\ncolor_scheme = \"dark\"\n\n[time]\nauto_track = true\nidle_threshold = 300 # seconds\n```\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Lightning-fast Git workflows with AI-powered commit messages",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/vswaroop04/git-quick#readme",
"Homepage": "https://github.com/vswaroop04/git-quick",
"Repository": "https://github.com/vswaroop04/git-quick"
},
"split_keywords": [
"git",
" cli",
" productivity",
" ai",
" commit"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8d0183382be120e53777b01c523325f5a7e9a5eb5f10f82bbb0e41a0b09b4b61",
"md5": "642a4345ef3b8672c5d446fb46eb9522",
"sha256": "501bbdb53f15979f0c1c134bb7a7aaceb3109dec6ae2a1b682e91650de5a8b2f"
},
"downloads": -1,
"filename": "git_quick-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "642a4345ef3b8672c5d446fb46eb9522",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22219,
"upload_time": "2025-11-03T12:39:42",
"upload_time_iso_8601": "2025-11-03T12:39:42.134102Z",
"url": "https://files.pythonhosted.org/packages/8d/01/83382be120e53777b01c523325f5a7e9a5eb5f10f82bbb0e41a0b09b4b61/git_quick-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3f7a674f77d0b54fbd531d76a7621b16fac17c81886b31d8daba6fecc92a0d23",
"md5": "89691009f608b8e1100bf6ac161ff449",
"sha256": "7a2e0e557677864fd6b3821e306159be8c5ff2a629c7408679aeb05dbc9a3d6c"
},
"downloads": -1,
"filename": "git_quick-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "89691009f608b8e1100bf6ac161ff449",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21929,
"upload_time": "2025-11-03T12:39:43",
"upload_time_iso_8601": "2025-11-03T12:39:43.650223Z",
"url": "https://files.pythonhosted.org/packages/3f/7a/674f77d0b54fbd531d76a7621b16fac17c81886b31d8daba6fecc92a0d23/git_quick-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-03 12:39:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vswaroop04",
"github_project": "git-quick#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "git-quick"
}
