rougail-cli/README.md

---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)

## Command line options

> [!NOTE]
> 
> **Path**: cli

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