Getting Started

GPTChangelog requires Python 3.12 or newer, Git history, and either an OpenAI API key or a Codex login.

Install

pip install gptchangelog

# Optional terminal UI
pip install 'gptchangelog[tui]'

For a one-off run:

uvx gptchangelog --help

Authenticate

OpenAI API:

export OPENAI_API_KEY='...'
gptchangelog config init

Codex subscription:

codex login
gptchangelog config init

GPTChangelog does not need to copy Codex tokens or read them directly. Check the resolved configuration with gptchangelog config validate.

Generate

From a tagged repository:

gptchangelog generate

GPTChangelog validates the Git range, calculates the next version locally, requests one structured release-note draft, validates it, and atomically inserts the rendered Markdown into CHANGELOG.md.

Preview raw Markdown without modifying files:

gptchangelog generate --dry-run > release.md

Generate JSON for automation:

gptchangelog generate --dry-run --format json > release.json

Use the higher-quality GPT-5.6 Sol profile:

gptchangelog generate --profile quality

The default balanced profile uses GPT-5.6 Terra.

Next steps

• Basic usage
• Configuration
• Output contract
• CI and advanced usage