Skip to main content

Global CLI tool for productivity

Project description

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

If quick command is not recognized after installation:

Option 1: Using pipx (recommended)

pipx ensurepath
# Restart your terminal

Option 2: Using pip

# Add Python Scripts to PATH (adjust Python version as needed)
setx PATH "%PATH%;%USERPROFILE%\AppData\Local\Programs\Python\Python312\Scripts"
# Restart your terminal

Verify installation:

quick doctor

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

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

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

quick_assistant-0.1.8.tar.gz (54.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quick_assistant-0.1.8-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file quick_assistant-0.1.8.tar.gz.

File metadata

  • Download URL: quick_assistant-0.1.8.tar.gz
  • Upload date:
  • Size: 54.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for quick_assistant-0.1.8.tar.gz
Algorithm Hash digest
SHA256 07ccf72aeb4bb7852d7a0bcf7315d0d78630d037dd70392103a2cf30c4f2b98d
MD5 f48229df13db766f1c33f7fb19f78f09
BLAKE2b-256 3f7f656e1356159e28a5a63e7fb639a3e4f38aaf236d0305be0a2832e8bf3a29

See more details on using hashes here.

Provenance

The following attestation bundles were made for quick_assistant-0.1.8.tar.gz:

Publisher: release.yml on rafaeelricco/quick-assistant

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quick_assistant-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for quick_assistant-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c7d988c93a9cd9521a1d229273ab1da075c41823c75d35eff2b67e0d46ba8eff
MD5 8e1b0d406062f10e3aa08bc1b99bc0f8
BLAKE2b-256 d68cd27a2d4b8b04ec6c93a05fa1118e5457cfcf875e4060417c267674962b54

See more details on using hashes here.

Provenance

The following attestation bundles were made for quick_assistant-0.1.8-py3-none-any.whl:

Publisher: release.yml on rafaeelricco/quick-assistant

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page