Back to projects

AI Tools & Applications

Smart Git CLI

Conventional Commit messages and release notes, written from your git diff.

commands
2commands
characters of diff max
~6kcharacters of diff max
license
MITlicense

// at a glance

The problem and the idea

The problem

Good commit messages and changelogs take time, so they are often skipped or vague. That makes history hard to read and releases hard to explain.

The idea

A small command-line tool reads the staged diff, asks gpt-4o-mini for a Conventional Commit message, shows a preview and commits only after you confirm. A second command turns the commits since the last tag into a changelog.

// who it's for

Who it's for

  • 01

    Developers who want clean Conventional Commits without the effort

  • 02

    Maintainers who need a changelog for each release

  • 03

    Small teams keeping a readable git history

// how it works

How it works

staged diffgpt-4o-miniY/n previewcommittag..HEADCHANGELOG.mdsmart-git commit · smart-git release

1/4 Read the diff

Swipe sideways to see the whole diagram →

// key features

Key features

  • Works in any git repository after a single install
  • Interactive confirmation before every commit
  • Cost-aware: short prompts, a small token limit and a diff cap of about 6,000 characters
  • Clear errors for a missing API key, a missing repository or an empty diff
  • API key read from a git-ignored .env file

// design decisions

Design decisions

  1. 01

    Nothing is committed without an explicit yes from the user.

  2. 02

    The diff size is capped, so a huge change can't produce a huge bill.

// built with

Built with

  • Python
  • Typer
  • OpenAI API
  • Git
  • CLI

Run it locally

$ pip install git+https://github.com/Khayal07/Smart-Git-CLI.git