CLI Reference ============= For users migrating old CLI scripts to python. CLI Operators to Wand Methods ----------------------------- This table maps ImageMagick's CLI operators to Wand's :class:`~wand.image.Image` methods. +-------------------------------------+----------------------------------------------------------+ | CLI Operators | Wand Methods | +=====================================+==========================================================+ | :cli:`adaptive-blur` | :meth:`wand.image.BaseImage.adaptive_blur()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`adaptive-resize` | :meth:`wand.image.BaseImage.adaptive_resize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`adaptive-sharpen` | :meth:`wand.image.BaseImage.adaptive_sharpen()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`annotate` | :meth:`wand.image.BaseImage.annotate()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`append` | :meth:`wand.image.BaseImage.concat()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`auto-gamma` | :meth:`wand.image.BaseImage.auto_gamma()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`auto-level` | :meth:`wand.image.BaseImage.auto_level()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`auto-orient` | :meth:`wand.image.BaseImage.auto_orient()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`auto-threshold` | :meth:`wand.image.BaseImage.auto_threshold()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`black-threshold` | :meth:`wand.image.BaseImage.black_threshold()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`blue-shift` | :meth:`wand.image.BaseImage.blue_shift()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`blur` | :meth:`wand.image.BaseImage.blur()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`border` | :meth:`wand.image.BaseImage.border()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`brightness-contrast` | :meth:`wand.image.BaseImage.brightness_contrast()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`canny` | :meth:`wand.image.BaseImage.canny()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`caption` | :meth:`wand.image.BaseImage.caption()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`cdl` | :meth:`wand.image.BaseImage.color_decision_list()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`charcoal` | :meth:`wand.image.BaseImage.charcoal()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`chop` | :meth:`wand.image.BaseImage.chop()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`clahe` | :meth:`wand.image.BaseImage.clahe()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`clamp` | :meth:`wand.image.BaseImage.clamp()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`clut` | :meth:`wand.image.BaseImage.clut()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`coalesce` | :meth:`wand.image.BaseImage.coalesce()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`colorize` | :meth:`wand.image.BaseImage.colorize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`colormap` | :meth:`wand.image.BaseImage.color_map()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`color-matrix` | :meth:`wand.image.BaseImage.color_matrix()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`colorspace` | :meth:`wand.image.BaseImage.transform_colorspace()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`compare` | :meth:`wand.image.BaseImage.compare()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`complex` | :meth:`wand.image.BaseImage.complex()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`composite` | :meth:`wand.image.BaseImage.composite()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`connected-components` | :meth:`wand.image.BaseImage.connected_components()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`contrast` | :meth:`wand.image.BaseImage.contrast()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`contrast-stretch` | :meth:`wand.image.BaseImage.contrast_stretch()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`crop` | :meth:`wand.image.BaseImage.crop()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`cycle` | :meth:`wand.image.BaseImage.cycle_color_map()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`deconstruct` | :meth:`wand.image.BaseImage.deconstruct()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`deskew` | :meth:`wand.image.BaseImage.deskew()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`despeckle` | :meth:`wand.image.BaseImage.despeckle()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`distort` | :meth:`wand.image.BaseImage.distort()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`edge` | :meth:`wand.image.BaseImage.edge()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`emboss` | :meth:`wand.image.BaseImage.emboss()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`enhance` | :meth:`wand.image.BaseImage.enhance()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`equalize` | :meth:`wand.image.BaseImage.equalize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`evaluate` | :meth:`wand.image.BaseImage.evaluate()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`extent` | :meth:`wand.image.BaseImage.extent()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`features` | :meth:`wand.image.BaseImage.features()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`fft` | :meth:`wand.image.BaseImage.forward_fourier_transform()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`flip` | :meth:`wand.image.BaseImage.flip()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`flop` | :meth:`wand.image.BaseImage.flop()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`frame` | :meth:`wand.image.BaseImage.frame()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`function` | :meth:`wand.image.BaseImage.function()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`fx` | :meth:`wand.image.BaseImage.fx()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`gamma` | :meth:`wand.image.BaseImage.gamma()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`gaussian-blur` | :meth:`wand.image.BaseImage.gaussian_blur()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`hald-clut` | :meth:`wand.image.BaseImage.hald_clut()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`hough-lines` | :meth:`wand.image.BaseImage.hough_lines()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`ift` | :meth:`wand.image.BaseImage.inverse_fourier_transform()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`implode` | :meth:`wand.image.BaseImage.implode()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`kuwahara` | :meth:`wand.image.BaseImage.kuwahara()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`lat` | :meth:`wand.image.BaseImage.adaptive_threshold()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`level` | :meth:`wand.image.BaseImage.level()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`+level ` | :meth:`wand.image.BaseImage.levelize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`level-colors` | :meth:`wand.image.BaseImage.level_colors()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`+level-colors ` | :meth:`wand.image.BaseImage.levelize_colors()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`linear-stretch` | :meth:`wand.image.BaseImage.linear_stretch()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`liquid-rescale` | :meth:`wand.image.BaseImage.liquid_rescale()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`magnify` | :meth:`wand.image.BaseImage.magnify()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`mean-shift` | :meth:`wand.image.BaseImage.mean_shift()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`layers` | :meth:`wand.image.BaseImage.merge_layers()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`layers` | :meth:`wand.image.Image.compare_layers()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`layers` | :meth:`wand.image.BaseImage.optimize_layers()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`layers` | :meth:`wand.image.BaseImage.optimize_transparency()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`mode` | :meth:`wand.image.BaseImage.mode()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`modulate` | :meth:`wand.image.BaseImage.modulate()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`morphology` | :meth:`wand.image.BaseImage.morphology()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`motion-blur` | :meth:`wand.image.BaseImage.motion_blur()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`negate` | :meth:`wand.image.BaseImage.negate()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`noise` | :meth:`wand.image.BaseImage.noise()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`normalize` | :meth:`wand.image.BaseImage.normalize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`paint` | :meth:`wand.image.BaseImage.oil_paint()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`opaque` | :meth:`wand.image.BaseImage.opaque_paint()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`ordered-dither` | :meth:`wand.image.BaseImage.ordered_dither()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`polaroid` | :meth:`wand.image.BaseImage.polaroid()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`polynomial` | :meth:`wand.image.BaseImage.polynomial()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`posterize` | :meth:`wand.image.BaseImage.posterize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`quantize` | :meth:`wand.image.BaseImage.quantize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`random-threshold` | :meth:`wand.image.BaseImage.random_threshold()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`range-threshold` | :meth:`wand.image.BaseImage.range_threshold()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`read-mask` | :meth:`wand.image.BaseImage.read_mask()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`remap` | :meth:`wand.image.BaseImage.remap()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`resample` | :meth:`wand.image.BaseImage.resample()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`+repage ` | :meth:`wand.image.BaseImage.reset_coords()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`resize` | :meth:`wand.image.BaseImage.resize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`rotate` | :meth:`wand.image.BaseImage.rotate()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`radial_blur` | :meth:`wand.image.BaseImage.rotational_blur()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`sample` | :meth:`wand.image.BaseImage.sample()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`scale` | :meth:`wand.image.BaseImage.scale()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`selective-blur` | :meth:`wand.image.BaseImage.selective_blur()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`sepia-tone` | :meth:`wand.image.BaseImage.sepia_tone()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`shade` | :meth:`wand.image.BaseImage.shade()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`shadow` | :meth:`wand.image.BaseImage.shadow()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`sharpen` | :meth:`wand.image.BaseImage.sharpen()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`shave` | :meth:`wand.image.BaseImage.shave()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`shear` | :meth:`wand.image.BaseImage.shear()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`sigmoidal-contrast` | :meth:`wand.image.BaseImage.sigmoidal_contrast()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`similarity-threshold` | See :meth:`wand.image.BaseImage.similarity()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`subimage-search` | See :meth:`wand.image.BaseImage.similarity()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`sketch` | :meth:`wand.image.BaseImage.sketch()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`smush` | :meth:`wand.image.BaseImage.smush()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`solarize` | :meth:`wand.image.BaseImage.solarize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`sparse-color` | :meth:`wand.image.BaseImage.sparse_color()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`splice` | :meth:`wand.image.BaseImage.splice()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`spread` | :meth:`wand.image.BaseImage.spread()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`stegano` | :meth:`wand.image.BaseImage.stegano()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`stereo` | :meth:`wand.image.Image.stereogram()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`statistic` | :meth:`wand.image.BaseImage.statistic()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`strip` | :meth:`wand.image.BaseImage.strip()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`swirl` | :meth:`wand.image.BaseImage.swirl()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`texture` | :meth:`wand.image.BaseImage.texture()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`threshold` | :meth:`wand.image.BaseImage.threshold()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`thumbnail` | :meth:`wand.image.BaseImage.thumbnail()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`tint` | :meth:`wand.image.BaseImage.tint()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`transform` | :meth:`wand.image.BaseImage.transform()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`transparent-color` | :meth:`wand.image.BaseImage.transparent_color()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`transpose` | :meth:`wand.image.BaseImage.transpose()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`transverse` | :meth:`wand.image.BaseImage.transverse()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`treedepth` | See :meth:`wand.image.BaseImage.quantize()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`trim` | :meth:`wand.image.BaseImage.trim()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`unique-colors` | :meth:`wand.image.BaseImage.unique_colors()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`unsharp-mask` | :meth:`wand.image.BaseImage.unsharp_mask()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`vignette` | :meth:`wand.image.BaseImage.vignette()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`watermark` | :meth:`wand.image.BaseImage.watermark()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`wave` | :meth:`wand.image.BaseImage.wave()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`wavelet-denoise` | :meth:`wand.image.BaseImage.wavelet_denoise()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`white-threshold` | :meth:`wand.image.BaseImage.white_threshold()` | +-------------------------------------+----------------------------------------------------------+ | :cli:`write-mask` | :meth:`wand.image.BaseImage.write_mask()` | +-------------------------------------+----------------------------------------------------------+ CLI Options to Wand Properties ------------------------------ This table list ImageMagick's options, and maps them to Wand's :class:`~wand.image.Image` properties. +----------------------+--------------------------------------------------+ | CLI Options | Wand Properties | +======================+==================================================+ | :cli:`alpha` | :attr:`wand.image.BaseImage.alpha_channel` | +----------------------+--------------------------------------------------+ | :cli:`antialias` | :attr:`wand.image.BaseImage.font_antialias` | +----------------------+--------------------------------------------------+ | :cli:`antialias` | :attr:`wand.image.BaseImage.antialias` | +----------------------+--------------------------------------------------+ | :cli:`attenuate` | See :meth:`wand.image.BaseImage.noise()` | +----------------------+--------------------------------------------------+ | :cli:`background` | :attr:`wand.image.BaseImage.background_color` | +----------------------+--------------------------------------------------+ | :cli:`blue-primary` | :attr:`wand.image.BaseImage.blue_primary` | +----------------------+--------------------------------------------------+ | :cli:`bordercolor` | :attr:`wand.image.BaseImage.border_color` | +----------------------+--------------------------------------------------+ | :cli:`colorspace` | :attr:`wand.image.BaseImage.colorspace` | +----------------------+--------------------------------------------------+ | :cli:`compose` | :attr:`wand.image.BaseImage.compose` | +----------------------+--------------------------------------------------+ | :cli:`compression` | :attr:`wand.image.BaseImage.compression` | +----------------------+--------------------------------------------------+ | :cli:`delay` | :attr:`wand.image.BaseImage.ticks_per_second` | +----------------------+--------------------------------------------------+ | :cli:`delay` | :attr:`wand.sequence.SingleImage.delay` | +----------------------+--------------------------------------------------+ | :cli:`density` | :attr:`wand.image.BaseImage.resolution` | +----------------------+--------------------------------------------------+ | :cli:`depth` | :attr:`wand.image.BaseImage.depth` | +----------------------+--------------------------------------------------+ | :cli:`dispose` | :attr:`wand.image.BaseImage.dispose` | +----------------------+--------------------------------------------------+ | :cli:`fill` | :attr:`wand.image.BaseImage.font_color` | +----------------------+--------------------------------------------------+ | :cli:`font` | :attr:`wand.image.BaseImage.font` | +----------------------+--------------------------------------------------+ | :cli:`format` | :attr:`wand.image.BaseImage.format` | +----------------------+--------------------------------------------------+ | :cli:`fuzz` | :attr:`wand.image.BaseImage.fuzz` | +----------------------+--------------------------------------------------+ | :cli:`gravity` | :attr:`wand.image.BaseImage.gravity` | +----------------------+--------------------------------------------------+ | :cli:`green-primary` | :attr:`wand.image.BaseImage.green_primary` | +----------------------+--------------------------------------------------+ | :cli:`intent` | :attr:`wand.image.BaseImage.rendering_intent` | +----------------------+--------------------------------------------------+ | :cli:`interlace` | :attr:`wand.image.BaseImage.interlace_scheme` | +----------------------+--------------------------------------------------+ | :cli:`interpolate` | :attr:`wand.image.BaseImage.interpolate_method` | +----------------------+--------------------------------------------------+ | :cli:`loop` | :attr:`wand.image.BaseImage.loop` | +----------------------+--------------------------------------------------+ | :cli:`mattecolor` | :attr:`wand.image.BaseImage.matte_color` | +----------------------+--------------------------------------------------+ | :cli:`orientation` | :attr:`wand.image.BaseImage.orientation` | +----------------------+--------------------------------------------------+ | :cli:`page` | :attr:`wand.image.BaseImage.page` | +----------------------+--------------------------------------------------+ | :cli:`page` | :attr:`wand.image.BaseImage.page_height` | +----------------------+--------------------------------------------------+ | :cli:`page` | :attr:`wand.image.BaseImage.page_width` | +----------------------+--------------------------------------------------+ | :cli:`page` | :attr:`wand.image.BaseImage.page_x` | +----------------------+--------------------------------------------------+ | :cli:`page` | :attr:`wand.image.BaseImage.page_y` | +----------------------+--------------------------------------------------+ | :cli:`pointsize` | :attr:`wand.image.BaseImage.font_size` | +----------------------+--------------------------------------------------+ | :cli:`quality` | :attr:`wand.image.BaseImage.compression_quality` | +----------------------+--------------------------------------------------+ | :cli:`red-primary` | :attr:`wand.image.BaseImage.red_primary` | +----------------------+--------------------------------------------------+ | :cli:`scene` | :attr:`wand.image.BaseImage.scene` | +----------------------+--------------------------------------------------+ | :cli:`seed` | :attr:`wand.image.BaseImage.seed` | +----------------------+--------------------------------------------------+ | :cli:`size` | :attr:`wand.image.BaseImage.height` | +----------------------+--------------------------------------------------+ | :cli:`size` | :attr:`wand.image.BaseImage.width` | +----------------------+--------------------------------------------------+ | :cli:`size` | :attr:`wand.image.BaseImage.size` | +----------------------+--------------------------------------------------+ | :cli:`stroke` | :attr:`wand.image.BaseImage.stroke_color` | +----------------------+--------------------------------------------------+ | :cli:`strokewidth` | :attr:`wand.image.BaseImage.stroke_width` | +----------------------+--------------------------------------------------+ | :cli:`treedepth` | See :meth:`wand.image.BaseImage.quantize()` | +----------------------+--------------------------------------------------+ | :cli:`type` | :attr:`wand.image.BaseImage.type` | +----------------------+--------------------------------------------------+ | :cli:`units` | :attr:`wand.image.BaseImage.units` | +----------------------+--------------------------------------------------+ | :cli:`virtual-pixel` | :attr:`wand.image.BaseImage.virtual_pixel` | +----------------------+--------------------------------------------------+ | :cli:`white-point` | :attr:`wand.image.BaseImage.white_point` | +----------------------+--------------------------------------------------+