chargelink batch
================

Run a folder of inputs and continue or retry a batch later.

Reference syntax
----------------
.. code-block:: text

   usage: chargelink batch [-h] {run,resume,retry-failed} ...

   positional arguments:
     {run,resume,retry-failed}

   options:
     -h, --help            show this help message and exit

Subcommands
-----------
.. list-table::
   :header-rows: 1
   :widths: 25 75

   * - Subcommand
     - Purpose
   * - ``run``
     - Run a folder of inputs as a named batch.
   * - ``resume``
     - Resume a named batch run.
   * - ``retry-failed``
     - Retry failed items in a batch.

run
---

Run a folder of inputs as a named batch.

CLI help
~~~~~~~~
.. code-block:: text

   usage: chargelink batch run [-h] [--runtime-root RUNTIME_ROOT]
                               [--run-id RUN_ID]
                               folder

   positional arguments:
     folder

   options:
     -h, --help            show this help message and exit
     --runtime-root RUNTIME_ROOT
     --run-id RUN_ID

Production examples
~~~~~~~~~~~~~~~~~~~
**Run a folder of input JSON files as one batch.**

.. code-block:: bash

   chargelink batch run 'batch_inputs' --runtime-root '.tmp/runtime' --run-id 'batch_a'

**Run a second folder as a release smoke batch.**

.. code-block:: bash

   chargelink batch run 'artifacts/release_batch_inputs' --runtime-root '.tmp/runtime' --run-id 'release_batch'


resume
------

Resume a named batch run.

CLI help
~~~~~~~~
.. code-block:: text

   usage: chargelink batch resume [-h] [--runtime-root RUNTIME_ROOT] run_id

   positional arguments:
     run_id

   options:
     -h, --help            show this help message and exit
     --runtime-root RUNTIME_ROOT

Production examples
~~~~~~~~~~~~~~~~~~~
**Resume a named batch.**

.. code-block:: bash

   chargelink batch resume 'batch_a' --runtime-root '.tmp/runtime'

**Resume a release batch.**

.. code-block:: bash

   chargelink batch resume 'release_batch' --runtime-root '.tmp/runtime'


retry-failed
------------

Retry failed items in a batch.

CLI help
~~~~~~~~
.. code-block:: text

   usage: chargelink batch retry-failed [-h] [--runtime-root RUNTIME_ROOT] run_id

   positional arguments:
     run_id

   options:
     -h, --help            show this help message and exit
     --runtime-root RUNTIME_ROOT

Production examples
~~~~~~~~~~~~~~~~~~~
**Retry failed items in a named batch.**

.. code-block:: bash

   chargelink batch retry-failed 'batch_a' --runtime-root '.tmp/runtime'

**Retry failed items in a release batch.**

.. code-block:: bash

   chargelink batch retry-failed 'release_batch' --runtime-root '.tmp/runtime'