Slurm command reference
=======================

pyslurmutils check
------------------

.. argparse::
    :module: pyslurmutils.apps.__main__
    :func: create_argument_parser
    :prog: pyslurmutils
    :path: check

    **Check whether we can connection and authenticate with the Slurm REST server**.

pyslurmutils status
-------------------

.. argparse::
    :module: pyslurmutils.apps.__main__
    :func: create_argument_parser
    :prog: pyslurmutils
    :path: status

    **Inspect the status of Slurm jobs**.

pyslurmutils diff
-----------------

.. argparse::
    :module: pyslurmutils.apps.__main__
    :func: create_argument_parser
    :prog: pyslurmutils
    :path: diff

    **List the differences between two jobs**.

pyslurmutils cancel
-------------------

.. argparse::
    :module: pyslurmutils.apps.__main__
    :func: create_argument_parser
    :prog: pyslurmutils
    :path: cancel

    **Cancel Slurm jobs**.

pyslurmutils submit
-------------------

.. argparse::
    :module: pyslurmutils.apps.__main__
    :func: create_argument_parser
    :prog: pyslurmutils
    :path: submit

    **Submit and inline shell script to Slurm**.

pyslurmutils version
---------------------

.. argparse::
    :module: pyslurmutils.apps.__main__
    :func: create_argument_parser
    :prog: pyslurmutils
    :path: version

    **Print the Slurm API version used based on the provided CLI arguments**.