:py:mod:`raesl.compile.cli`
===========================

.. py:module:: raesl.compile.cli

.. autoapi-nested-parse::

   ESL compiler Command Line Interface.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   raesl.compile.cli.run
   raesl.compile.cli.compile



.. py:function:: run(*paths: Union[str, pathlib.Path], output: Optional[Union[str, pathlib.Path]] = None, force: bool = False, files: Optional[Union[List[str], List[pathlib.Path]]] = None) -> Tuple[raesl.compile.diagnostics.DiagnosticStore, Optional[raesl.compile.ast.specification.Specification], Optional[ragraph.graph.Graph]]

   Run the compiler on ESL files.

   :param paths: Paths to resolve into ESL files. May be any number of files and
                 directories to scan.
   :param output: Optional output file (JSON) to write the graph to.
   :param force: Whether to overwrite the output file or raise an error if the file
                 already exists.
   :param files: Optional paths argument (deprecated).

   :returns: Diagnostic storage.
             Specification object (if successfully parsed).
             Instantiated graph (if successfully instantiated).


.. py:function:: compile(paths: List[str], output: Optional[str], force: bool)

   Run the ESL compiler.