Skip to main content

Syntax

Command Syntax

Stable

Use the supported generation forms and place global execution options at the Custy root.

Commandcusty changelog generate

Category

Changelog

Quick Command

custy changelog generate [OPTIONS]
syntaxCLIdry-run

Overview​

Use the direct changelog command for standalone generation. Command-specific options follow generate; global execution options precede changelog.

Supported Command Forms

Command Syntax

Available command syntax and usage examples.

Generate with resolved configuration

Generate or update CHANGELOG.md using CLI overrides, project configuration, and built-in defaults.

bash
custy changelog generate

Force regeneration

Request regeneration even when changelog content already exists.

bash
custy changelog generate --force

Use another pending commit template

Override the configured commit-message template for this invocation.

bash
custy changelog generate --commit-msg-file path/to/commit-message.txt

Preview through the global option

Pass dry-run at the root command level before the changelog command group.

bash
custy --dry-run changelog generate

Global Option Placement

Terminal
bash
custy --dry-run changelog generate
custy --debug changelog generate
custy --log-level debug changelog generate

Root options must appear before the changelog command group.