Go to repository

Interface CLIAppOptions

A set of options for initially configure a CLI application. If a translation is given

interface CLIAppOptions {
    flags?: CLIGeneralFlags;
    texts: CLIGeneralTexts;
}

Properties

Properties

Optional

The flag names to use in this application, if the flags differ in any way from the default ones.

The default flags include:

  • help: -h, --help
  • version: -v, --version
  • language selection: -l, --language
  • input file for a command: -i, --in
  • output file for a command: -o, --out

The description texts that is used as the description of the different parts of the CLI. The name and the versionNumber are expected to be the app name (No translation is used, as the name should be the same through all the app), and the versionNumber should be the version in the major.minor.patch format.