Skip to content

topmark.cli.keys

topmark / cli / keys

Canonical CLI option spellings for TopMark.

This module defines the stable string spellings exposed by the TopMark CLI layer, primarily long option names (e.g. --include-file-types).

Centralizing these values avoids string duplication, prevents drift between command definitions, and makes refactors (renames, aliases, deprecations) explicit and auditable.

Design notes
  • CLI option spellings (CliOpt) are user-facing and should be changed with care.
  • Parsed argument destination keys are defined in topmark.core.keys.ArgKey.
  • This module is intentionally behavior-free; it is a pure namespace of constants.

CliCmd

Command names exposed by the TopMark CLI.

These values are the Click command names (e.g., topmark check).

CliOpt

User-facing long option spellings for the TopMark CLI.

Notes
  • Each constant is the canonical long option spelling exposed to users.
  • Values include the leading --.
  • Short options are defined in CliShortOpt, not in this namespace.

CliShortOpt

User-facing short option spellings for the TopMark CLI.

Notes
  • Each constant is the canonical short option spelling exposed to users.
  • Values include the leading -.
  • Long options are defined in CliOpt, not in this namespace.