Command Line Options
====================

The CLI supports various parameters to customize report generation, formatting, delivery, and behavior across CI or local workflows.

Overview
--------
.. list-table:: CLI Options
   :header-rows: 1
   :widths: 20 40 15 40

   * - **Option**
     - **Description**
     - **Default**
     - **Use Case**
   * - ``--json-report``
     - Name of the JSON report file generated alongside the HTML report
     - ``final_report.json``
     - Use in CI to parse/export test metadata
   * - ``--capture-screenshots``
     - When to capture screenshots
     - ``failed``
     - Useful in flaky UI tests to get screenshots on failure
   * - ``--html-output``
     - Directory for HTML output
     - ``report_output``
     - Customize output directory per CI job
   * - ``--plus-profile``
     - Load a named profile from ``pyproject.toml``
     - ``None``
     - Reuse a standard reporting configuration across local runs and CI
   * - ``--plus-email``
     - Send HTML report via email
     - ``False``
     - Enable in scheduled test runs (nightly builds)
   * - ``--should-open-report``
     - Auto-open report after run
     - ``failed``
     - Open only when failures occur locally
   * - ``--generate-xml``
     - Generate a combined XML for CI/coverage
     - ``False``
     - Integrate with CI tools expecting JUnit XML
   * - ``--xml-report``
     - Path for XML report
     - ``None``
     - Useful when generating multiple output types
   * - ``--env`` or ``--environment`` or ``--rp-env`
     - Include environment variables in the execution metadata.
     - Default: None
     - Useful for adding CI or custom environment metadata (safe values only).
   * - ``--git-branch``
     - Branch name to display in the report.
     - Default: "NA"
     - Useful when running tests manually or when CI does not provide branch information.
   * - ``--git-commit``
     - Commit SHA to display in the report.
     - Default: "NA"
     - Useful for ensuring traceability when CI does not set commit environment variables.




Detailed Option Usage
---------------------

For detailed information, examples, and best practices for each parameter, see:

.. toctree::
   :maxdepth: 1
   :caption: CLI Flags Explained

   cli/json-report
   cli/capture-screenshots
   cli/html-output
   cli/send-email
   cli/should-open-report
   cli/generate-xml
   cli/xml-report