Command line interface
======================

To use the CLI, three authentication parameters are required

.. code-block:: bash

  pyslurmutils <command> --url="https://<domain>:<port>" --user=... --token=...

Alternatively they can be provided as environment variables

.. code-block:: bash

  export SLURM_URL="https://<domain>:<port>"
  export SLURM_RENEWAL_URL="ssh://<domain>:<port>"   # Optional: instead of SLURM_TOKEN
  export SLURM_USER="${USER}"                        # Optional: SLURM user name
  export SLURM_TOKEN=...                             # Optional: SLURM access token
  export SLURM_API_VERSION="v0.0.41"                 # Optional: SLURM REST API version

  pyslurmutils <command>

Check token and client-server API compatibility

.. code-block:: bash

  pyslurmutils check

List all my recent jobs (e.g. monitor with a 1 second interval)

.. code-block:: bash

  pyslurmutils status -m 1

Cancel jobs

.. code-block:: bash

  pyslurmutils cancel 5942999 5943022