diff --git a/README.md b/README.md index 117ce8e..bad94a5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,17 @@ Keep your Docker environment tidy, automated, and efficient πŸš€ --- +## βš™οΈ Features + +- Detects all anonymous Docker volumes (64-character hashes) +- Skips whitelisted volumes +- Skips bootstrap mounts (`/var/www/bootstrap`) +- Cleans up symlinks **and** their target directories +- Optional confirmation prompt via `--no-confirmation` +- Pure Python β€” **no dependencies** + +--- + ## πŸ“¦ Installation Install it using [Kevin’s Package Manager](https://github.com/kevinveenbirkenbach/package-manager) with the alias: @@ -19,14 +30,26 @@ pkgmgr install dockreap --- -## βš™οΈ Features +## πŸ§ͺ How to Use -- Detects all anonymous Docker volumes (64-character hashes) -- Skips whitelisted volumes -- Skips bootstrap mounts (`/var/www/bootstrap`) -- Cleans up symlinks **and** their target directories -- Optional confirmation prompt via `--no-confirmation` -- Pure Python β€” **no dependencies** +```bash +# Basic usage with confirmation prompt +dockreap + +# Skip confirmation +dockreap --no-confirmation + +# Skip specific volumes by adding them to the whitelist +dockreap "volumeid1 volumeid2" + +# Skip confirmation + whitelist +dockreap "volumeid1 volumeid2" --no-confirmation +``` + +πŸ“ Notes: +- Only volumes with 64-character hash names (anonymous volumes) are considered. +- Volumes mounted at `/var/www/bootstrap` are automatically excluded. +- If a volume directory is a **symlink**, both the symlink and its target are removed. --- diff --git a/main.py b/main.py old mode 100644 new mode 100755