.. running:

Running
=======

The simplest way to run VHDLTest is:

.. code-block:: console

   > python -m VHDLTest --config <your-config.yaml>
   
Command Line Arguments
----------------------

.. code-block:: console

   > python -m VHDLTest [options]
   
Options
~~~~~~~

.. option:: -c --config your-config.yaml

   Specify the YAML configuration file.

.. option:: -l --log your-log-file

   Specify a log file to create.

.. option:: -j --junit your-junit.xml

   Specify a JUnit report file to create.
   
.. option:: -t --tests test1 test2 test3

   Specify the test-benches to run (overrides configuration file).

.. option:: -s --simulator simulator_name

   Specify the simulator to use. Options are:
    - ActiveHDL
    - GHDL
   
.. option:: -v --verbose

   Produce verbose output from simulator.

.. option:: --exit-0

   Exit with code 0 even if tests fail. A non-zero error code will still be
   generated for compile or simulation errors.

.. option:: --version

   Print the version information.

Environment Variables
---------------------

VHDLTest will look for simulators in the path environment variable. It also
supports explicitly setting the simulator paths using environment variables:

- VHDLTEST_ACTIVEHDL_PATH=<path-to-bin>
- VHDLTEST_GHDL_PATH=<path-to-bin>