____                   _     __        __  _                
|  _ \    ___     ___  | | __ \ \      / / (_)  _ __     ___
| | | |  / _ \   / __| | |/ /  \ \ /\ / /  | | | '_ \   / _ \
| |_| | | (_) | | (__  |   <    \ V  V /   | | | |_) | |  __/
|____/   \___/   \___| |_|\_\    \_/\_/    |_| | .__/   \___|
                                               |_|

Table of Contents

• Introduction
• Installation
• Usage
• Examples
• Configuration File
• Contributing
• License

Introduction

DockWipe is a command line tool for deleting Docker images with specific tags. It provides an interactive interface as well as file and command line configurations to manage your Docker images.

Installation

To install DockWipe, you can use npm:

npm install -g @fgilde/dockwipe

Usage

To use DockWipe, you can run it directly from the command line, providing the necessary options either directly as command line arguments, or using a configuration file.

Command Line Options:

• --file or -f: Path to the configuration file.
• --registry or -r: The Docker registry.
• --image or -i: The Docker image.
• --username or -u or --user: The username for the Docker registry.
• --password or -p or --pass: The password for the Docker registry.
• --tags or -t: The tags to delete. Use commas to separate multiple tags.

To start DockWipe, simply run the dockwipe command:

dockwipe

Examples

To delete a tag 'tag1' from an image, use:

dockwipe --registry=yourRegistry --image=yourImage --username=yourUsername --password=yourPassword --tags=tag1

Or you can use the configuration file(s):

dockwipe --files=yourConfigFile.json, second.json

Configuration File

You can specify one or more configuration files to provide the options. The file(s) should be in JSON format: If you specify more files, the options are merged. This is usefull to have public options in a file that is checked in and private options in a file that is not checked in. If the same option is provided in multiple files, the last one wins. If you didn't provide a password in the config file, you will be asked for it in the UI. Notice: If you didn't specify any file, the default files are used when available in the current directory. The default files are:

'.dockwipe', '.dockwipe.user', '.dockwipe.secret', 'dockwipe.json', 'dockwipe.secret.json', 'dockwipe.user.json' 

The config file should have the following format:

{
"registry": "docker-registry.services.yourserver.de",
"image": "path/yourimage",
"username": "username",
"password": "yourPassword",
    "defaults": {
        "registry": "docker-registry.services.yourserver.de",
        "image": "path/yourimage"
    }
}

The 'defaults' field can be used to specify default values. If the corresponding option is not provided in the command line, the default value is pre filled but can changed in the UI. If a value is provided in the command line args or the config file, it overrides the default value and no UI is showing up to specify different values.

License

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details

If you like this tool, please star it on Github and share it with your friends

If not, you can give a star anyway and let me know what I can improve to make it better for you.

Links

Github Repository | NPM Package