ai-changelog-gen

Generate beautiful changelogs from git history using conventional commits.

Install

npm install -g ai-changelog-gen
# or use directly
npx ai-changelog-gen

Usage

# Generate from last tag to HEAD
npx ai-changelog-gen

# Between two tags/commits
npx ai-changelog-gen --from v1.0.0 --to v2.0.0

# Since a date
npx ai-changelog-gen --since "2024-01-01"

# Write to file
npx ai-changelog-gen -o CHANGELOG.md

# JSON output
npx ai-changelog-gen --format json

# Only unreleased changes (last tag → HEAD)
npx ai-changelog-gen --unreleased

Options

| Option | Description | |---|---| | --from <ref> | Start ref (tag, commit, branch) | | --to <ref> | End ref (default: HEAD) | | --since <date> | Include commits since date | | -o, --output <file> | Write output to file | | --format <fmt> | Output format: markdown | json | | --unreleased | Only unreleased changes (last tag → HEAD) | | --repo-url <url> | Repository URL for commit links | | --title <title> | Custom section title | | --no-links | Disable commit hash hyperlinks | | --cwd <path> | Working directory |

Conventional Commits

Recognized prefixes and their sections:

| Prefix | Section | |---|---| | feat: | ✨ Features | | fix: | 🐛 Bug Fixes | | perf: | ⚡ Performance Improvements | | refactor: | ♻️ Refactoring | | docs: | 📚 Documentation | | test: | 🧪 Tests | | build: | 🏗️ Build System | | ci: | 🤖 CI/CD | | style: | 💅 Styles | | chore: | 🔧 Chores | | revert: | ⏪ Reverts |

Breaking changes are detected from BREAKING CHANGE: in the commit body or ! after the type (e.g. feat!: rename API).

License

MIT