CLI Reference
=============

.. sphinx_argparse_cli::
    :module: data_morph.cli
    :func: generate_parser
    :prog: data-morph
    :group_title_prefix:

----


Examples
--------

1. Morph the panda shape into a star:

   .. code-block:: console

    $ data-morph --start-shape panda --target-shape star

2. Morph the panda shape into all available target shapes:

   .. code-block:: console

    $ data-morph --start-shape panda --target-shape all

3. Morph the cat, dog, and panda shapes into the circle and slant_down shapes:

   .. code-block:: console

    $ data-morph --start-shape cat dog panda --target-shape circle slant_down

4. Morph the dog shape into upward-slanting lines over 50,000 iterations with seed 1:

   .. code-block:: console

    $ data-morph --start-shape dog --target-shape slant_up --iterations 50000 --seed 1

5. Morph the cat shape into a circle, preserving summary statistics to 3 decimal places:

   .. code-block:: console

    $ data-morph --start-shape cat --target-shape circle --decimals 3

6. Morph the music shape into a bullseye, specifying the output directory:

   .. code-block:: console

    $ data-morph --start-shape music --target-shape bullseye --output-dir path/to/dir

7. Morph the sheep shape into vertical lines, slowly ramping in and out for the animation:

   .. code-block:: console

    $ data-morph --start-shape sheep --target-shape v_lines --ramp-in --ramp-out