:py:mod:`buildtest.cli.clean`
=============================

.. py:module:: buildtest.cli.clean


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   buildtest.cli.clean.clean



.. py:function:: clean(configuration, yes)

   Entry point for ``buildtest clean`` command which will clean up directories and configuration files generated by buildtest.
   User will be prompted for series of question with (Y/N) to select response to each action which can be ignored by passing ``--yes`` option.

   :param configuration: An instance of SiteConfiguration class
   :type configuration: buildtest.config.SiteConfiguration
   :param yes: boolean to control whether user response is required before cleaning up tasks.
   :type yes: bool