update README.md

This commit is contained in:
DataHearth 2022-02-17 22:17:13 +01:00
parent d229e467e5
commit 8d253da429
No known key found for this signature in database
GPG Key ID: E88FD356ACC5F3C4
1 changed files with 12 additions and 8 deletions

View File

@ -9,7 +9,7 @@ By default (it will change in the futur), `clear-docker-images` will select imag
### Docker container
```bash
docker run --name clear-docker-image -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/datahearth/clear-docker-image <OPTIONS>
docker run --name clear-docker-image -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/datahearth/clear-docker-images <OPTIONS>
```
### Binary
@ -19,7 +19,7 @@ mkdir -p $HOME/.local/bin
export PATH=$PATH:$HOME/.local/bin
# Available distribution: linux | darwin
wget -o $HOME/.local/bin/clear-docker-images ~/. https://github.com/DataHearth/clear-docker-images/releases/download/v0.2.0/x86_x64-<DISTRIBUTION>-clear-docker-images
wget -o $HOME/.local/bin/clear-docker-images ~/. https://github.com/DataHearth/clear-docker-images/releases/download/<VERSION>/x86_x64-<DISTRIBUTION>-clear-docker-images
clear-docker-images <OPTIONS>
```
@ -36,9 +36,13 @@ clear-docker-images <OPTIONS>
## Flags
`--dry-run` : image cleanup will not be triggered
`--force` : should docker force image removal (it may create orphan images)
`-h, --help` : Print help information
`-r, --repository <REPOSITORY>` : filter by repository name
`-t, --tags <TAGS>` : add tags exclusion
`-V, --version` : Print version information
```bash
-d, --date <DATE> filter by repository name (ISO 8601) [default: $NOW - 2 days]
--dry-run image cleanup will not be triggered
--force should docker force image removal (it may create orphan images)
-h, --help Print help information
-r, --repository <REPOSITORY> filter by repository name
-t, --tags <TAGS> add tags exclusion Example: -t 1.1.0 -t release
-v, --verbose add more logs
-V, --version Print version information
```