chargelink report
=================

Generate, archive, comment, and filter human-readable run reports.

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

   usage: chargelink report [-h] {generate,archive,comment,filter} ...

   positional arguments:
     {generate,archive,comment,filter}

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

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

   * - Subcommand
     - Purpose
   * - ``generate``
     - Generate a run report from an artifact directory.
   * - ``archive``
     - Create an archive containing the report and related artifacts.
   * - ``comment``
     - Attach an operator comment to a run.
   * - ``filter``
     - Filter a run report by verdict or other criteria.

generate
--------

Generate a run report from an artifact directory.

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

   usage: chargelink report generate [-h] [--output OUTPUT] path

   positional arguments:
     path

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

Production examples
~~~~~~~~~~~~~~~~~~~
**Generate a run report from a campaign root.**

.. code-block:: bash

   chargelink report generate 'artifacts/evcc_campaign_runs/cl_int_iso20_ac_negative_realistic' --output 'artifacts/reports/iso20_ac_negative_report.json'

**Generate a report for a conformance run.**

.. code-block:: bash

   chargelink report generate 'artifacts/evcc_campaign_runs/cl_conf_iso2_dc_pnc_seed' --output 'artifacts/reports/iso2_dc_pnc_report.json'


archive
-------

Create an archive containing the report and related artifacts.

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

   usage: chargelink report archive [-h] [--output OUTPUT] path

   positional arguments:
     path

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

Production examples
~~~~~~~~~~~~~~~~~~~
**Archive a run report and evidence bundle.**

.. code-block:: bash

   chargelink report archive 'artifacts/evcc_campaign_runs/cl_int_iso20_ac_negative_realistic' --output 'artifacts/reports/iso20_ac_negative_report.zip'

**Archive a conformance run.**

.. code-block:: bash

   chargelink report archive 'artifacts/evcc_campaign_runs/cl_conf_iso2_dc_pnc_seed' --output 'artifacts/reports/iso2_dc_pnc_report.zip'


comment
-------

Attach an operator comment to a run.

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

   usage: chargelink report comment [-h] [--author AUTHOR] path comment

   positional arguments:
     path
     comment

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

Production examples
~~~~~~~~~~~~~~~~~~~
**Attach a QA review comment.**

.. code-block:: bash

   chargelink report comment 'artifacts/evcc_campaign_runs/cl_int_iso20_ac_negative_realistic' 'looks good' --author 'qa'

**Attach a commercialization comment.**

.. code-block:: bash

   chargelink report comment 'artifacts/suites/chargelink-production-release' 'vendor proof still pending' --author 'product'


filter
------

Filter a run report by verdict or other criteria.

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

   usage: chargelink report filter [-h] --verdict VERDICT path

   positional arguments:
     path

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

Production examples
~~~~~~~~~~~~~~~~~~~
**Filter a run for passing outcomes.**

.. code-block:: bash

   chargelink report filter 'artifacts/evcc_campaign_runs/cl_int_iso20_ac_negative_realistic' --verdict 'pass'

**Filter a run for warnings.**

.. code-block:: bash

   chargelink report filter 'artifacts/evcc_campaign_runs/cl_int_iso20_ac_negative_realistic' --verdict 'warn'