Basic Usage

Generate from HEAD

Generate notes for all commits since the last tag:

shipi generate

Specify a commit range

Use git revision syntax:

# From tag to HEAD
shipi generate v1.0.0..HEAD

# Between two tags
shipi generate v1.0.0..v1.1.0

# Last 10 commits
shipi generate HEAD~10..HEAD

# From a specific commit
shipi generate abc123..HEAD

Using —from and —to

shipi generate --from v1.0.0 --to v1.1.0

If --to is omitted, it defaults to HEAD:

shipi generate --from v1.0.0

Output to file

shipi generate -o CHANGELOG.md

Include diffs

By default, shipi only reads commit messages. Enable diff analysis for better results:

shipi generate --diff

This is especially useful when commit messages are vague or missing context.

Dry run

Preview what commits would be analyzed:

shipi generate --dry-run