Commit 3eb6894a authored by nimrod's avatar nimrod
Browse files

Update README.

- Update the usage section.
- Add an explanation.
parent 9aa0c402
Loading
Loading
Loading
Loading
+23 −4
Original line number Diff line number Diff line
@@ -7,15 +7,34 @@ Deep clean

Clean old versions of Docker images.

Explanation
-----------

Remove old versions of images with same name. In cases where you updated an
image (from example from :code:`postgres:13` to :code:`postgres:14`) the old
image is present. Using :code:`docker image prune` won't help in this case
since the image is still properly tagged.

Usage
-----

.. code:: shell

   usage: deepclean [-h]
    usage: deepclean [-h] [-i INCLUDE] [-e EXCLUDE] [-v] [-V] [-d]

    Clean old versions of Docker images.
   optional arguments:

    options:
      -h, --help            show this help message and exit
      -i INCLUDE, --include INCLUDE
                            Regular expression of images to exclusively prune.
      -e EXCLUDE, --exclude EXCLUDE
                            Regular expression of images to ignore.
      -v, --verbose         Verbose output
      -V, --version         show program's version number and exit
      -d, --dry-run         Dry-run, don't delete

    Regular Docker environment variables (like DOCKER_HOST) can be used.-i and -e can be used multiple times.

License
-------