changelog-ai

Zero-config AI-powered changelog generator. Reads your git history and generates clean, professional release notes — no conventional commits required.

Install

npx changelog-ai

Usage

npx changelog-ai              # Generate changelog from last tag to HEAD
npx changelog-ai --all        # Generate changelog from all commits
npx changelog-ai --from v1.0  # Changes since v1.0
npx changelog-ai --no-ai      # Skip AI, use heuristic grouping
npx changelog-ai --stdout     # Output to terminal instead of CHANGELOG.md

AI Mode

Set OPENAI_API_KEY or ANTHROPIC_API_KEY to enable AI-powered summarization:

export OPENAI_API_KEY=sk-...
npx changelogai

Without an API key, changelogai automatically falls back to heuristic-based commit classification.

Options

| Option | Default | Description | |--------|---------|-------------| | --all | false | Include all commits, not just since last tag | | --from <ref> | last tag | Start from a specific tag, branch, or commit | | --output <file> | CHANGELOG.md | Output file path | | --no-ai | false | Disable AI, use heuristic grouping only | | --provider <name> | auto | Force AI provider (openai or anthropic) | | --version-tag <tag> | date | Version header (e.g. v1.2.0) | | --stdout | false | Print to terminal instead of writing a file |

How It Works

1. Reads git log from your repository
2. Classifies commits by type (features, fixes, docs, etc.)
3. With AI: summarizes and groups into user-friendly release notes
4. Without AI: uses pattern matching to categorize commits
5. Writes markdown to CHANGELOG.md (or stdout)

License

MIT