Documentation

Introduction

Hunknote is an AI-powered CLI tool that goes beyond simple commit message generation. Its standout feature, Compose Mode, analyzes your working tree changes and intelligently splits them into a clean stack of atomic, well-documented commits — turning hours of manual git work into seconds.

Whether you have a single focused change or a working tree full of mixed modifications, Hunknote handles it:

• Single change? Generate a polished commit message instantly in the style of your choice
• Mixed changes? Let Compose split them into logical, atomic commits automatically

Why Hunknote?

The Problem: Developers often accumulate multiple unrelated changes before committing. Manually splitting these into atomic commits is tedious — you need to carefully stage hunks, write messages for each, and ensure nothing gets lost.

The Solution: Hunknote's Compose Mode analyzes your entire diff, understands which changes belong together, and creates a clean commit stack automatically.

Your messy working tree          What Compose creates
─────────────────────────        ────────────────────
 M src/auth.py                   C1: feat(auth): Add login endpoint
 M src/api.py                    C2: fix(api): Handle null responses
 M README.md                     C3: docs: Update API documentation
 M tests/test_auth.py            C4: test(auth): Add login tests

Key Capabilities