From 6195b712ac09be798ac79b5fa51ef9236e4cd2fa Mon Sep 17 00:00:00 2001 From: mag37 Date: Thu, 19 Jan 2023 12:16:49 +0100 Subject: [PATCH] Update README.md Added new example with flags and optional filter. --- README.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a1a7789..c4493bb 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,23 @@ ___ ## Dependencies: Running docker (duh) and compose, either standalone or plugin. -`regctl` by [regclient](https://github.com/regclient/regclient) +`regctl` by [regclient](https://github.com/regclient/regclient) +The script will ask to download `regctl` if it's not in PATH or current directory. ___ ## `dockcheck.sh` -A script to check all currently running containers if they've got updates without pulling images, list them and give the option to update. -Example: ```bash -$ ./dockcheck.sh +$ dockcheck.sh -h +Syntax: dockcheck.sh [OPTION] [optional string to filter names] + +Options: +-h Print this Help. +-a Automatic updates, without interaction. +-n No updates, only checking availability. +``` +A script to check all currently running containers if they've got updates without pulling images, list them and give the option to update. +Basic example: +```bash +$ dockcheck.sh . . . Containers with updates available: whoogle-search @@ -23,6 +33,19 @@ homer Do you want to update? y/[n] y ``` + +And with `-n No updates` and `gl` for *gl* filtering: +```bash +$ dockcheck.sh -n gl +. . . +Containers with updates available: +whoogle-search + +Containers on latest version: +glances + +No updates installed, exiting +``` Then it proceedes to run `pull` and `up -d` on every container with updates. Example-video: