Skip to content

communique generate

  • Usage: communique generate [FLAGS] <TAG> [PREV_TAG]
  • Effect: read-only

Generate release notes for a git tag

Arguments

  • <TAG> — Git tag to generate release notes for
  • [PREV_TAG] — Previous tag (auto-detected if omitted)

Flags

  • --draft <DRAFT> — Save editable release title, body, changelog, and review as JSON

    Effect: modifies state

  • --review-report <REVIEW_REPORT> — Write a Markdown coverage report with sources and omission reasons

    Effect: modifies state

  • --migration-guide <MIGRATION_GUIDE> — Write an upgrade guide with affected users and before/after examples

    Effect: modifies state

  • --package <PACKAGE> — Generate notes for a package configured in communique.toml

  • --path <PATH> — Limit changes to repository-relative paths (repeatable)

  • --tag-pattern <TAG_PATTERN> — Only consider baseline tags matching this git glob

  • --channel <CHANNEL> — Baseline channel: stable excludes prereleases; all includes them

    Choices: stable, all

  • --changelog-path <CHANGELOG_PATH> — Changelog destination relative to the repository root

  • --preserve-sections — Replace only the communique-marked section of a GitHub release

  • --github-release — Push editorialized notes to the GitHub release

    Effect: modifies state

  • --changelog — Update CHANGELOG.md with the generated changelog entry

    Effect: modifies state

  • --concise — Output concise changelog entry instead of detailed notes

  • -n --dry-run — Generate notes without updating GitHub or verifying links

  • --repo <REPO> — GitHub repo in owner/repo format (auto-detected from git remote)

  • --model <MODEL> — LLM model to use

  • --max-tokens <MAX_TOKENS> — Max response tokens

  • --provider <PROVIDER> — LLM provider (anthropic or openai, auto-detected from model if omitted)

  • --base-url <BASE_URL> — Base URL for the LLM API

  • -o --output <OUTPUT> — Write output to a file instead of stdout

    Effect: modifies state

  • -h --help — Print help

MIT LicenseCopyright © 2026jdx.dev