CLI for sharp.
CLI for sharp, a high performance Node.js image processing module.
$ npm install sharp-cli
sharp <options> [command..]Commands:sharp affine <matrix..> Perform an affine transform on an imagesharp bandbool <operator> Perform a bitwise boolean operation on all inputimage channels (bands) to produce a single channeloutput imagesharp blur [sigma] Blur the imagesharp boolean <operand> <operator> Perform a bitwise boolean operation with operandimagesharp clahe <width> <height> Perform contrast limiting adaptive histogramequalization CLAHEsharp composite [images..] Composite image(s) over the processed (resized,extracted etc.) imagesharp convolve <width> <height> <kernel..> Convolve the image with the specified kernelsharp ensureAlpha [alpha] Ensure the output image has an alpha transparencychannelsharp extend <top> <bottom> <left> <right> Extends/pads the edges of the image with the providedbackground coloursharp extract <top> <left> <width> <height> Extract a region of the imagesharp extractChannel <channel> Extract a single channel from a multi-channel imagesharp flatten [background] Merge alpha transparency channel, if any, with abackgroundsharp flip Flip the image about the vertical Y axissharp flop Flop the image about the horizontal X axissharp gamma [gamma] [gammaOut] Apply a gamma correction by reducing the encoding(darken) pre-resize then increasing the encoding(brighten) post-resizesharp greyscale Convert to 8-bit greyscale; 256 shades of grey[aliases: grayscale]sharp joinChannel <images..> Join one or more channels to the imagesharp linear [multiplier..] Apply the linear formula a × input + b to the imageto adjust image levelssharp median [size] Apply median filtersharp modulate Transforms the image using brightness, saturation,hue rotation, and lightnesssharp negate Produce the "negative" of the imagesharp normalise Enhance output image contrast by stretching itsluminance to cover the full dynamic range[aliases: normalize]sharp pipelineColourspace <colourspace> Set the pipeline colourspace[aliases: pipelineColorspace]sharp recomb <matrix..> Recomb the image with the specified matrixsharp removeAlpha Remove alpha channel, if anysharp resize [width] [height] Resize image to width, height, or width × heightsharp rotate [angle] Rotate the output imagesharp sharpen [sigma] Sharpen the imagesharp threshold [value] Any pixel value greather than or equal to thethreshold value will be set to 255, otherwise it willbe set to 0sharp tint <rgb> Tint the image using the provided chroma whilepreserving the image luminancesharp tile [size] Use tile-based deep zoom (image pyramid) outputsharp toColourspace <colourspace> Set the output colourspace [aliases: toColorspace]sharp trim [threshold] Trim pixels from all edges that contain valuessimilar to the given background color, which defaultsto that of the top-left pixelsharp unflatten Ensure the image has an alpha channel with all whitepixel values made fully transparentGlobal Options-i, --input Path to (an) image file(s) [array] [required] [default: stdin]-o, --output Directory or URI template to write the image files to[string] [required] [default: stdout]--timeout Number of seconds after which processing will be stopped [number]Input Options--animated Read all frames/pages of an animated image [boolean]--failOn Level of sensitivity to invalid images[choices: "none", "truncated", "error", "warning"] [default: warning]--density DPI for vector images [number] [default: 72]--ignoreIcc Should the embedded ICC profile, if any, be ignored[boolean] [default: false]--level Level to extract from a multi-level input (OpenSlide), zero based [number]--limitInputPixels Do not process input images where the number of pixels (width x height)exceeds this limit [number] [default: 268402689]--page Page number to start extracting from for multi-page input [number]--pages Number of pages to extract for multi-page input [number] [default: 1]--sequentialRead Use sequential rather than random access where possible[boolean] [default: false]--subifd subIFD to extract for OME-TIFF [number] [default: -1]--unlimited Remove safety features that help prevent memory exhaustion [boolean]Output Options-c, --compressionLevel zlib compression level [number] [default: 6]-f, --format Force output to a given format[choices: "avif", "gif", "heif", "jpeg", "jpg", "png", "raw", "tiff", "webp"] [default: input]-m, --metadata, --withMetadata Include all metadata (EXIF, XMP, IPTC) from the input image in theoutput image [boolean]--metadata.density Number of pixels per inch (DPI) [number]--metadata.exif Object keyed by IFD0, IFD1 etc. of key/value string pairs to writeas EXIF data [default: {}]--metadata.icc Filesystem path to output ICC profile [string] [default: sRGB]--metadata.orientation Used to update the EXIF Orientation tag [number]-p, --progressive Use progressive (interlace) scan [boolean]-q, --quality Quality [number] [default: 80]Optimization Options--adaptiveFiltering Use adaptive row filtering [boolean]--alphaQuality Quality of alpha layer [number] [default: 80]--bitdepth Reduce bitdepth to 1, 2, or 4 bit[choices: 1, 2, 4, 8] [default: 8]--chromaSubsampling Set to "4:4:4" to prevent chroma subsampling whenquality <= 90[string] [default: 4:4:4 (AVIF) / 4:2:0]--colors, --colours Maximum number of palette entries[number] [default: 256]--compression Compression options[choices: "ccittfax4", "deflate", "jpeg", "jp2k", "lzw", "none", "packbits", "webp", "zstd"][default: "jpeg"]--delay Delay(s) between animation frames [number]--dither Level of Floyd-Steinberg error diffusion[number] [default: 1.0]--effort Level of CPU effort to reduce file size[number] [default: 7 (GIF, PNG) / 4]--hbitdepth Set bitdepth to 8, 10, or 12 bit[choices: 8, 10, 12] [default: 8]--hcompression Compression format[choices: "hevc", "av1"] [default: "av1"]--interFrameMaxError Maximum inter-frame error for transparency [number]--interPaletteMaxError Maximum inter-palette error for palette reuse[number]--loop Number of animation iterations [number] [default: 0]--lossless Use lossless compression mode [boolean]--miniswhite Write 1-bit images as miniswhite [boolean]--minSize Prevent use of animation key frames to minimize filesize [boolean]--mixed Allow mixture of lossy and lossless animation frames[boolean]--mozjpeg Use mozjpeg defaults [boolean]--nearLossless Use near_lossless compression mode [boolean]--optimise, --optimize Apply optimiseScans, overshootDeringing, andtrellisQuantisation [boolean]--optimiseCoding, --optimizeCoding Optimise Huffman coding tables[boolean] [default: true]--optimiseScans, --optimizeScans Optimise progressive scans [boolean]--overshootDeringing Apply overshoot deringing [boolean]--palette Quantise to a palette-based image with alphatransparency support [boolean]--predictor Compression predictor[choices: "float", "horizontal", "none"] [default: "horizontal"]--preset Named preset for preprocessing/filtering[choices: "default", "photo", "picture", "drawing", "icon", "text"] [default: "default"]--pyramid Write an image pyramid [boolean]--quantisationTable, --quantizationTable Quantization table to use [number] [default: 0]--reuse, --reoptimise, --reoptimize Always generate new palettes (slow) [boolean]--resolutionUnit Resolution unit[choices: "cm", "inch"] [default: inch]--smartSubsample High quality chroma subsampling [boolean]--tileBackground Background colour, parsed by the color module[string] [default: rgba(255, 255, 255, 1)]--tileHeight Vertical tile size [number]--tileWidth Horizontal tile size [number]--trellisQuantisation Apply trellis quantisation [boolean]--xres Horizontal resolution [number] [default: 1.0]--yres Vertical resolution [number] [default: 1.0]Misc. Options-h, --help Show help [boolean]-v, --version Show version number [boolean]Examples:sharp -i ./input.jpg -o ./out resize 300 200 out/input.jpg will be a 300 pixels wide and200 pixels high image containing a scaled andcropped version of input.jpgsharp -i ./input.jpg -o ./out -mq90 rotate 180 -- out/input.jpg will be an upside down, 300pxresize 300 -- flatten "#ff6600" -- composite wide, alpha channel flattened onto orange./overlay.png --gravity southeast -- sharpen background, composited with overlay.png withSE gravity, sharpened, with metadata, 90%quality version of input.jpgsharp -i ./input.jpg -o ./out --metadata Include all metadata in the output imagesharp -i ./input.jpg -o ./out Set "IFD0-Copyright" in output EXIF metadata--metadata.exif.IFD0.Copyright "Wernham Hogg"sharp -i ./input.jpg -o ./out --metadata.density Set output metadata to 96 DPI96For more information on available options, please visit https://sharp.pixelplumbing.com/
--input './images/**/*.jpg'. Make sure you quote the pattern when using the CLI.{root}, {dir}, {base}, {name}, and {ext} (from Node.js path), for example: --output {dir} will overwrite original files.
┌─────────────────────┬────────────┐│ dir │ base │├──────┬ ├──────┬─────┤│ root │ │ name │ ext │" / home/user/dir / file .txt "└──────┴──────────────┴──────┴─────┘
See the Changelog for a list of changes.
The MIT License (MIT)Copyright (c) 2019 Mark van SeventerPermission is hereby granted, free of charge, to any person obtaining a copy ofthis software and associated documentation files (the "Software"), to deal inthe Software without restriction, including without limitation the rights touse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies ofthe Software, and to permit persons to whom the Software is furnished to do so,subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESSFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS ORCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHERIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR INCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.