Installation
Recommended: Install from PyPI
# Using pipx (isolated environment)
pipx install hunknote
# Or using pip
pip install hunknote
Alternative: Install from source
git clone https://github.com/nash911/hunknote.git
cd hunknote
poetry install
Verify installation
hunknote --help
git hunknote --help
Initial Setup
Run the interactive configuration wizard:
hunknote init
This will:
- Prompt you to select an LLM provider
- Let you choose a model
- Securely store your API key
Configuration is saved to ~/.hunknote/.
Tip: You can reconfigure anytime by running
hunknote initagain.
Your First Commit Message
# 1. Stage your changes
git add <files>
# 2. Generate a commit message
hunknote
# 3. Review and commit
hunknote commit
That's it! Hunknote analyzes your staged changes and generates an appropriate commit message.