img

cli to automatically download a collection of images or scrape them from a website

Note

successor/version 2 of PlayerG9/img

Caution

This project is in an early phase and may be unstable or some features are missing.

• img
  • Installation
  • Updating
  • Uninstall / Cleanup
  • Shell-Autocompletion
  • Help

Installation

Warning

This installation process is designed for linux. If you are under Windows you should use a WSL. If you are under macOS it should work but no guaranty. Some steps may need to be adjusted depending on your operating system.

Important

This program requires some dependencies during the installation or for running. These dependencies are installed on most linux distributions. But if a step fails this could help.

sudo apt install python3 python3-pip git bash

$ mkdir -p ~/.local/src/
$ cd ~/.local/src/
$ git clone --depth 1 https://github.com/utility-toolbox/img.git toolbox-img
$ cd toolbox-img/
$ make
$ make install
$ img --version
0.0.0

Updating

$ cd ~/.local/src/toolbox-img/
$ make uninstall  # to ensure all old files are removed in case something changed
$ git pull
$ make
$ make install
$ img --version
0.0.0

Uninstall / Cleanup

# uninstall the program
$ make uninstall
# cleanup build files
$ make clean
# cleanup/removes the repository
$ rm -rf ~/.local/src/toolbox-img/

Shell-Autocompletion

To get shell-completion you have to add the following line at the end of your ~/.bashrc.

eval "$(img --shell-complete)"

Help

Warning

Help may be outdated. Use img --help and img <cmd> --help.

usage: img [-h] [-v] {collect,merge,scrape,get} ...

cli to automatically download a collection of images or scrape them from a website

positional arguments:
  {collect,merge,scrape,get}
    collect             Collects images
    merge               Merges multiple images into one image
    scrape              Scrapes images from given URL
    get                 Similar to the `wget` program. Used to download provided images

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  --shell-complete      Generates an auto-complete shell script. Use with `eval "$(img --shell-complete)"`