.. _CLI_Documentation:

CLI Documentation
=================

Overview
--------

This page contains the complete documentation for the Attribution Analysis command-line interface
(CLI), including all available commands, options, and usage examples.

Usage
-----

Below is the entry point for the CLI. Run ``kaxanuk.attribution_analysis --help`` to see all
commands, or ``kaxanuk.attribution_analysis <command> --help`` for details on a specific command.

.. click:: kaxanuk.attribution_analysis.services.cli:cli
   :prog: kaxanuk.attribution_analysis
   :show-nested:

Commands
--------

init
~~~~

Creates all files and folders required by the specified configuration format.

Arguments:

- ``CONFIG_FORMAT`` (required, choices: ``excel``): The configuration format to initialize.

Options:

- ``--entry_script <name>.py``: Name of the entry script to generate. Defaults to ``__main__.py``.

run
~~~

Runs the system. If no arguments are provided, it looks for ``__main__.py`` in the current
directory; otherwise, each argument must be a path to an entry script (or a directory containing
``__main__.py``).

Arguments:

- ``ENTRY_SCRIPT_LOCATIONS`` (0 or more): Path(s) to entry script file(s) or directories.

autorun
~~~~~~~

Installs required files and directories for the Excel entry script if missing; otherwise runs the
system.

update
~~~~~~

Updates configuration files for the specified format.

Arguments:

- ``CONFIG_FORMAT`` (required, choices: ``excel``, ``entry_script``): The configuration format to
  update.

Examples
--------

Initialize a new Excel configuration:

.. code-block:: console

   $ kaxanuk.attribution_analysis init excel
   Created directory Config
   Created directory Output
   Created directory Input
   Installed all files successfully

Run the system using the default entry script:

.. code-block:: console

   $ kaxanuk.attribution_analysis run

Update only the entry script to the latest template:

.. code-block:: console

   $ kaxanuk.attribution_analysis update entry_script
   Updated entry script

Install or run the Excel entry script (if ``__main__.py`` is missing, it will install; otherwise
run):

.. code-block:: console

   $ kaxanuk.attribution_analysis autorun