rougail-cli/README.fr.md

Options de la ligne de commande
===============================

.. note::

    | Il est possible d'utiliser Rougail directement en ligne de commande. Il est possible de définir et configurer facilement les données utilisateur chargées, ainsi que la définition de la sortie souhaité.
    | **Chemin** : cli



.. list-table::

   * - Variable
     - Description

   * - **cli.config_file**

       `UNIX filename <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `multiple` `obligatoire` `unique`

       **Variable d'environnement** : ROUGAILCLI_CLI.CONFIG_FILE
     - Charger les paramètres de la ligne de commande depuis un fichier.

       **Validateurs** : 

       

       - le nom de fichier peut être une chemin relatif

       - 'type de fichier autorisé: "directory" et "file"'

       

       **Défaut** : 

       

       - .rougailcli.yml

   * - **cli.debug**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       

       - --cli.debug

       - --cli.no-debug

       

       **Variable d'environnement** : ROUGAILCLI_CLI.DEBUG
     - Afficher les informations de debug.

       **Défaut** : false

   * - **cli.warnings**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       

       - --cli.warnings

       - --cli.no-warnings

       

       **Variable d'environnement** : ROUGAILCLI_CLI.WARNINGS
     - Afficher les avertissements de chargement des options de la ligne de commande.

       **Défaut** : true

   * - **cli.versions**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       

       - --cli.versions

       - --cli.no-versions

       

       **Variable d'environnement** : ROUGAILCLI_CLI.VERSIONS
     - Afficher la version de Rougail et de tous ces composants.

       **Défaut** : false

   * - **cli.invalid_user_data_error**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       

       - --cli.invalid_user_data_error

       - --cli.no-invalid_user_data_error

       

       **Variable d'environnement** : ROUGAILCLI_CLI.INVALID_USER_DATA_ERROR
     - Les valeurs invalides dans les données utilisateur ne sont pas autorisées.

       **Défaut** : false

   * - **cli.unknown_user_data_error**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       

       - --cli.unknown_user_data_error

       - --cli.no-unknown_user_data_error

       

       **Variable d'environnement** : ROUGAILCLI_CLI.UNKNOWN_USER_DATA_ERROR
     - Les variables inconnues dans les données utilisateur ne sont pas autorisées.

       **Défaut** : false

   * - **cli.layers**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire` `*cachée*`

       **Ligne de commande** : 

       

       - -cl, --cli.layers

       - -ncl, --cli.no-layers

       

       **Variable d'environnement** : ROUGAILCLI_CLI.LAYERS
     - Charger chaque données utilisateurs dans des couches séparées.

       **Défaut** : false

       **Cachée** : si seulement un type de données utilisateur est renseigné dans "sélection pour user data" (step.user_data).

   * - **cli.tiramisu_cache**

       `UNIX filename <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__

       **Ligne de commande** : 

       -ct, --cli.tiramisu_cache

       **Variable d'environnement** : ROUGAILCLI_CLI.TIRAMISU_CACHE
     - Nom du fichier d'enregistrement du cache de Tiramisu.

       Ce fichier contient les instructions Tiramisu utilisé en interne pour charger les variables."

       

       Ce fichier peut est utilisé pour charger Tiramisu depuis un cache au lieu de le regénérer".

       **Validateurs** : 

       

       - le nom de fichier peut être une chemin relatif

       - 'type de fichier autorisé: "file"'

   * - **cli.load_from_tiramisu_cache**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire` `*désactivé*`

       **Ligne de commande** : 

       

       - --cli.load_from_tiramisu_cache

       - --cli.no-load_from_tiramisu_cache

       

       **Variable d'environnement** : ROUGAILCLI_CLI.LOAD_FROM_TIRAMISU_CACHE
     - Utiliser le cache pour charger les objets Tiramisu.

       Il sera chargé à partir du cache uniquement si celui-ci existe déjà.

       

       Attention, certain données utilisateur ou sortie peuvent changer la manière dont sont chargés les fichiers de structure (c'est notamment le cas avec la sortie doc). Il est préférable de n'utiliser le cache pour le même type de données utilisateur et sortie.

       **Défaut** : false

       **Désactivé** : lorsque la variable "Nom du fichier d'enregistrement du cache de Tiramisu" (cli.tiramisu_cache) a la valeur "null".

   * - **cli.root**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__

       **Ligne de commande** : 

       -cr, --cli.root

       **Variable d'environnement** : ROUGAILCLI_CLI.ROOT
     - Utiliser la sortie uniquement pour les variables enfants de la famille.

       Par défaut, toutes les variables accessible sont inclus dans la sortie. Il est possible de définir la famille a partir de laquelle la sortie devra être générée.

   * - **cli.read_write**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       

       - --cli.read_write

       - --cli.no-read_write

       

       **Variable d'environnement** : ROUGAILCLI_CLI.READ_WRITE
     - La configuration dans l'état de sortie est dans mode lecture-écriture.

       **Défaut** : false

   * - **cli.mandatory**

       `boolean <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       

       - --cli.mandatory

       - --cli.no-mandatory

       

       **Variable d'environnement** : ROUGAILCLI_CLI.MANDATORY
     - Test les valeurs obligatoires.

       Cette configuration doit être valide avant de lancer le processus de sortie. Il est préférable de valider les valeurs au début du processus.

       **Défaut** : si "La configuration dans l'état de sortie est dans mode lecture-écriture" (cli.read_write) est false.

   * - **cli.description_type**

       `choice <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `obligatoire`

       **Ligne de commande** : 

       -cd, --cli.description_type

       **Variable d'environnement** : ROUGAILCLI_CLI.DESCRIPTION_TYPE
     - Type de description des variables.

       Pour identifier les différentes variables, on utilise la description de la variable. Il y a quatre type de descriptions:

       - name_and_description : qui contient le nom de la variable suivi de sa description - path : le chemin de la variable - name : le nom de la variable - description : la description de la variable.

       

       **Choix** : 

       

       - path_and_description

       - name_and_description

       - path

       - name

       - description **← (défaut)**

   * - **cli.inaccessible_read_only_modes**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `multiple` `*désactivé*` `unique`

       **Ligne de commande** : 

       --cli.inaccessible_read_only_modes

       **Variable d'environnement** : ROUGAILCLI_CLI.INACCESSIBLE_READ_ONLY_MODES
     - Modes quoi doivent être inaccessible en mode lecture seule.

       **Validateur** : un mode doit exister dans "Tous les niveaux de modes valides" (modes_level)

       **Désactivé** : si aucun mode n'est défini dans "Tous les niveaux de modes valides" (modes_level).

   * - **cli.inaccessible_read_write_modes**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `multiple` `*désactivé*` `unique`

       **Ligne de commande** : 

       --cli.inaccessible_read_write_modes

       **Variable d'environnement** : ROUGAILCLI_CLI.INACCESSIBLE_READ_WRITE_MODES
     - Modes quoi doivent être inaccessible en mode lecture-écriture.

       **Validateur** : un mode doit exister dans "Tous les niveaux de modes valides" (modes_level)

       **Désactivé** : si aucun mode n'est défini dans "Tous les niveaux de modes valides" (modes_level).

   * - **cli.inaccessible_modes**

       `string <https://rougail.readthedocs.io/en/latest/variable.html#variables-types>`__ `multiple` `*désactivé*` `unique`

       **Ligne de commande** : 

       -ci, --cli.inaccessible_modes

       **Variable d'environnement** : ROUGAILCLI_CLI.INACCESSIBLE_MODES
     - Modes quoi doivent être inaccessible.

       **Validateur** : un mode doit exister dans "Tous les niveaux de modes valides" (modes_level)

       **Désactivé** : si aucun mode n'est défini dans "Tous les niveaux de modes valides" (modes_level).