semvec/pypi-packages huggingface dataset:
gicom 0.2.1
AI-powered Git commit messages generated directly from your terminal.
License: MIT
Requires Python: >=3.8


# Gicom 

**AI-powered Git commit messages generated directly from your terminal.**

> Stop writing "fixed stuff" or "wip". Let the ghost in the machine write professional, Conventional Commit messages for you.

## ✨ Features

* **Zero Friction:** One command (`gicom get-ai`) to generate and copy.
* **Professional Format:** Follows [Conventional Commits](https://www.conventionalcommits.org/) (feat:, fix:, chore:).
* **Secure:** Your OpenAI API Key is stored locally in `~/.config/gicom/`.
* **Context Aware:** Analyzes your actual `git diff` to understand what changed.

## 📦 Installation

To install gicom from PyPI:

```bash
pip install gicom

```


## 🚀 Setup

The first time you run gicom, it will prompt you for your OpenAI API key.

1. Get your API key from the [OpenAI Platform](https://platform.openai.com/api-keys).  
   If you see an `insufficient_quota` error, make sure you have added some credit to your account.
   Even $1 is usually enough, since the model used by gicom is very inexpensive.

2. Run the tool:
```bash
gicom get-ai

```

3. Paste your key when prompted (input will be hidden for security).

## 🛠️ Usage

### The Workflow

This is designed for speed. It generates the message and copies it to your clipboard automatically.

1. Stage your changes:
```bash
git add .

```


2. Summon the Ghost:
```bash
gicom get-ai

```


3. **Paste:** Press `Cmd + V` (or `Ctrl + V`) into your commit box (VS Code, GitHub Desktop, or Terminal).

### The "Interactive" Workflow

If you prefer to commit directly from the terminal with a confirmation step:

```bash
gicom commit

```


## 🔒 Security

* Your API Key is stored in `~/.config/gicom/config.json`.
* The file permissions are set to `600` (User Read/Write only).
* Your key is sent only to OpenAI servers for message generation and is never shared elsewhere.