rougail/docs/user_data/prerequisites.rst

Prerequisites
=============

Installation
------------

We assume that Rougail's command line is :ref:`installed <installation>` on your computer.

Verify that you have correctly installed the tool by running:

.. code-block:: bash
   :class: terminal 


        $ rougail --cli.versions
        tiramisu: x.x.x
        tiramisu-cmdline-parser: x.x.x
        rougail: x.x.x
        rougail-cli: x.x.x
        rougail-user-data-ansible: x.x.x
        rougail-user-data-bitwarden: x.x.x
        rougail-user-data-commandline: x.x.x
        rougail-user-data-environment: x.x.x
        rougail-user-data-questionary: x.x.x
        rougail-user-data-yaml: x.x.x
        rougail-output-ansible: x.x.x
        rougail-output-display: x.x.x
        rougail-output-doc: x.x.x
        rougail-output-formatter: x.x.x
        rougail-output-json: x.x.x
        rougail-output-table: x.x.x

Smoke test
----------

We need a Rougail structured data file to test and illustrate the different user data loading modules.

.. literalinclude:: example.yaml
   :caption: A example of structured data file place in the :file:`example.yaml` structure file

Let's test this :term:`structure file`:

.. code-block:: bash
   :class: terminal 

        $ rougail -m example.yaml

The output has to be:

.. raw:: html
    :class: terminal

        <span style="font-weight: bold; color: #ff0000">🛑 Caution</span>
        <span style="color: #ff0000">┗━━ </span>Description of a person
        <span style="color: #ff0000">    </span><span style="color: #ff0000">┣━━ </span>Last name of the person: <span style="color: #ff0000">🛑 mandatory variable but has no value</span>
        <span style="color: #ff0000">    </span><span style="color: #ff0000">┣━━ </span>Last names of the person: <span style="color: #ff0000">🛑 mandatory variable but has no value</span>
        <span style="color: #ff0000">    </span><span style="color: #ff0000">┣━━ </span>Person's age: <span style="color: #ff0000">🛑 mandatory variable but has no value</span>
        <span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>Means of transport used by the person: <span style="color: #ff0000">🛑 mandatory variable but has no value</span>