git-ai-summary 0.1.0

CLI tool to generate README, CHANGELOG, and PR descriptions using Groq AI

git-ai-summary

CLI tool that auto-generates README, CHANGELOG, and PR descriptions from your git history using Groq AI (Llama 3.3 70B).

Features

• git-ai readme — scans your repo and generates a professional README.md
• git-ai changelog --since <tag> — generates a Keep-a-Changelog section from commits
• git-ai pr-desc — generates a GitHub PR description from staged changes
• Rich Markdown preview in terminal (--preview)
• Pipe-friendly: raw Markdown goes to stdout by default

Requirements

• Python 3.9+
• A Groq API key (free tier available)

Installation

pip install git-ai-summary

Or from source:

git clone https://github.com/wquintili88/git-ai-summary
cd git-ai-summary
pip install -e .

Configuration

cp .env.example .env
# Open .env and set your GROQ_API_KEY

Or export directly in your shell:

export GROQ_API_KEY=gsk_...

Usage

# Generate README (print to stdout)
git-ai readme

# Save directly to file
git-ai readme -o README.md

# Render Markdown preview in terminal
git-ai readme --preview

# Generate CHANGELOG since a tag
git-ai changelog --since v1.0.0
git-ai changelog --since v1.0.0 --version-label v1.1.0 -o CHANGELOG.md

# Generate PR description from staged changes
git add .
git-ai pr-desc
git-ai pr-desc --preview

Options

Command	Flag	Description
all	--repo PATH	Path to git repo (default: .)
all	--output / -o PATH	Write output to file
all	--preview / -p	Render Markdown in terminal
changelog	--since / -s REF	Tag or SHA to compare from (required)
changelog	--version-label	Release label (e.g. v1.2.0)

Security

• Never commit your .env file — it is listed in .gitignore
• The .env.example file contains only placeholder values and is safe to commit

Contributing

Pull requests are welcome. For major changes, open an issue first to discuss what you'd like to change.

License

MIT