changelogdev-cli

Generate beautiful changelogs from your git commits. Parses conventional commits, groups by type, and outputs colorful terminal summaries or clean Markdown files.

Install

npm install -g changelogdev-cli

Or use with npx:

npx changelogdev-cli

Usage

# Generate changelog from all commits in current repo
changelog

# Filter by date range
changelog --from 2024-01-01 --to 2024-03-01

# Filter by commit type
changelog --type feat,fix

# Write to file (Markdown format)
changelog --output CHANGELOG.md

# Specify a different repo
changelog --repo /path/to/repo

# Combine options
changelog --from 2024-01-01 --type feat,fix --output CHANGELOG.md

Conventional Commits

The CLI automatically parses conventional commits and groups them:

| Prefix | Category | |--------|----------| | feat: | Features | | fix: | Bug Fixes | | docs: | Documentation | | perf: | Performance | | refactor: | Refactoring | | test: | Tests | | build: | Build System | | ci: | CI/CD | | chore: | Chores |

Non-conventional commits are grouped under "Other Changes".

Output Formats

Terminal (default): Colorized, grouped output with commit hashes.

Markdown (--output): Clean Markdown with headers, bullet points, and commit references.

Examples

Terminal Output

Changelog - 2024-03-07
──────────────────────────────────────────────────

Features (3)
  a1b2c3d (auth) Add OAuth2 login flow
  d4e5f6a (api) Add webhook endpoints
  g7h8i9j Add dark mode toggle

Bug Fixes (2)
  k1l2m3n (ui) Fix dropdown z-index issue
  o4p5q6r Fix memory leak in event handler

──────────────────────────────────────────────────
5 commits total

Powered by Changelog.dev - https://www.changelogdev.com

Changelog.dev

Want hosted changelogs your customers actually read? Check out Changelog.dev - beautiful hosted changelog pages for SaaS products with AI-powered generation from GitHub commits.

License

MIT