Go to file
Matteo Paonessa aacb482ad8 Fix build number 2022-11-06 16:25:20 +01:00
.github/workflows Update cmake.yml 2021-10-24 12:06:58 +02:00
.idea Minor updates to docs and build files 2019-09-28 20:02:33 +02:00
src Windows build fix + libcaesium 0.9.3 2022-11-06 16:20:00 +01:00
.gitignore Windows build fix + libcaesium 0.9.3 2022-11-06 16:20:00 +01:00
CMakeLists.txt Windows build fix + libcaesium 0.9.3 2022-11-06 16:20:00 +01:00
INSTALL.md Documentation updates 2021-10-24 11:53:42 +02:00
LICENSE.md Styling improvements and license 2018-01-01 17:17:33 +01:00
README.md Fix build number 2022-11-06 16:25:20 +01:00
README.zh-CN.md Fix build number 2022-11-06 16:25:20 +01:00
install.sh Using Rust libcaesium 2021-10-23 21:49:43 +02:00

README.md

Caesium CommandLineTools

caesium-clt - v0.18.0-beta (build 20221106)
REQUIREMENTS
Included libraries

TESTED PLATFORMS
  • macOS Monterey (v12.6)
  • Ubuntu 22.04
  • Windows 10

COMPILATION

See INSTALL.md for more details.


COMMAND LINE ARGUMENTS
  • -q, --quality [value] {Required}
    Sets the quality of the image. The higher the value is, better the result will be. Note that a value of 0 will mean lossless compression, which will not modify the original image, but will compress less. Allowed range is [0. 100].
    A common value for lossy compression is 80.
  • -e, --exif
    Keeps the JPEG metadata information during compression. File size will be slightly higher.
  • -o, --output [value] {Required}
    Path to the output folder where the compressed files will be stored. Can be the same input folder, which will overwrite the original files.
  • -R, --recursive
    If the input is a folder, caesiumclt will also scan every subfolder searching for images.
    Note that this may end up building a large set of files to be compressed and should be used carefully.
  • -S, --keep-structure
    If the input is a folder, and the -R option is set, caesiumclt will compress all the files keeping the original folder structure.
  • -O, --overwrite
    Sets the overwrite policy: all will overwrite any existing file, prompt will ask each time before overwriting, bigger will overwrite bigger files only, and none will silently skip existing files.
  • -d, --dry-run
    If this option is set, no files will be compressed, but the entire process will just be simulated.
    Useful for checking if all the files will be correctly handled.
  • -Q, --quiet
    Suppress all output. Output from the libcaesium library will still be outputted.
  • -h, --help
    Displays a summary of the command line arguments, much like this one you're reading.
  • -v, --version
    Prints the current caesiumclt version.

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

CHANGELOG
  • 0.18.0-beta - Fixed Windows build + libcaesium 0.9.3
  • 0.17.0-beta - libcaesium 0.9.2
  • 0.16.0-beta - Using libcaesium Rust library
  • 0.15.2-beta - Fixed Windows -RS bug
  • 0.15.1-beta - Fixed rename bug on Windows + "Compressing..." message
  • 0.15.0-beta - Support for libcaesium 0.5.0
  • 0.14.0-beta - Added --quiet option
  • 0.13.1-beta - Bugfix
  • 0.13.0-beta - Bugfix
  • 0.12.1-beta - Bugfix
  • 0.12.0-beta - Resizing (experimental)
  • 0.11.0-beta - Fixing paths issues and dry-run option
  • 0.10.2-beta - Bugfixes & full Windows support
  • 0.10.1-beta - All features are available
  • 0.10.0-beta - Switched to cmake build system and libcaesium
  • 0.9.1-beta - Initial development stage