Calling Options
***************

The following options are available for the |gen_command_name| command:

.. _gen_command_options:

.. list-table:: |gen_command_name| options
    :header-rows: 1

    * - Option
      - Description
      - Optional
    * - **--gen-object-root**
      - Specifies the absolute or relative path of the folder to be scanned for object file retrieval. 
        The scanning process is performed recursively.
        If a relative path is provided, it is resolved against the project folder (``--dir``)
      - No
    
The General Options, valid for all commands, are listed in :ref:`global-options <global-options>`.

Examples
========

The simplest form of a call uses only the :ref:`gen-object-root <gen_command_options>` parameter:

.. code:: bash

    rta-sqf gen --gen-object-root ="C:\project\Build"

----

An alternative way is to use the :ref:`dir <gen_command_options>` parameter:

.. code:: bash
  
    rta-sqf gen --dir="C:\project" --gen-object-root ="Build"

----

The :ref:`only <gen_command_options>` option can be used to limit validation to a subset of AoUs:

.. code:: bash

    rta-sqf gen --gen-object-root ="C:\project\Build" --only=ETAS_RTACAR_SM_GEN_031
    rta-sqf gen --gen-object-root ="C:\project\Build" --only=ETAS_RTACAR_SM_GEN_031,ETAS_RTACAR_SM_GEN_030

----

The :ref:`ignore <gen_command_options>` option can be used to exclude a subset of AoUs from validation:

.. code:: bash

    rta-sqf gen --gen-object-root ="C:\project\Build" --ignore=ETAS_RTACAR_SM_GEN_031
    rta-sqf gen --gen-object-root ="C:\project\Build" --ignore=ETAS_RTACAR_SM_GEN_031,ETAS_RTACAR_SM_GEN_030

----

By defining the :ref:`verbose <gen_command_options>` option, additional information about the execution will be shown on the console 

.. code:: bash

    rta-sqf gen --gen-object-root ="C:\project\Build" --verbose

----

To choose the folder where the rta-sqf tool will store the results, use the :ref:`out-dir <gen_command_options>` option

.. code:: bash

    rta-sqf gen --gen-object-root ="C:\project\Build" --out-dir=".\checkResult" --verbose

.. note:: Output folder creation

    If the specified output directory does not exist, the tool will attempt to create it.