.. _api_cli:

shakenbreak.cli module
===========================

.. _cli_commands:

Commands
--------------

``ShakeNBreak`` has eight main commands: ``snb-generate``, ``snb-generate_all``, ``snb-run``,
``snb-parse``, ``snb-analyse``, ``snb-plot``, ``snb-regenerate``, ``snb-groundstate`` and ``snb-mag``.
Their functionality and options are described below.

See the `Structure generation <https://shakenbreak.readthedocs.io/en/latest/Generation.html>`_ and
`Analysis & plotting <https://shakenbreak.readthedocs.io/en/latest/Analysis.html>`_ Tutorials pages for an overview of
their usage.


.. click:: shakenbreak.cli:snb
   :prog: snb
   :nested: full