CLI
===

This part of the documentation covers the CLI interface and
is auto-generated by sphinx-click extension.

.. warning::

   The CLI interface differs depending on the available opt-in extensions:

   - Sphinx
   - Toml

   The documentation shown here uses all opt-in features.

.. note::

   More information about the single configuration options can be found in the
   :ref:`usage/config:Configuration` section

.. note::

   If you get an exception and the pretty output makes the exception information unreadable try
   to run rstcheck with the environment variable ``_TYPER_STANDARD_TRACEBACK`` set to ``1`` like
   ``_TYPER_STANDARD_TRACEBACK=1 rstcheck somefile.rst```.
   Read more at `typer's docs`_.


.. click:: rstcheck._cli:typer_click_object
   :prog: rstcheck
   :show-nested:

.. _typer's docs: https://typer.tiangolo.com/tutorial/exceptions/#disable-pretty-exceptions
