Skip to content

Command-line interface

Nomage can be used directly from the command line through its dedicated command-line interface (CLI), which provides a fast and convenient alternative to the Python API for common use cases.

Interface

The CLI is intentionally minimal and focused on built-in naming conventions. Its full usage and available options can be discovered using help flag:

$ nomage --help
usage: nomage [-h] [-V] [-t TO_CONVENTION] [-c CHECK_CONVENTION] [identifier]

nomage - Utility for parsing and converting naming conventions

positional arguments:
  identifier

options:
  -h, --help            show this help message and exit
  -V, --version         print version and exit
  -t TO_CONVENTION, --to TO_CONVENTION
  -c CHECK_CONVENTION, --check CHECK_CONVENTION

Exit codes

The CLI uses standard exit codes:

  • 0 - success
  • 1 - runtime failure: unrecognized naming convention
  • 2 - invalid arguments or failed check

These exit codes can be used in scripts and CI pipelines.

Limitations