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

## Configuration for rougail-console

> **🛈 Informations**
> 
> **Path**: console\
> *`disabled`*\
> **Disabled**: if console is not set in "[Select for output](#step.output)"

| Variable                                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Default value                           | Type                                                                                            | Validator                |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|-------------------------------------------------------------------------------------------------|--------------------------|
| **<a id="console.show_secrets" name="console.show_secrets">console.show_secrets</a>**<br/>**Command line**: <br/>•&nbsp;--console.show_secrets<br/>•&nbsp;--console.no-show_secrets<br/>**Environment variable**: ROUGAILCLI_CONSOLE.SHOW_SECRETS                                     | Show secrets instead of obscuring them.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | false                                   | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |                          |
| **<a id="console.mandatory" name="console.mandatory">console.mandatory</a>**<br/>**Command line**: <br/>•&nbsp;--console.mandatory<br/>•&nbsp;--console.no-mandatory<br/>**Environment variable**: ROUGAILCLI_CONSOLE.MANDATORY                                                       | Test mandatories variables before display in console.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | do not test if "cli.read_write" is true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |                          |
| **<a id="console.key_is_description" name="console.key_is_description">console.key_is_description</a>**<br/>**Command line**: <br/>•&nbsp;--console.key_is_description<br/>•&nbsp;--console.no-key_is_description<br/>**Environment variable**: ROUGAILCLI_CONSOLE.KEY_IS_DESCRIPTION | In tree the key is the family or variable description inside of it&#x27;s name<br/>#<br/>#  undocumented_modes:<br/>#    description: Variables with those modes are not documented<br/>#    multi: true<br/>#    mandatory: false<br/>#    disabled:<br/>#      jinja: |<br/>#        {% if not modes_level %}<br/>#        there is no mode<br/>#        {% endif %}<br/>#      description: disabled when there is no mode available<br/>#    validators:<br/>#      - jinja: |<br/>#          {% if _.undocumented_modes not in modes_level %}<br/>#          this mode is not available<br/>#          {% endif %}<br/>#        description: verify if disable modes already exists. | true                                    | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |                          |
| **<a id="console.max_width" name="console.max_width">console.max_width</a>**<br/>**Command line**: --console.max_width<br/>**Environment variable**: ROUGAILCLI_CONSOLE.MAX_WIDTH                                                                                                     | Maximum number of characters per line.<br/>Null means unlimited.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                         | [`integer`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)             | The minimum value is 50. |