Metadata-Version: 2.4
Name: rougail.cli
Version: 1.0.0
Summary: CLI for Rougail
Author-email: Emmanuel Garette <gnunux@gnunux.info>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Natural Language :: French
License-File: LICENSE
Requires-Dist: rougail >= 1.2.0,<2
Requires-Dist: rougail-user-data-commandline >= 1.0.0,<2
Project-URL: Home, https://forge.cloud.silique.fr/stove/rougail-cli

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



.. list-table::

   * - Variable
     - Description

   * - **cli.config_file**

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

       **Environment variable**: ROUGAILCLI_CLI.CONFIG_FILE
     - Loads command line parameters from a file.

       **Validators**: 

       

       - this filename could be a relative path

       - 'file type allowed: "directory" and "file"'

       

       **Default**: 

       

       - .rougailcli.yml

   * - **cli.debug**

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

       **Command line**: 

       

       - --cli.debug

       - --cli.no-debug

       

       **Environment variable**: ROUGAILCLI_CLI.DEBUG
     - Displays debug informations.

       **Default**: false

   * - **cli.warnings**

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

       **Command line**: 

       

       - --cli.warnings

       - --cli.no-warnings

       

       **Environment variable**: ROUGAILCLI_CLI.WARNINGS
     - Displays command line option warnings informations.

       **Default**: true

   * - **cli.versions**

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

       **Command line**: 

       

       - --cli.versions

       - --cli.no-versions

       

       **Environment variable**: ROUGAILCLI_CLI.VERSIONS
     - Displays Rougail version and all its components.

       **Default**: false

   * - **cli.invalid_user_data_error**

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

       **Command line**: 

       

       - --cli.invalid_user_data_error

       - --cli.no-invalid_user_data_error

       

       **Environment variable**: ROUGAILCLI_CLI.INVALID_USER_DATA_ERROR
     - Invalid value in user data is not allowed.

       **Default**: false

   * - **cli.unknown_user_data_error**

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

       **Command line**: 

       

       - --cli.unknown_user_data_error

       - --cli.no-unknown_user_data_error

       

       **Environment variable**: ROUGAILCLI_CLI.UNKNOWN_USER_DATA_ERROR
     - Unknown variable in user data is not allowed.

       **Default**: false

   * - **cli.layers**

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

       **Command line**: 

       

       - -cl, --cli.layers

       - -ncl, --cli.no-layers

       

       **Environment variable**: ROUGAILCLI_CLI.LAYERS
     - Open each user data in separate layers.

       **Default**: false

       **Hidden**: if only one user data is set in "select for user data" (step.user_data).

   * - **cli.tiramisu_cache**

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

       **Command line**: 

       -ct, --cli.tiramisu_cache

       **Environment variable**: ROUGAILCLI_CLI.TIRAMISU_CACHE
     - Store Tiramisu cache filename.

       This file contains the Tiramisu instructions used internally to load the variables."

       

       This file can be used for load Tiramisu from cache instead of regenerates it".

       **Validators**: 

       

       - this filename could be a relative path

       - 'file type allowed: "file"'

   * - **cli.load_from_tiramisu_cache**

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

       **Command line**: 

       

       - --cli.load_from_tiramisu_cache

       - --cli.no-load_from_tiramisu_cache

       

       **Environment variable**: ROUGAILCLI_CLI.LOAD_FROM_TIRAMISU_CACHE
     - Use cache for load Tiramisu objects.

       It will only be loaded from the cache if it already exists

       

       Note that certain user data or output can change how structure files are loaded (this is particularly true for the doc output). It is best to use the cache only for the same type of user data and output.

       **Default**: false

       **Disabled**: when the variable "Store Tiramisu cache filename" (cli.tiramisu_cache) has the value "null".

   * - **cli.root**

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

       **Command line**: 

       -cr, --cli.root

       **Environment variable**: ROUGAILCLI_CLI.ROOT
     - Use output only for the children variables of the family.

       By default, all accessible variables are included in output. It is possible to define the family from which the output should be generated.

   * - **cli.read_write**

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

       **Command line**: 

       

       - --cli.read_write

       - --cli.no-read_write

       

       **Environment variable**: ROUGAILCLI_CLI.READ_WRITE
     - Configuration in output step is in read_write mode.

       **Default**: false

   * - **cli.mandatory**

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

       **Command line**: 

       

       - --cli.mandatory

       - --cli.no-mandatory

       

       **Environment variable**: ROUGAILCLI_CLI.MANDATORY
     - Test mandatories variables.

       The configuration must be valid before process output. It's better to validate the values at the beginning of the process.

       **Default**: if "Configuration in output step is in read_write mode" (cli.read_write) is false.

   * - **cli.description_type**

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

       **Command line**: 

       -cd, --cli.description_type

       **Environment variable**: ROUGAILCLI_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.

       

       **Choices**: 

       

       - path_and_description

       - name_and_description

       - path

       - name

       - description **← (default)**

   * - **cli.inaccessible_read_only_modes**

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

       **Command line**: 

       --cli.inaccessible_read_only_modes

       **Environment variable**: ROUGAILCLI_CLI.INACCESSIBLE_READ_ONLY_MODES
     - Modes that should not be accessible in read_only mode.

       **Validator**: mode must exists in "All modes level available" (modes_level)

       **Disabled**: if any mode is set in "All modes level available" (modes_level).

   * - **cli.inaccessible_read_write_modes**

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

       **Command line**: 

       --cli.inaccessible_read_write_modes

       **Environment variable**: ROUGAILCLI_CLI.INACCESSIBLE_READ_WRITE_MODES
     - Modes that should not be accessible in read_write mode.

       **Validator**: mode must exists in "All modes level available" (modes_level)

       **Disabled**: if any mode is set in "All modes level available" (modes_level).

   * - **cli.inaccessible_modes**

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

       **Command line**: 

       -ci, --cli.inaccessible_modes

       **Environment variable**: ROUGAILCLI_CLI.INACCESSIBLE_MODES
     - Modes that should not be accessible.

       **Validator**: mode must exists in "All modes level available" (modes_level)

       **Disabled**: if any mode is set in "All modes level available" (modes_level).

