Go to file
Matteo Paonessa 5fe20f47de
Update README.md
2024-07-29 18:22:25 +02:00
.github Fix tag regex on build action 2024-05-18 14:38:22 +02:00
.idea Rust switch 2022-12-20 13:38:05 +01:00
src Allow conversion and keeping dates #70 2024-07-20 11:51:27 +02:00
.gitignore Rust switch 2022-12-20 13:38:05 +01:00
CHANGELOG.md Functions optimization 2022-12-28 14:58:25 +01:00
Cargo.lock Bump libcaesium 2024-07-20 17:30:47 +02:00
Cargo.toml Bump libcaesium 2024-07-20 17:30:47 +02:00
LICENSE.md Styling improvements and license 2018-01-01 17:17:33 +01:00
README.md Update README.md 2024-07-29 18:22:25 +02:00
README.zh-CN.md README update 2024-07-21 10:14:26 +02:00

README.md

Caesium CommandLineTools

caesium-clt - v0.20.0
REQUIREMENTS

TESTED PLATFORMS
  • macOS Ventura
  • Ubuntu 22.04
  • Windows 11

COMPILATION

cargo build --release


COMMAND LINE ARGUMENTS

CaesiumCLT - Command Line Tools for image compression

USAGE:
    caesiumclt [FLAGS] [OPTIONS] --output <output> --quality <quality> [FILE]...

FLAGS:
    -d, --dry-run           do not compress files but just show output paths
    -e, --exif              keeps EXIF info during compression
    -h, --help              Prints help information
        --keep-dates        keep original file date information
    -S, --keep-structure    keep the folder structure, can be used only with -R
    -Q, --quiet             suppress all output
    -R, --recursive         if input is a folder, scan subfolders too
    -V, --version           Prints version information
        --zopfli            use zopfli when optimizing PNG files (it may take a very long time to complete)

OPTIONS:
        --height <height>                  height of the output image, if width is not set will preserve aspect ratio
                                           [default: 0]
    -o, --output <output>                  output folder
        --output-format <output-format>    convert the image to the selected format (jpg, png, webp, tiff) [default:
                                           none]
    -O, --overwrite <overwrite>            overwrite policy [default: all]
    -q, --quality <quality>                sets output file quality between [0-100], 0 for optimization
        --threads <threads>                specify the number of parallel jobs (max is the number of processors
                                           available) [default: 0]
        --verbose <verbose>                select how much output you want to see, 0 is equal to -Q, --quiet [default:
                                           1]
        --width <width>                    width of the output image, if height is not set will preserve aspect ratio
                                           [default: 0]

ARGS:
    <FILE>...    Files to process

USAGE EXAMPLES

Losslessly compress image1.jpg, located in the home directory, into a folder called output

$ caesiumclt -q 0 -o ~/output/ ~/image.jpg

Compress image1.jpg, located in the home directory, into a folder called output with lossy compression and quality set to 80

$ caesiumclt -q 80 -o ~/output/ ~/image.jpg

Losslessly compress image1.jpg, located in the home directory, into a folder called output and keeps EXIF metadata

$ caesiumclt -q 0 -e -o ~/output/ ~/image.jpg

Losslessly compress Pictures folder and subfolders, located in the home directory, into a folder called output

$ caesiumclt -q 0 -R -o ~/output/ ~/Pictures

Losslessly compress Pictures folder and subfolders, located in the home directory, into a folder called output retaining the input folder structure

$ caesiumclt -q 0 -RS -o ~/output/ ~/Pictures