Options

The application provides a Command Line Interface (CLI) in form of options to direct its basic behavior. These options can be categorized as option that provide information or execute behavior and exit (exit options) or as options that direct runtime behavior (runtime or run options). Any option, or configuration, that goes beyond basic behavior can be configured using parameters.

Runtime Options

Runtime options direct the runtime behavior of the application. Most of these options set the initial behavior for the application, for instance the output level of loader, shell, or tasks; the shell prompt; or the print mode. Most runtime options can be also altered at runtime, except for the options setting the application mode.

-A, --all-mode - run application in mode 'all'

Starts the application in the mode all. In this mode, all tasks are loaded and no mode restrictions on the tasks are evaluated. This option is overwritten by the options --build-mode and --dev-mode.

-B, --build-mode - run application in mode 'build'

Starts the application in the mode build. In this mode, only tasks marked for build mode are loaded. This option is overwritten by the option --dev-mode.

-D, --dev-mode - run application in mode 'dev'

Starts the application in the mode dev. In this mode, only tasks marked for dev mode are loaded.

-L, --loader-level LEVEL - sets console level for the loader

This sets the output level for the application loader. The level can be set to:

  • off (only messages),

  • all (output everything),

  • fatal (only fatal errors),

  • error (all errors),

  • warn-strict (errors and strict warnings),

  • warn (all errors and warnings),

  • info (errors, warnings, and information),

  • debug (information plus debug information),

  • or trace (debug plus trace information).

    To turn off all print outs from the loader also use the option --lq.

--lq - quiet loader, no messages from loader

Puts the application loader into quiet mode. Here, the loader will not print any messages. Other output might still be printed, see --loader-level.

-P, --print-mode MODE - sets the print mode: ansi, text, text-anon

Sets the print mode for the application (loader, shell, tasks). The print mode directs how messages, errors, warnings, and other information are printed to the console. It can be set to: ansi (color and effects are printed using ANSI escape codes), text (plain text output), or adoc (Asciidoctor style annotated text). This setting can be changed at runtime using the task setting.

-r, --run-scenario FILE - run shell commands from scenario file

Runs a scenario from a file, i.e. the commands in the scenario file. The file is automatically loaded from the scenario directory. The file extension is optional.

-S, --shell-level LEVEL - sets console level for the shell

This sets the output level for the application shell. The level can be set to:

  • off (only messages),

  • all (output everything),

  • fatal (only fatal errors),

  • error (all errors),

  • warn-strict (errors and strict warnings),

  • warn (all errors and warnings),

  • info (errors, warnings, and information),

  • debug (information plus debug information),

  • or trace (debug plus trace information).

    The shell level can be changed at runtime using the task setting. To turn off all print outs from the shell also use the options --tq and --snp.

--snp - shell-no-prompt: switch off shell prompt

Turns off the shell prompt, i.e. the shell will not print a prompt if this option is used. The shell level can be changed at runtime using the task setting.

--sq - quiet shell, no messages from shell

Puts the application shell into quiet mode. Here, the shell will not print any messages. Other output might still be printed, see --shell-level and --snp.

-s, --strict - most warnings are treated as errors

Runs the program in strict mode. Here, all missing task dependencies are treated as errors. Errors cause the program to fail initialization. If not in strict mode, missing task dependencies result in the respective task not being loaded.

-T, --task-level LEVEL - sets console level for tasks

This sets the output level for all tasks. The level can be set to:

  • off (only messages),

  • all (output everything),

  • fatal (only fatal errors),

  • error (all errors),

  • warn-strict (errors and strict warnings),

  • warn (all errors and warnings),

  • info (errors, warnings, and information),

  • debug (information plus debug information),

  • or trace (debug plus trace information).

    The task level can be changed at runtime using the task setting. To turn off all print outs from tasks also use the option --tq.

--tq - quiet tasks, no messages from tasks

Puts the tasks into quiet mode. Here, tasks will not print any messages. Other output might still be printed, see --task-level.

Exit Options

Exit options for the application will produce a requested outcome and then the application will exit. Some of these options are to provide information, e.g. show the current configuration or describe an application element. Other options actually will execute a behavior, for instance execute a task or a scenario and then exit. This later category can be used to script more complex scenarios by calling the application multiple times executing different behavior.

-C, --clean-cache - cleans the application cache

Clears the application cache and exists. The application cache can be build using the task build-cache. It contains information about all application elements, including tasks. Clearing the cache can be necessary in some scenarios, for instance when new elements (e.g. tasks) have been added to an application.

-c, --configuration - show current runtime configuration

Prints current settings after processing all environment settings. The settings depend on the application mode, the loaded tasks, and the given environment or file settings. All settings are presented without the flavor prefix.

-d, --dependency DEP - print a help screen for a dependency

Shows a description for a given dependency and exits. The description is the same as in the application manual.

-e, --execute-task ID - executes task ID, put arguments after '--'

Executes a given tasks and exits. The long name should be used for the task, though this option also works for the short name. Additional task parameters can be added after a -- in the command line. All these options are directly handed over to the task.

-h, --help - print a help screen with CLI options

Shows a help screen with all command line options. The options are sorted alphabetically.

-m, --manual - print a manual

Prints this manual for the set print mode (see option --print-mode). The manual is created by the task build-manual.

-o, --option OPT - print a help screen for a CLI option

Shows a description for a given CLI option and exits. The description is the same as in the application manual.

-p, --parameter PARAM - print a help screen for a parameter

Shows a description for a given parameter and exits. The description is the same as in the application manual. The parameter can be given in upper or lower case spelling. Note: all parameters are used without the flavor prefix.

-V, --validate - validate

Validates the installation of the application and exits. Internally, the task validate-installation is called. The validation is done for all targets and in strict mode. This means that all warnings result in errors.

-v, --version - show program version

Prints the program version and exits. The actual printed information is: the application name, the string version and the version of the program.