Add subcommand to this config
Add subcommand to this config
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
list of options
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.
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.
Checks that this Conf object is verified. If it is not, throws an exception.
Add a banner string to option builder.
Internal immutable builder for options setup.
Internal immutable builder for options setup.
Add a new choice option definition to this config.
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.
List of possible argument values.
Name for new option, used as long option name in parsing, and for option identification.
Overload the char that will be used as short option name. Defaults to first character of the name.
Description for this option, for help description.
Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).
Is this option required? Defaults to false.
The name for this option argument, as it will appear in help. Defaults to "arg".
If set to true, then this option will be hidden from generated help output.
If set to true, then this option does not have any short name.
Option group to add this option to.
ScallopOption, container for the parsed option value.
Add a check that either all or none of the provided options have values supplied in arguments.
Add a check that either all or none of the provided options have values supplied in arguments.
list of codependent options
Add a check that none of the options in the list were supplied if opt
was supplied.
Add a check that none of the options in the list were supplied if opt
was supplied.
option that conflicts with all of options in list
list of dependencies (all will need to be absent)
Add a check that all of the options in the list were also supplied if opt
was supplied.
Add a check that all of the options in the list were also supplied if opt
was supplied.
option that depends on all of options in list
list of dependencies (all will need to be present)
Add a check that at least one of the options in the list was supplied if opt
was supplied.
Add a check that at least one of the options in the list was supplied if opt
was supplied.
option, that depends on any of options in list
list of dependencies (at least one will need to be present)
Short description for this subcommand.
Short description for this subcommand. Used if parent command has shortSubcommandsHelp enabled.
This function is called with the error message when ScallopException occurs.
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.
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.
Get summary of current parser state, hididng values for some of the options.
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)
names of the options that should be hidden.
a list of all options in the builder
Add a footer string to this builder.
Get full generated help contents (with version, banner, option usage and footer) as a string.
Get full generated help contents (with version, banner, option usage and footer) as a string.
Get generated help contents as a string.
Get generated help contents as a string.
Get version string.
Get version string.
Create and return a new option group
Create and return a new option group
If true, scallop would try to guess missing option names from the names of their fields.
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.
If set to true, scallop would try to guess missing option names from the names of their fields.
Get current custom help formatter.
Get current custom help formatter.
Set custom help formatter.
Set custom help formatter.
Explicitly set width of help printout.
Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.
true if this config does not represent a subcommand
true if this config does not represent a subcommand
Options, that are to be printed first in the help printout
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.
Add a check that only one or zero of the provided options have values supplied in arguments.
list of mutually exclusive options
If set to true, then do not generate short names for subsequently defined options by default.
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.
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.
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).
Name for new definition, used for identification.
Description for this option, for help text.
The function that validates the parsed value.
Is this trailing argument required? Defaults to true.
If this argument is not required and not found in the argument list, use this value.
If set to true then this option will not be present in auto-generated help.
Option group to add this option to.
The converter for this option. Usually found implicitly.
ScallopOption, container for the parsed option value.
This function is called in event of any exception in arguments parsing.
This function is called in event of any exception in arguments parsing. By default, it catches only standard Scallop errors, letting all other pass through.
Add a new simple option definition to this config.
Add a new simple option definition to this config.
Name for new option, used as long option name in parsing, and for option identification.
By default, the first character of option name is used for short option name. You can override it by specifying the required character (short = 'c'
).
Description for the option. Will be printed in help message, carefully formatted to the output width (80 characters by default).
Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).
The function that validates the parsed value.
Is this option required? Defaults to false.
The name for this option argument, as it will appear in help. Defaults to "arg".
Hides description of this option from help (this can be useful for debugging options).
If set to true, then this option does not have any short name.
Option group to add this option to.
The converter for this option. Usually found implicitly.
ScallopOption, container for the parsed option value.
Pointer to parent ScallopConf
Pointer to parent ScallopConf
Prints help message (with version, banner, option usage and footer) to stdout.
Prints help message (with version, banner, option usage and footer) to stdout.
This name would be included in output when reporting errors.
This name would be included in output when reporting errors.
Add new property option definition to this config object.
Add new property option definition to this config object.
This option will parse arguments like -Dkey=value
or -D key1=value1 key2=value2
.
Character that will be used as prefix for property arguments.
Description for this property option, for help description.
Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".
Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".
If set to true, then this option will be hidden from generated help output.
Option group to add this option to.
The converter for this option. Usually found implicitly.
ScallopOption, container for the parsed option value.
Add new property option definition to this config object.
Add new property option definition to this config object.
This option will parse arguments like --Props key1=value1 key2=value2
.
Name for new option, used as long option name in parsing, and for option identification.
Description for this property option, for help description.
Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".
Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".
If set to true, then this option will be hidden from generated help output.
Option group to add this option to.
The converter for this option. Usually found implicitly.
ScallopOption, container for the parsed option value.
Add a check that at least one of the options is supplied.
Add a check that at least one of the options is supplied.
list of options (at least one must be present)
Add a check that at one and only one option in the list is supplied.
Add a check that at one and only one option in the list is supplied.
list of conflicting options (exactly one must be present)
Require subcommand to be provided (validation will fail if no subcommand was provided on the command line).
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).
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
.
enable short format for subcommand help
This function is called with a string when Scallop needs to output text to stderr.
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.
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.
Retrieves the choosen subcommand.
Retrieves the choosen subcommand.
Retrieves the list of the chosen nested subcommands.
Retrieves the list of the chosen nested subcommands.
List of sub-configs of this config.
List of sub-configs of this config.
Get summary of current parser state.
Get summary of current parser state.
a list of all options in the builder, and corresponding values for them.
Add a new tally option definition to this config.
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
.
Name for new option, used as long option name in parsing, and for option identification.
Overload the char that will be used as short option name. Defaults to first character of the name.
Description for this option, for help description.
If set to true, then this option will be hidden from generated help output.
If set to true, then this option does not have any short name.
Option group to add this option to.
ScallopOption, container for the parsed option value.
Add new toggle option definition to this config, and get a holder for it's value.
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".
Name of this option
default value for this option
Overload the char that will be used as short option name. Defaults to first character of the name.
If set to true, then this option will not have any short name.
Prefix to name of the option, that will be used for "negative" version of the option.
Description for positive variant of this option.
Description for negative variant of this option.
Is this option required? Defaults to false.
If set to true, then this option will not be present in auto-generated help.
Option group to add this option to.
ScallopOption, container for the parsed option value.
Add new trailing argument definition to this config.
Add new trailing argument definition to this config.
Name for new definition, used for identification.
Description for this option, for help text.
The function that validates the parsed value.
Is this trailing argument required? Defaults to true.
If this argument is not required and not found in the argument list, use this value.
If set to true then this option will not be present in auto-generated help.
Option group to add this option to.
The converter for this option. Usually found implicitly.
ScallopOption, container for the parsed option value.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
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.
Validation function. In case of error, it should return Left with the error message.
Validate that file does not exists.
Validate that file does not exists.
Validate that file exists.
Validate that file exists.
Validate that file argument is directory.
Validate that file argument is directory.
Validate that file is not a 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 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 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 directories.
Validate that all the files in the arguments to multi-arg option are not directories.
Validate that all the files in the arguments to multi-arg option are not directories.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Adds a validation function to this configuration.
Adds a validation function to this configuration. This function will be run after all other verification steps.
Validation function. In case of error, it should return Left with the error message.
Validate that path does not point to the existing file.
Validate that path does not point to the existing file.
Validate that path points 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 directory.
Validate that path points to a file (not directory).
Validate that path points to a file (not directory).
Validate that path target does not exist.
Validate that path target does not exist.
Validate that path target exists.
Validate that path target exists.
Validate that paths targets exist.
Validate that paths targets exist.
Validate that all paths targets are files (not directories).
Validate that all paths targets are files (not directories).
Verify this configuration - parse the arguments, convert option values, run validations.
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
Set options, that are to be printed first in the help printout
(Since version Scallop 4.0.0) Use option groups instead, for example see https://github.com/scallop/scallop/wiki/Help-information-printing#option-groups
Base class for CLI subcommands.