quick-assistant 0.2.8

Global CLI tool for productivity

Quick Assistant

CLI tool for productivity, focused on quick daily operations.

Installation

# Recommended (isolated environment)
pipx install quick-assistant

# Or via pip
pip install quick-assistant

Windows Users

After pipx install quick-assistant, if quick is not recognized:

Step 1: Add pipx bin to PATH

pipx ensurepath

Step 2: Restart your terminal completely

Close and reopen PowerShell/CMD. A new tab is NOT enough - close the entire window.

Step 3: Verify

quick doctor

Alternative: Run directly without PATH

If you can't restart or modify PATH, use the full path:

# pipx installation location
%USERPROFILE%\.local\bin\quick.exe doctor
%USERPROFILE%\.local\bin\quick.exe commit

Requirements

Option 1: Run setup (recommended)

quick setup

Option 2: Environment variable (for CI/CD)

export GOOGLE_API_KEY="your-api-key"

Get your API key at: https://aistudio.google.com/apikey

Setup

On first run, Quick Assistant will guide you through setup:

quick setup

Configuration includes:

• Commit convention - Choose your preferred style:
  • Conventional Commits (feat:, fix:, refactor:, etc.)
  • Imperative (simple verbs: add, fix, update)
  • Custom template (with {diff} placeholder)
• API key - Your Google Gemini API key

Configuration is saved to ~/.quick-assistant/config.json.

Commands

Setup

Configure Quick Assistant with your API key and commit style preferences.

quick setup

Commit

AI-powered git commit message generation with interactive flow.

quick commit

Doctor

Diagnose installation and PATH issues (especially helpful on Windows; it checks the Scripts and pipx paths).

quick doctor

Features

• Fast AI-powered responses
• Colored and organized output
• Compatible with Windows, macOS, Linux
• Informative error messages

Examples

• quick setup - Configure API key and commit style
• quick commit - Generate AI commit message
• quick update - Update to latest version
• quick doctor - Diagnose installation issues (Windows PATH)

Uninstall

# If installed with pipx
pipx uninstall quick-assistant

# If installed with pip
pip uninstall quick-assistant