Table of Contents

• Command line options

🇬🇧 (EN) - 🇫🇷 (FR)

Command line options

Note

It is possible to use Rougail directly from the command line. This makes it easy to define and configure the loaded user data and to define the desired output.
Path: cli

Variable	Description	Default value	Type	Access control	Validator
cli.config_file Environment variable: CLI.CONFIG_FILE	Loads command line parameters from a file.	• .rougailcli.yml	UNIX filename multiple		• this filename could be a relative path • file type allowed: "directory" and "file".
cli.debug Command line: • --cli.debug • --cli.no-debug Environment variable: CLI.DEBUG	Displays debug informations.	false	boolean mandatory
cli.warnings Command line: • --cli.warnings • --cli.no-warnings Environment variable: CLI.WARNINGS	Displays command line option warnings informations.	true	boolean mandatory
cli.versions Command line: • --cli.versions • --cli.no-versions Environment variable: CLI.VERSIONS	Displays Rougail version and all its components.	false	boolean mandatory
cli.invalid_user_data_error Command line: • --cli.invalid_user_data_error • --cli.no-invalid_user_data_error Environment variable: CLI.INVALID_USER_DATA_ERROR	Invalid value in user data is not allowed.	false	boolean mandatory
cli.unknown_user_data_error Command line: • --cli.unknown_user_data_error • --cli.no-unknown_user_data_error Environment variable: CLI.UNKNOWN_USER_DATA_ERROR	Unknown variable in user data is not allowed.	false	boolean mandatory
cli.layers Command line: • --cli.layers • --cli.no-layers Environment variable: CLI.LAYERS	Open each user data in separate layers.	false	boolean mandatory	hidden Hidden: if only one user data is set in "Select for user datas"
cli.read_write Command line: • --cli.read_write • --cli.no-read_write Environment variable: CLI.READ_WRITE	Configuration in output step is in read_write mode.	false	boolean mandatory
cli.description_type Command line: --cli.description_type Environment variable: CLI.DESCRIPTION_TYPE	Type of variables description. To identify different variables, we use the variable description. There are four types of description: - path_and_description: which contains the variable path followed by its description - name_and_description: which contains the variable name followed by its description - path: the variable's path - name: the variable name - description: the variable's description.	description	choice mandatory		Choices: • path_and_description • name_and_description • path • name • description
cli.inaccessible_read_write_modes Command line: --cli.inaccessible_read_write_modes Environment variable: CLI.INACCESSIBLE_READ_WRITE_MODES	Modes that should not be accessible in read_write mode.		string multiple	disabled Disabled: if any mode is set in "All modes level available"	unique Mode must exists in "All modes level available".
cli.inaccessible_modes Command line: --cli.inaccessible_modes Environment variable: CLI.INACCESSIBLE_MODES	Modes that should not be accessible.		string multiple	disabled Disabled: if any mode is set in "All modes level available"	unique Mode must exists in "All modes level available".