CHANGO(1)

📦
version 0.6.1 · 2 versions
, in ubuntu stonking

✨ NAME ✨

chango — Sphinx extension for changelog generation 💖 (yes, the CLI is part of the whole vibe)

👑 CHANGO 👑

okay so, bestie, meet the CLI for chango — the CHANGelog GOvernor for Your Project. She runs your changelog like a group chat admin: everything in its place, nobody posting out of order 🫶

chango [OPTIONS] COMMAND [ARGS]...

💅 Options

  • --version — shows the version and bounces. that's it, that's the whole job.
    • Default: False
  • --install-completion — installs completion for whatever shell you're currently living in ✨
  • --show-completion — prints the completion for your current shell so you can copy it, or customize the installation yourself. DIY queen behavior 👑

🎀 Arguments

this is where the commands live. no cap, there is exactly one command chilling at the top level, and it's config — everything else hangs out underneath her, like a very organized little family tree 🌸

🌈 config

Shows or verifies the configuration of the chango CLI.

chango config [OPTIONS] COMMAND [ARGS]...

Options

  • --path <path> — the path to the pyproject.toml file. Input behavior as for chango.config.ChanGoConfig.load. (iykyk 💅)

Arguments

the sub-commands under config are show, validate, edit, new, release, and report. scroll down, they're all here bestie 👇

🦋 show

Shows the configuration. literally just ✨ reveals it ✨

chango config show [OPTIONS]

Options — none, it's a no-frills icon.

Arguments — none either. she simply serves.

✅ validate

Validates the configuration. vibe check for your config, and it will not be nice about it if something's off 😭

chango config validate [OPTIONS]

Options — nope, none.

Arguments — none.

📝 edit

Edits an existing change note in the default editor. opens it up, you do your thing, you save, you close 💖

chango edit [OPTIONS] UID

Options — none listed.

Arguments

  • UID — Required argument. the unique identifier of the change note to edit.

🎀 new

Creates a new change note. fresh note, fresh start, main character energy ⭐

chango new [OPTIONS]

Options

  • -s, --slug <slug> — Required. the slug of the change note.
  • -e, --edit, -ne, --no-edit — whether to open the change note in the default editor.
    • Default: True

Arguments — none.

🚀 release

Releases the unreleased changes to a new version. the big moment. the reveal. the drop 🔥

chango release [OPTIONS]

Options

  • --uid <uid> — Required. the unique identifier of the version release.
  • --date <date> — the date of the version release. defaults to today.
    • Default: 'datetime.date.today()'

Arguments — none.

📊 report

Generates reports for one or multiple versions. receipts, basically 🧾✨

chango report [OPTIONS] COMMAND [ARGS]...

Options — none.

Arguments — the sub-commands under report are history and version. both below, keep reading bestie 🫶

🌸 history

Prints a report of the version history. the whole timeline, the entire arc, the character development 👑

chango report history [OPTIONS]

Options

  • -m, --markup <markup> — the markup language to use for the report.
    • Default: <MarkupLanguage.MARKDOWN: 'markdown'>
  • -o, --output <output> — the file to write to. if it's not specified, the output gets printed to the console instead.

Arguments — none.

💜 version

Prints a report of the change notes for a specific version. zooming in on one era 💅

chango report version [OPTIONS]

Options

  • --uid <uid> — Required. the unique identifier of the version to report on. leave it empty for unreleased changes.
  • -m, --markup <markup> — the markup language to use for the report.
    • Default: <MarkupLanguage.MARKDOWN: 'markdown'>
  • -o, --output <output> — the file to write to. if it's not specified, the output gets printed to the console instead.

Arguments — none.

2024, Hinrich Mahler 💖

and that's the whole page, bestie! this was version 0.6.1, dated Jul 04, 2026 — slay, iconic, no notes 🌈✨💅

📦 where this page comes from