================================================================================
Command line reference
================================================================================

.. literalinclude:: /generated/yosys
    :start-at: Usage

.. _cmd_ref:

Command reference
-----------------

.. todo:: Can we warn on command groups that aren't included anywhere?

.. toctree::
   :maxdepth: 2

   /appendix/env_vars
   /cmd/index_frontends
   /cmd/index_backends
   /cmd/index_kernel
   /cmd/index_formal

.. toctree::
   :maxdepth: 3

   /cmd/index_passes
   /cmd/index_techlibs

.. TODO:: Fix index_internal not being included in pdf

.. note::

   Commands intended for internal developer use can also be found under
   :doc:`/cmd/index_internal`