This a CLI tool that searches for image files (svg, png, etc.) inside a root directory, and generates an interactive .html file that displays the icons, their paths and groups them by project name. The generated file is searchable and contains extension filters.
Running the program with no arguments, tries to find the default installation path for xampp/htdocs.
You can provide another path with the --dir argument (see argument below)
Every top level folder inside the root directory, is considered a project.
The only thing you need is the binary. You can:
- Grab the prebuilt binary from the "executable" folder (the linux binary was compiled in Ubuntu 22.04)
OR, if you have the Rust compiler installed locally you can also: cargo install --git https://github.com/subamanis/img-dumper
OR- Build yourself by cloning or downloading the repo (
cargo build --release),
And to run it:
img-dumper --optional_arg1 --optional_argN
Below there is a list with all the arguments-flags that the program accepts.
--help
No arguments or any number of existing other commands.
Overrides normal program execution and just displays an informative message on the terminal.
Ignores other arguments.
--dir
1 argument, the path (relative or absolute) to the root directory.
The path can contain whitespaces, no need to surround it with quatation marks.
Every top level directory inside the root directory, is considered a project.
--target
1 argument, the path (relative or absolute) to the directory that the generated file will be saved.
The path can contain whitespaces, no need to surround it with quatation marks.
--name
1 argument, the name of the generated file.
The name can contain whitespaces.
--basic
No arguments.
It runs the program without trying to parse special files that may not be on your pc