arx.cli

arx.cli

Source: packages/arx/src/arx/cli.py

title: Functions and classes for handling the CLI call.

Functions

get_args() -> argparse.ArgumentParser

title: Get the CLI arguments.
returns:
  type: argparse.ArgumentParser

get_test_args() -> argparse.ArgumentParser

title: Get the CLI arguments for `arx test`.
returns:
  type: argparse.ArgumentParser

show_version() -> None

title: Show the application version.

app(argv: Sequence[str] | None=None) -> None

title: Run the application.
parameters:
  argv:
    type: Sequence[str] | None

Classes

CustomHelpFormatter(argparse.RawTextHelpFormatter)

title: Formatter for generating usage messages and argument help strings.
summary: >-
  Only the name of this class is considered a public API. All the methods
  provided by the class are considered an implementation detail.