changelog-parse-cli

Parse, validate, and manage CHANGELOG.md files from the command line.

Follows the Keep a Changelog standard.

Install

npm install -g changelog-parse-cli
# or run directly
npx changelog-parse-cli <command>

Usage

changelog-parse-cli [options] <command>

Options:
  -f, --file <path>   Path to changelog file (default: CHANGELOG.md)
  --json              Output as JSON
  --md                Output as Markdown
  -V, --version       Show version
  -h, --help          Show help

Commands:
  show      Show releases (default)
  list      List all versions and dates
  validate  Validate changelog format
  generate  Generate release notes from git log

Commands

show — display releases

# Show all releases (coloured terminal output)
changelog-parse-cli show

# Show a specific version
changelog-parse-cli show --version 1.2.0

# Show the latest non-Unreleased release
changelog-parse-cli show --latest

# Filter by date range
changelog-parse-cli show --from 2024-01-01 --to 2024-12-31

# JSON output
changelog-parse-cli --json show --latest

# Markdown output
changelog-parse-cli --md show --version 2.0.0

list — list versions

changelog-parse-cli list
changelog-parse-cli --json list

validate — check format

changelog-parse-cli validate
changelog-parse-cli --file path/to/CHANGELOG.md validate

Exits with code 1 if errors are found.

generate — create release notes from git

# All commits up to HEAD
changelog-parse-cli generate 1.3.0

# Commits between two tags
changelog-parse-cli generate 1.3.0 --from v1.2.0 --to v1.3.0

# JSON output
changelog-parse-cli --json generate 1.3.0 --from v1.2.0

Commits are auto-classified into Keep a Changelog sections based on conventional commit prefixes (feat: → Added, fix: → Fixed, etc.).

Supported changelog formats

• Keep a Changelog (primary): ## [1.2.3] - 2024-01-15
• Unreleased section: ## [Unreleased]
• Yanked releases: ## [1.0.0] - 2024-01-01 [YANKED]

License

MIT