ScallopConf

If true, scallop would try to guess missing option names from the names of their fields.

If set to true, scallop would try to guess missing option names from the names of their fields.

Add subcommand to this config

Adds a validation function to this configuration. This function will be run after all other verification steps.

Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).

If set to true, scallop would append auto-generated text about default option value to option descriptions.

If set to true, scallop would append auto-generated text about default option value to option descriptions.

Checks that this Conf object is verified. If it is not, throws an exception.

Add a banner string to option builder.

Add a new choice option definition to this config.

This option takes a single string argument and restricts values to a list of possible choices.

Add a check that either all or none of the provided options have values supplied in arguments.

Add a check that none of the options in the list were supplied if opt was supplied.

Add a check that all of the options in the list were also supplied if opt was supplied.

Add a check that at least one of the options in the list was supplied if opt was supplied.

Get summary of current parser state, hididng values for some of the options. Useful if you log the summary and want to avoid storing sensitive information in the logs (like passwords)

Add a footer string to this builder.

Get full generated help contents (with version, banner, option usage and footer) as a string.

Get generated help contents as a string.

Get version string.

Create and return a new option group

Get current custom help formatter.

Set custom help formatter.

Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.

Options, that are to be printed first in the help printout

Add a check that only one or zero of the provided options have values supplied in arguments.

If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.

If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.

Add new number argument definition to this config and get a holder for it's value.

Parses arguments like -1 or -3 (like GNU tail, for example).

Add a new simple option definition to this config.

Prints help message (with version, banner, option usage and footer) to stdout.

Add new property option definition to this config object.

This option will parse arguments like -Dkey=value or -D key1=value1 key2=value2.

Add new property option definition to this config object.

This option will parse arguments like --Props key1=value1 key2=value2.

Add a check that at least one of the options is supplied.

Add a check that at one and only one option in the list is supplied.

Require subcommand to be provided (validation will fail if no subcommand was provided on the command line).

If set to true, do not output subcommand options in the help output for the main program (only output short subcommand description in such cases). Full help for subcommand options can still be accessed via program subcommand-name --help.

Retrieves the choosen subcommand.

Retrieves the list of the chosen nested subcommands.

Get summary of current parser state.

Add a new tally option definition to this config.

Tally options count how many times the option was provided on the command line. E.g., -vvv will be countet as 3.

Add new toggle option definition to this config, and get a holder for it's value.

Toggle options are just glorified flag options. For example, if you create a toggle option with name "verbose", it will be invocable in three ways - "--verbose", "--noverbose", "-v".

Add new trailing argument definition to this config.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

Validate that file does not exists.

Validate that file exists.

Validate that file argument is directory.

Validate that file is not a directory.

Validate that all the files in the arguments to multi-arg option do not exist.

Validate that all the files in the arguments to multi-arg option exist.

Validate that all the files in the arguments to multi-arg option are directories.

Validate that all the files in the arguments to multi-arg option are not directories.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Adds a validation function to this configuration. This function will be run after all other verification steps.

Validate that path does not point to the existing file.

Validate that path points to the existing file.

Validate that path points to a directory.

Validate that path points to a file (not directory).

Validate that path target does not exist.

Validate that path target exists.

Validate that paths targets exist.

Validate that all paths targets are files (not directories).

Verify this configuration - parse the arguments, convert option values, run validations. This method MUST be called at the end of all options definitions, attempts to access option values before it is called will result in runtime exception.

Add a version string to option builder.

Set options, that are to be printed first in the help printout

Internal immutable builder for options setup.

This function is called with the error message when ScallopException occurs. By default, this function prints message (prefixed by printedName) to stderr, coloring the output if possible, then calls exitHandler(1).

Update this variable with another function if you need to change that behavior.

This function is called with an exit code when Scallop thinks it's time to terminate. By default this calls sys.exit(exitCode).

Update this variable with another function if you need to change that behavior.

This name would be included in output when reporting errors.

This function is called with a string when Scallop needs to output text to stderr. Update this variable if you need to redirect stderr output somewhere else.

This function is called with a string when Scallop needs to output text to stdout. Update this variable if you need to redirect stdout output somewhere else.