CLI

workflows-manager [OPTIONS...] <action> [ACTION OPTIONS...]

Main Parser

Argument	Default	Required	Choices	Description
action		true	version | validate | run | list	Subcommands for managing workflows.

Subparser: action

Parser: version

This parser returns the version of the application.

Parser: validate

This parser validates the configuration file.

Argument	Default	Required	Choices	Description
--imports | -i		false		List of paths to the workflows modules
--configuration-file | -c		false		Path to the configuration file with workflows and steps. If not provided, then it will try to search for workflows.yaml or workflows.json in the current working directory.
--disable-error-codes	false	false		Disable error codes for exceptions. It changes behavior of the application to always return 0 as an exit status code.
--disable-current-path-import	false	false		Disable automatic import of the modules from the current path.
--log-level | -ll	info	false	debug | info | warning | error | critical	Logging level of the application.
--log-file | -lf		false		Path to the log file. If not provided, it won't log to a file.
--console-log-format | -clf	text	false	text | json	Format of the log messages in the console.
--file-log-format | -flf	text	false	text | json	Format of the log messages in the file.
--workflow-name | -w		false		Name of the workflow to validate. If not provided, it will validate that required parameters have been provided and all necessary steps have been registered.
--parameter | -p		false		Parameter for the workflow. Format: <name>:<type>:<value>. Supported types: str - string int - integer bool - boolean float - float list - list (delimiter: ,) dict - dictionary (JSON format)
--string-parameter | -sp		false		String parameter for the workflow. Format: <name>:<value>.
--integer-parameter | -ip		false		Integer parameter for the workflow. Format: <name>:<value>.
--boolean-parameter | -bp		false		Boolean parameter for the workflow. Format: <name>:<value>.
--float-parameter | -fp		false		Float parameter for the workflow. Format: <name>:<value>.
--list-parameter | -lp		false		List parameter for the workflow (delimiter: ,). Format: <name>:<value>.
--dict-parameter | -dp		false		Dictionary parameter for the workflow (JSON format). Format: <name>:<value>.

Parser: run

This parser runs the workflow.

Argument	Default	Required	Choices	Description
--imports | -i		false		List of paths to the workflows modules
--configuration-file | -c		false		Path to the configuration file with workflows and steps. If not provided, then it will try to search for workflows.yaml or workflows.json in the current working directory.
--disable-error-codes	false	false		Disable error codes for exceptions. It changes behavior of the application to always return 0 as an exit status code.
--disable-current-path-import	false	false		Disable automatic import of the modules from the current path.
--log-level | -ll	info	false	debug | info | warning | error | critical	Logging level of the application.
--log-file | -lf		false		Path to the log file. If not provided, it won't log to a file.
--console-log-format | -clf	text	false	text | json	Format of the log messages in the console.
--file-log-format | -flf	text	false	text | json	Format of the log messages in the file.
--status-file | -sf		false		Path to the file where the statuses of the particular steps will be stored.
--parameter | -p		false		Parameter for the workflow. Format: <name>:<type>:<value>. Supported types: str - string int - integer bool - boolean float - float list - list (delimiter: ,) dict - dictionary (JSON format)
--string-parameter | -sp		false		String parameter for the workflow. Format: <name>:<value>.
--integer-parameter | -ip		false		Integer parameter for the workflow. Format: <name>:<value>.
--boolean-parameter | -bp		false		Boolean parameter for the workflow. Format: <name>:<value>.
--float-parameter | -fp		false		Float parameter for the workflow. Format: <name>:<value>.
--list-parameter | -lp		false		List parameter for the workflow (delimiter: ,). Format: <name>:<value>.
--dict-parameter | -dp		false		Dictionary parameter for the workflow (JSON format). Format: <name>:<value>.
--workflow-name | -w	default	false		Name of the workflow to run.

Parser: list

This parser lists all available workflows.

Argument	Default	Required	Choices	Description
--configuration-file | -c		false		Path to the configuration file with workflows and steps. If not provided, then it will try to search for workflows.yaml or workflows.json in the current working directory.