Commands

Command Structure

Main Command

The main command accepts several options for changelog generation:

• -v, --version: Show the version and exit
• -o, --old: First pack to compare (mandatory for changelog generation)
• -n, --new: The pack to compare against (mandatory for changelog generation)
• -c, --config: Use a custom configuration file
• -f, --file: Specify the output file for the changelog
• -h, --help, ,-?: print this help message.

Subcommands

newconfig

Creates a new default configuration file in the current directory called config.json with default settings.

Special Output Modes

The CLI supports several special output modes through the --file parameter :

• unformatted: Returns raw data tuples instead of formatted markdown
• formatted: Returns formatted markdown as a string without writing to file
• console: Prints the formatted changelog directly to the console

Usage Examples

Basic Changelog Generation

modpack-changelogger --old old_pack.mrpack --new new_pack.mrpack

This generates a Changelog.md file by default.

Custom Output File

modpack-changelogger --old old_pack.mrpack --new new_pack.mrpack --file my_changelog.md

Using Configuration File and print to console

modpack-changelogger --old old_pack.mrpack --new new_pack.mrpack --config my_config.json -f console

Creating Configuration File

modpack-changelogger newconfig

Version Information

modpack-changelogger --version