Skip to content

k3vndev/img-compress

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🖼️ IMG Compress

A simple CLI tool to compress images directly from your terminal. Just open a terminal in your image folder, type imgc, and save some space.

Showcase of the tool in action, compressing a folder of images with the CLI interface


🚀 Installation

  1. Clone the repository

    git clone https://github.com/k3vndev/img-compress
    cd img-compress
  2. Install dependencies (Make sure you have UV installed)

    uv sync
  3. Install the tool globally This makes the imgc command available from anywhere:

    pip install .

💡 Usage

Navigate to the folder where your images are located and run:

imgc

This will compress all the valid images in that folder with default settings to a new folder ./imgc_output.

🧩 Arguments

Argument Description Example
filter-formats Compress only from specific image formats filter-formats:png,jpg
format Set the format to compress to format:webp
name Set the output name or name sequence name:vacations-[i]
quality Set the compressed images quality quality:40

🧹 Uninstall

If you ever want to remove it:

pip uninstall img-compress

About

A simple CLI tool to compress images directly from your terminal. Just open a terminal in your image folder, type imgc, and save some space.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages